fix: use <h1> for main page heading to improve accessibility #10598
+7
−7
Conversation
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
Contributor
|
Hi @SkullShoT007, Thanks for providing this fix! We also have a separate component for info in OpenAPI 3.1.0 specifications - could you also change the heading to |
Contributor
Author
|
Sure! |
Contributor
Author
|
hi!. I have done the needed change in seperate component in OpenAPI 3.1.0 specification |
Contributor
|
Thanks for the update, @SkullShoT007! Looks like we have a few tests where we try to find the title by |
Contributor
Author
|
oh, Thanks for the feedback, I will look into it |
Contributor
Author
|
I have updated the tests now, its now h1.title instead of h2.title |
glowcloud
approved these changes
Oct 9, 2025
Contributor
glowcloud
left a comment
glowcloud
left a comment
There was a problem hiding this comment.
Thanks a lot @SkullShoT007, LGTM now!
swagger-bot
pushed a commit
that referenced
this pull request
Oct 10, 2025
## [5.29.4](v5.29.3...v5.29.4) (2025-10-10) ### Bug Fixes * **core:** refactor UNSAFE_ lifecycle methods in ContentType and OperationContainer ([#10373](#10373)) ([2814709](2814709)), closes [#10212](#10212) * ignore rendering responses with extensions in the schema ([#10592](#10592)) ([23e3e00](23e3e00)) * include script in body ([#10593](#10593)) ([456274c](456274c)) * update vulnerable libxml2 to 2.13.9-r0 ([#10600](#10600)) ([8138154](8138154)) * use h1 for title heading to improve accessibility ([#10598](#10598)) ([c0bd7b6](c0bd7b6)), closes [#10480](#10480)
Contributor
|
🎉 This PR is included in version 5.29.4 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Updated the main heading of the page to use an
element instead of a lower-level heading to meet accessibility standards.
Description
The main heading was not using an
, which is required for proper semantic structure and accessibility. This change ensures screen readers and assistive technologies can correctly interpret the page structure.
Motivation and Context
This change is required to improve accessibility by ensuring the main page heading uses an
element.
Without this, screen readers and other assistive technologies may not correctly interpret the page structure.
Fixes #10480
How Has This Been Tested?
Ran the code in development mode and verified that the main heading is now using an
tag by inspecting it in the browser's developer tools under the panel. Checked that the page layout and styling remain intact.
Screenshots (if appropriate):
Checklist
My PR contains...
src/is unmodified: changes to documentation, CI, metadata, etc.)package.json)My changes...
Documentation
Automated tests