fix(deep-linking): When swagger UI is served under subpath deep link removes path #9488
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR changes the way the hash is set when deep linking is enabled.
Motivation and Context
Our application has an explicit
html > head > base
set to where the application is exposed for example<base url="https://company.com/base/" />
. This is needed to allow client side routing while keeping the ability to change the base path under which the app is served.Swagger UI is exposed under
https://company.com/base/api
, so when deep linking is enabled it would change the URL tohttps://company.com/base/#/Tag/OperationId
instead ofhttps://company.com/base/api#/Tag/OperationId
. By using thelocation.hash
API not only for resetting the hash, but also for setting it this works as expected as it only sets the hash, but leaves the rest of the URL intact.How Has This Been Tested?
I patched the swagger-ui implementation locally and verified that the behavior is as expected.
Checklist
src/
is unmodified: changes to documentation, CI, metadata, etc.)package.json
)My changes...
Documentation
Automated tests
Not sure if there would be a good way on how to test this automatically.