swagger-api / swagger-api/swagger-ui
External links to swagger-ui anchors don't work
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Describe the bug you're encountering
When loading the Swagger UI site from an external link that includes an anchor, such as #model-Category, the router modifies the URL to separate out the hash from the anchor name: /#/model-Category; This breaks the anchor link. If you then fix the URL in the address bar and press enter, it works. So, the anchor reference works from within the page, but not from external sites.
Link to issue on demo site: https://petstore.swagger.io/#model-Category
Expected behavior
Page loads and scrolls to the section that was linked to.
Actual behavior
Page modifies the url before loading and load the top of the page.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the issue using the Swagger UI demo URL with the external anchor https://petstore.swagger.io/#model-Category. Start by tracing the router's handling of the initial URL hash; done means the page preserves the anchor and scrolls to the linked section when loaded from an external site.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend, web-dev
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100