Skip to content
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

Broken navigation on https://spec.openapis.org/oas/{version}.html #3054

Closed
arno-di-loreto opened this issue Oct 18, 2022 · 2 comments
Closed

Comments

@arno-di-loreto
Copy link
Contributor

On https://spec.openapis.org/, for all versions of the specification, there's a conflict between user-defined anchors (<a name="infoObject"></a> in MD) which appear both in the navbar and in the main document (they are turned into <span id="infoObject"...) making quite complicated the navigation between objects when reading the specification.

To reproduce the bug:

  • Go to https://spec.openapis.org/oas/v3.1.0.html
  • Scroll to the OpenAPI object (or click on it in the navbar)
  • Click on Info Object (which targets #infoObject)
  • Instead of having the document scrolling to the Info Object section, it's the navbar that scrolls to its Info Object header (both containing a

Note that using the link with the anchor in a new tab works: the document scrolls to the right section.

@jlevers
Copy link

jlevers commented Jan 10, 2024

This issue is also present when using the markdown spec files themselves, e.g. https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/versions/3.0.2.md

Edit: sorry, I'm realizing this is a slightly different issue – the markdown files use snakeCase anchor links, but the anchors themselves are in kebab-case. I'll open a new issue.

@handrews
Copy link
Member

This is finally fixed! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants