Skip to content

fix: use <h1> for main page heading to improve accessibility #10598

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Oct 9, 2025
+7 −7
Merged

fix: use <h1> for main page heading to improve accessibility #10598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c934805
fix: use <h1> for main page heading to improve accessibility
SkullShoT007 Oct 9, 2025
9586129
fix(oas31): change info heading to h1 in OpenAPI 3.1.0 spec
SkullShoT007 Oct 9, 2025
4218816
test: update urls.cy.js to expect h1.title instead of h2.title
SkullShoT007 Oct 9, 2025
e92f846
test: update 5138.cy.js to expect h1.title instead of h2.title
SkullShoT007 Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/core/components/info.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,13 +97,13 @@ class Info extends React.Component {
return (
<div className="info">
<hgroup className="main">
<h2 className="title">
<h1 className="title">
{title}
<span>
{version && <VersionStamp version={version} />}
<OpenAPIVersion oasVersion="2.0" />
</span>
</h2>
</h1>
{host || basePath ? (
<InfoBasePath host={host} basePath={basePath} />
) : null}
Expand Down
4 changes: 2 additions & 2 deletions src/core/plugins/oas31/components/info.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@ const Info = ({ getComponent, specSelectors }) => {
return (
<div className="info">
<hgroup className="main">
<h2 className="title">
<h1 className="title">
{title}
<span>
{version && <VersionStamp version={version} />}
<OpenAPIVersion oasVersion="3.1" />
</span>
</h2>
</h1>

{(host || basePath) && <InfoBasePath host={host} basePath={basePath} />}
{url && <InfoUrl getComponent={getComponent} url={url} />}
Expand Down
2 changes: 1 addition & 1 deletion test/e2e-cypress/e2e/bugs/5138.cy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ describe("#5138: unwanted `url`/`urls` interactions", () => {
it("should stably render the first `urls` entry", () => {
cy
.visit("/pages/5138/")
.get("h2.title")
.get("h1.title")
.contains("USPTO Data Set API")
.wait(3000)
.contains("USPTO Data Set API")
Expand Down
4 changes: 2 additions & 2 deletions test/e2e-cypress/e2e/features/urls.cy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ describe("configuration options: `urls` and `urls.primaryName`", () => {

it("should render the first URL in the list", () => {
cy.visit("/?configUrl=/configs/urls.yaml")
.get("h2.title")
.get("h1.title")
.should("have.text", "OneOAS 2.0")
.window()
.then(win => win.ui.specSelectors.url())
Expand All @@ -31,7 +31,7 @@ describe("configuration options: `urls` and `urls.primaryName`", () => {
cy.visit("/?configUrl=/configs/urls-primary-name.yaml")
.get("select")
.should("contain.value", "/documents/features/urls/2.yaml")
.get("h2.title")
.get("h1.title")
.should("have.text", "TwoOAS 3.0")
.window()
.then(win => win.ui.specSelectors.url())
Expand Down