Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix deeplinking for topbar plugin #4181

Merged

Conversation

geekingfrog
Copy link
Contributor

Enable deeplinking with the topbar plugin.

Description

Following zyv's workaround I added some logic to change the location.search property on spec change. It's a bit of a hack though.

Motivation and Context

Fixes #3649

How Has This Been Tested?

I haven't found any automated test for the topbar plugin unfortunately.
I have a branch with a modified version of the index.html used for dev where I tested it manually.

I also added a couple of tests around parsing and serialization of window.location.search.

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • [] If yes to above: I have added tests to cover my changes. [Only partly]
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

@shockey shockey self-requested a review February 3, 2018 04:59
@OisinKyne
Copy link

Hey @shockey, is this likely to be included in a future release? I could do with this fix but am avoiding forking the repository and merging/building swagger-ui myself because of the inconvenience it would cause in the long run.

Copy link
Contributor

@shockey shockey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@shockey shockey merged commit 71d7c1a into swagger-api:master Feb 27, 2018
@shockey
Copy link
Contributor

shockey commented Feb 27, 2018

thanks, @geekingfrog!

@shockey
Copy link
Contributor

shockey commented Feb 27, 2018

@OisinKyne, this will be included in the next release we do 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deep linking (deepLinking: true) incompatible with Topbar spec chooser (urls)
3 participants