KTOR-8074 Add deepLinking configuration variable to Swagger plugin (reopen from main) #4607
+55
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FredrikMeyer
force-pushed
the
main
branch
3 times, most recently
from
8e1a2a9 to
d6d2be8
Compare
osipxd
approved these changes
Jan 16, 2025
There was a problem hiding this comment.
@FredrikMeyer, thank you for your contribution 🚀
Just one minor comment.
...r-server-plugins/ktor-server-swagger/jvm/src/io/ktor/server/plugins/swagger/SwaggerConfig.kt
Outdated
Show resolved
Hide resolved
…/ktor/server/plugins/swagger/SwaggerConfig.kt Co-authored-by: Osip Fatkullin <[email protected]>
osipxd
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Subsystem
Ktor server plugin
Motivation
Customer asked at work if we could provide deeplinks to the Swagger documentation. Found that it was a setting in Javascriptt (https://swagger.io/docs/open-source-tools/swagger-ui/usage/deep-linking/) that was not exposed by the plugin.
Solution
Add a boolean variable to SwaggerConfig to enable deep linking. It defaults to false (which is also the default for SwaggerUI).