-
Notifications
You must be signed in to change notification settings - Fork 9.1k
link from descriptions to other operations #1107
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
Comments
We've had a discussion on it in the google group, but it feels like the solution should come from the spec itself. There's an open issue - OAI/OpenAPI-Specification#239. |
Ah, yes, that would also be a nice solution but it would be sufficient if clicking on an anchor link just works in swagger. Currently it only scrolls to the correct operation when the page is opened the first time. |
Right, but the problem is that the anchor is generated and its logic can change, and since we don't officially have our own MD extensions (which would be defined in the spec), it would be difficult to implement (or rather maintain). |
Yes, you are right. If the generated anchors change a lot it will be difficult to maintain... |
I'm going to close this out as there is a mechanism for doing so with external docs in the 2.0 spec. |
@fehguy Can you please give an example of how can this be done (inline local links)? |
It would be nice if you can link to other operations from the description.
For example, if you add the description using markdown somewhere with:
It is rendered correctly but when you click on the link, the url in the url bar of the browser is updated but the documentation does not scroll to the correct location.
The text was updated successfully, but these errors were encountered: