swagger-api / swagger-api/swagger-ui

Correct accessibility issues with schemas

Open
#10,705 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

backlog cat: a11y
Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

  • focus is lost when opening or closing the schema in schemas section

  • OpenAPI 2.0/3.0: the information about the property being expanded is narrated only after navigating into […]/information group

https://github.com/user-attachments/assets/19213d46-80e3-4892-ba70-fecad2090bef

  • OpenAPI 3.1: keyboard navigation gets trapped in expanded properties, jumps between the property name and collapse all button

https://github.com/user-attachments/assets/242dde3a-143d-4480-96f3-d48e7287e3d5

  • OpenAPI 3.1: focus is not visible for schema name and properties with tab navigation

  • OpenAPI 3.1: no name/label for article section

  • OpenAPI 2.0/3.0 schema buttons - provide indication which property the button expands/collapses

  • OpenAPI 3.1 schema buttons - provide description for expanded/collapsed state

  • required property indicated by * - provide label/description required for screen reader users instead of *

This task covers issues originally reported in:

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the schemas section and reproduce the listed keyboard, focus, labeling, and screen-reader issues for OpenAPI 2.0, 3.0, and 3.1. Work through each checklist item and verify that focus remains usable, controls expose their property and expanded state, required fields are labeled, and the article has a name.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
accessibility, frontend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.