question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Deep links to operations are broken when tags contain spaces and doc expansion is 'none'

See original GitHub issue

Q&A

  • OS: macOS
  • Browser: Chrome
  • Version: 3.20
  • Swagger/OpenAPI version: Swagger 2.0

Content & configuration

Use example swagger spec with spaces in the operations:

https://raw.githubusercontent.com/pablocoberly/misc/master/swagger_spaces.json

Initialise swagger bundle with docexpansion set to ‘none’

Describe the bug you’re encountering

When a swagger spec contains tags that have spaces, and doc expansion is disabled, the deep links to operations don’t work.

To reproduce…

Steps to reproduce the behavior:

  1. Use a spec that has a spaces in the tags, e.g. https://raw.githubusercontent.com/pablocoberly/misc/master/swagger_spaces.json
  2. Initialise the swagger setting:
docExpansion: 'none',
  1. Link to an operation that uses a tag with a space in it (e.g. #/Store%2520Space)
  2. The operation is not “scrolled to”.

Expected behavior

The operation should be expanded be scrolled to even if the operation has a space in it.

Additional context or thoughts

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Comments:12 (6 by maintainers)

github_iconTop GitHub Comments

1reaction
shockeycommented, Jan 10, 2019

thanks again for your efforts here @pablocoberly!

1reaction
shockeycommented, Jan 10, 2019

fixed! check my PR for details, long story short is that the component actually providing data to the tag deep links on the page wasn’t escaping things correctly.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Enabling deep linking - Unity - Manual
Expand the Supported URL schemes section and, in the Element 0 field, enter the URL scheme associated with your app (for example, unitydl...
Read more >
Springdoc-openapi Properties
Parameter name Default Value Description springdoc.swagger‑ui.oauth2RedirectUrl /swagger‑ui/oauth2‑redirect.html String . OAuth re... springdoc.swagger‑ui.oauth.clientId String . Default cl... springdoc.swagger‑ui.csrf.enabled false Boolean . To en...
Read more >
deepLinking parameter - Swagger Documentation
Swagger UI allows you to deeply link into tags and operations within a spec. ... Sure - use docExpansion: none to collapse all...
Read more >
248 CMR 10.00: Uniform State Plumbing Code - Mass.gov
Any actual or potential physical connection or arrangement between a pipe containing potable water from a public water system and any non-potable ...
Read more >
Firebase Apple SDK Release Notes - Google
Swift Package Manager only release to fix a 9.4.0 tagging issue impacting some users ... Breaking change: import Firebase will no longer implicitly...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found