DeepLinking onClick does not scroll or open Operation.

[travispamaral]

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>

[shockey]

Hey @travispamaral!

Unfortunately, this is intended behavior. The deep linking feature runs once, on page load - we don't (currently) have a router that's keeping an eye on the URL hash and mediating layout state changes.

This was mostly done for compatibility with our previous version, so we'd be happy to accept a PR for this!

Switching this over to a feature enhancement ticket.

[shockey]

Quoting myself from #3963, since it's relevant here:

Currently, the deep linking feature isn't suitable for linking dynamically to operations as you are in your example - see #3958 for discussion on this. It's mostly useful as a way to share links to a particular operation to colleagues, or get back to what you were looking at when reopening a tab.

I'm going to close this, because part of implementing #3958 will involve addressing the target="_blank" - but I'd like to highlight that you filing this did help out, I hadn't thought of this particular use case 😄

[travispamaral]

@shockey got it! Thanks for the info! Is this feature in the road map?

[shockey]

@travispamaral, unfortunately I have no ETA for this 😞 we don't keep a formal roadmap at the moment

[sal-pal]

Hey guys!

I wanna take this ticket, but I'm running into a problem: I don't know where's the code responsible for expanding and scrolling to an operation in response to clicking a deeplink.

I know the expand and scroll behavior is implemented via updateResolved() in deep-link/spec-wrap-actions.js, but in which file is this function used to respond to the clicking of a deeplink?

[webron]

Thanks @srpalomino! I'm sure @shockey would love to point you in the right direction. 😄

[shockey]

Hi @srpalomino! Most of the action is here: https://github.com/swagger-api/swagger-ui/tree/master/src/core/plugins/deep-linking

The layout action wrappers listen to layout state changes and set the URL hash when it changes, and the spec action wrappers trigger the scrolling when the spec we're displaying is loaded or changes.

[sal-pal]

@shockey Thanks for the info!

Unfortunately I'm still a little bit confused. In what file/files does:

• layout action wrappers get invoked in response to a layout state change.
• spec action wrappers get invoked in response to the spec being displayed changing or loading.

I appreciate all the help!!!