Skip to content

Commit abfad69

Browse files
committed
Disable deep linking by default
1 parent e77c980 commit abfad69

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

docs/deep-linking.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Swagger-UI allows you to deeply link into tags and operations within a spec. Whe
44

55
## Usage
66

7+
👉🏼 Add `deepLinking: true` to your Swagger-UI configuration to enable this functionality.
8+
79
When you expand a tag or operation, Swagger-UI will automatically update its URL fragment with a deep link to the item.
810
Conversely, when you collapse a tag or operation, Swagger-UI will clear the URL fragment.
911

@@ -23,7 +25,7 @@ Otherwise, Swagger-UI generates an implicit operationId by combining the operati
2325

2426
> I'm using Swagger-UI in an application that needs control of the URL fragment. How do I disable deep-linking?
2527
26-
Pass `deepLinking: false` into Swagger-UI as a configuration item.
28+
This functionality is disabled by default, but you can pass `deepLinking: false` into Swagger-UI as a configuration item to be sure.
2729

2830
> Can I link to multiple tags or operations?
2931

src/core/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ module.exports = function SwaggerUI(opts) {
6262
custom: {},
6363
displayOperationId: false,
6464
displayRequestDuration: false,
65-
deepLinking: true,
65+
deepLinking: false,
6666

6767
// Initial set of plugins ( TODO rename this, or refactor - we don't need presets _and_ plugins. Its just there for performance.
6868
// Instead, we can compile the first plugin ( it can be a collection of plugins ), then batch the rest.

0 commit comments

Comments
 (0)