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

Disable deep linking by default

Browse Source
This commit is contained in:
Kyle Shockey
2017-07-14 16:17:41 -07:00
parent e77c980ae8
commit abfad69e93
2 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/deep-linking.md
View File

@@ -4,6 +4,8 @@ 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.
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.
@@ -23,7 +25,7 @@ Otherwise, Swagger-UI generates an implicit operationId by combining the operati
> I'm using Swagger-UI in an application that needs control of the URL fragment. How do I disable deep-linking? > I'm using Swagger-UI in an application that needs control of the URL fragment. How do I disable deep-linking?
Pass `deepLinking: false` into Swagger-UI as a configuration item. This functionality is disabled by default, but you can pass `deepLinking: false` into Swagger-UI as a configuration item to be sure.
> Can I link to multiple tags or operations? > Can I link to multiple tags or operations?

2
src/core/index.js
View File

@@ -62,7 +62,7 @@ module.exports = function SwaggerUI(opts) {
custom: {}, custom: {},
displayOperationId: false, displayOperationId: false,
displayRequestDuration: false, displayRequestDuration: false,
deepLinking: true, deepLinking: false,
// Initial set of plugins ( TODO rename this, or refactor - we don't need presets _and_ plugins. Its just there for performance. // Initial set of plugins ( TODO rename this, or refactor - we don't need presets _and_ plugins. Its just there for performance.
// Instead, we can compile the first plugin ( it can be a collection of plugins ), then batch the rest. // Instead, we can compile the first plugin ( it can be a collection of plugins ), then batch the rest.