Add Swagger UI deep linking configuration example #1857
Closed
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
soyuka
reviewed
Dec 18, 2023
| @@ -175,6 +175,8 @@ api_platform: | |||
| docExpansion: list | |||
| # If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. | |||
| filter: false | |||
| # If set, enables deep linking for tags and operations. The information of selected tag and operation will be appended to the URL. The Swagger UI will automatically expand a specific tag or operation and scroll to it when loaded. | |||
| deepLinking: true | |||
There was a problem hiding this comment.
this was not contributed as a symfony configuration not sure we need this in the documentation
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.
I think it's a really good feature in Swagger UI worth mentioning here. Please see https://swagger.io/docs/open-source-tools/swagger-ui/usage/deep-linking/
It is also used in the Swagger UI demo documentation. The feature allows you to link a specific operation, e.g. https://petstore.swagger.io/#/user/createUsersWithListInput