Skip to content

Endpoint titles should be h3 instead of h2 #2690

Open
@JeSuisUnCaillou

Description

@JeSuisUnCaillou

Describe the bug
Not really a bug, more a improper use of the title hierarchy.

We have a unique h1 title, which is good.
When we have tags, we have h2 titles for the tags, which is good as they are the second level of hierarchy of the page.

But then the titles of each endpoint is h2 again.

Expected behavior
When there is tags, the titles of the endpoints should be h3, in order to properly convey that the endpoint is nested inside the tag's section.

Minimal reproducible OpenAPI snippet(if possible)
It is visible on https://redocly.github.io/redoc/, see the screenshot below.

Screenshots

Image

Additional context
It would also help accessibility to have this proper title hierarchy.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions