Browse Source

Disable deep linking by default

bubble
Kyle Shockey 7 years ago
parent
commit
abfad69e93
No known key found for this signature in database GPG Key ID: DC20D559FFBC0D36
2 changed files with 4 additions and 2 deletions
  1. +3
    -1
      docs/deep-linking.md
  2. +1
    -1
      src/core/index.js

+ 3
- 1
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

👉🏼 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.
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?

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?



+ 1
- 1
src/core/index.js View File

@@ -62,7 +62,7 @@ module.exports = function SwaggerUI(opts) {
custom: {},
displayOperationId: 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.
// Instead, we can compile the first plugin ( it can be a collection of plugins ), then batch the rest.


Loading…
Cancel
Save