Repository navigation
Conversation
Collaborator
|
Hi @jay23606, thanks so much for the contribution—especially the clear write-up and regression test! We recently fixed this in our main repository, and it will land in the next Redoc release via our regular sync. Our upstream change also covers AsyncAPI and GraphQL, keeps the deprecated and webhook badges on I'm closing this PR in favor of that upcoming release. To avoid duplicate work in the future, we're also improving our issue updates so we clearly mark what we're actively working on. Thanks again for helping improve Redoc's accessibility—we really appreciate it! |
jay23606
deleted the
pr-go/2690-endpoint-titles-should-be-h3-instead-of-
branch
November 10, 2026 00:20
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Bug
Operation titles nested under a tag were rendered as
h2, the same level as the tag heading. That flattens the page hierarchy and hurts accessibility. Operations are nested inside the tag section, so they should beh3.Change
group/item.ts: the tag group passesheadingLevel: 3to the operation builder.items/operation/item.tsanditems/operation/content.ts: accept an optionalheadingLevel(default 2) and use it for the operation header.h2.Testing
npx vitest run src/adapters/openapi/__tests__/operation-heading-level.test.tspasses with the fix and fails on the base source withexpected 2 to be 3.npm run unitpasses: 3690 tests.npm run lintpasses.npx tsc --noEmit -p tsconfig.jsonpasses.The operation-section helper matches headings by name, not level.
Regression test: fails on base three times (/expected 2 to be 3/), passes on fix three times (
npx vitest run src/adapters/openapi/__tests__/operation-heading-level.test.ts)Fixes #2690