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

Navigation broken when headers share the same name #1929

Closed
cpene1 opened this issue Mar 14, 2022 · 1 comment
Closed

Navigation broken when headers share the same name #1929

cpene1 opened this issue Mar 14, 2022 · 1 comment
Assignees

Comments

@cpene1
Copy link

cpene1 commented Mar 14, 2022

Describe the bug
The left-panel navigation is broken if we include headers with the same name in different tags.

Expected behavior
The header hyperlinks should point to 2 different id's, even if they share the same name.

Minimal reproducible OpenAPI snippet(if possible)

tags:
- name: "Tag"
  description: |-
    ## Description
    
    I always get here, even if I press on the Description of "Other Tag" or "Other Tag 2".
- name: "Other Tag"
  description: |-
    ## Description
    
    I can never reach this header (by clicking) through left-panel navigation.
    
    ## Other header
- name: "Other Tag 2"
  description: |-
    ## Description

    I can never reach this header (by clicking) through left-panel navigation.
    
    ## Other header 2

Screenshots
If needed, I can make a screen recording (since it's hard through a screenshot), but it should be self-explanatory.

Additional context
This issue happens because it's not possible to add custom id's on md headers, but they are all generated from the text.
I think a possible solution would be indeed to enable this feature. Long API documentations usually share headers naming, so this problem emerges all the time (e.g. every service might have an "Description" header or "Examples").

Check #1079

@AlexVarchuk
Copy link
Collaborator

Hi, @cpene1. Is it still not fixed?
This PR had to fix it.

@cpene1 cpene1 closed this as completed Oct 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants