kyy/swagger-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

housekeeping: indicate index.html usage of deepLinking flag (via #5118)

Browse Source
This commit is contained in:
kyle
2019-01-10 16:52:47 -06:00
committed by GitHub
parent e90fe9cfd7
commit b714810bfe
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/usage/deep-linking.md
View File

@@ -4,7 +4,7 @@ Swagger-UI allows you to deeply link into tags and operations within a spec. Whe
## Usage ## Usage
👉🏼 Add `deepLinking: true` to your Swagger-UI configuration to enable this functionality. 👉🏼 Add `deepLinking: true` to your Swagger-UI configuration to enable this functionality. This is demonstrated in [`dist/index.html`](https://github.com/swagger-api/swagger-ui/blob/master/dist/index.html).
When you expand a tag or operation, Swagger-UI will automatically update its URL fragment with a deep link to the item. When you expand a tag or operation, Swagger-UI will automatically update its URL fragment with a deep link to the item.
Conversely, when you collapse a tag or operation, Swagger-UI will clear the URL fragment. Conversely, when you collapse a tag or operation, Swagger-UI will clear the URL fragment.