swagger-api / swagger-api/swagger-ui

DeepLinking onClick does not scroll or open Operation.

Open
#3,958 26 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

cat: deep linking Good first issue P2 type: enhancement version: 3.x
Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Hi there! I see that an issue #2884 deeplinking was integrated to 3.x however if I have a hyperlink with a hash to the operationID nothing happens on click. If I reload the page the UI scrolls to the open panel as expected. Is there something I am missing here? My url looks as follows and I am using the 3.0 dist repo installed via npm.

Again when clicked the URL address is updated but nothing happens until the page is refreshed manually. Any suggestions?
<a href="#/pet/deletePet">Deletes a pet</a>

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue in Swagger UI 3.0 using an in-page link such as #/pet/deletePet: clicking updates the URL but does not scroll or open the operation, while reloading does. Trace the deep-link handling from the rendered operation page and compare click-time behavior with the existing reload behavior; done means clicking the link opens and scrolls to the target operation without a manual refresh.

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
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.