From abfad69e93892c997e72e5db344ef705fd04ccf2 Mon Sep 17 00:00:00 2001 From: Kyle Shockey Date: Fri, 14 Jul 2017 16:17:41 -0700 Subject: [PATCH] Disable deep linking by default --- docs/deep-linking.md | 4 +++- src/core/index.js | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/deep-linking.md b/docs/deep-linking.md index 56cb3390..8fd45497 100644 --- a/docs/deep-linking.md +++ b/docs/deep-linking.md @@ -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? diff --git a/src/core/index.js b/src/core/index.js index f624ea34..c0ba97c8 100644 --- a/src/core/index.js +++ b/src/core/index.js @@ -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.