swagger-api / swagger-api/swagger-ui

Provide missing labels and descriptions for buttons

Open
#10,699 1 comment 1 reaction 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

Provide labels and descriptions for buttons, e.g.:

  • global Authorize button - provide description for authorized/unauthorized state
  • operation-level Authorize button - provide indication which operation will be authorized, remove redundant button from the label
  • Authorize button - provide indication that the button will open a dialog
  • X (close) button in Authorization dialog - provide label
  • Remove array item button in parameters - provide label
  • Copy to clipboard button - provide label and indication about what will be copied (e.g. cURL)

This task covers issues originally reported in linked sub-issues and:

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 by locating the implementations of the global and operation-level Authorize buttons, the Authorization dialog close button, parameter Remove array item control, and Copy to clipboard button. Use the checklist and linked issues 5248 and 7350 to determine the required labels and descriptions; done means each listed control communicates its purpose and state to assistive technology.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
accessibility, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.