swagger-api / swagger-api/swagger-ui

Screen reader does not announce the error information appears while editing the code elements.

Open
#10,443 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Q&A (please complete the following information)
  1. OS: Windows 11
  2. Browsers: Microsoft Edge (Version 135.0.3179.98) and Google Chrome (Version 135.0.7049.115)
  3. Versions: Version 135.0.3179.98 and Version 135.0.7049.115
  4. Method of installation: dist
  5. Swagger-Editor version: 4.0.3
  6. Swagger/OpenAPI Version: Swagger 2.0
Content & configuration

Example Swagger/OpenAPI definition:
https://github.com/microsoft/PowerPlatformConnectors/blob/dev/certified-connectors/Nintex%20Workflow/apiDefinition.swagger.json

Swagger-UI configuration options:

SwaggerUI({
  // your config options here
})
?yourQueryStringConfig
Describe the bug you're encountering
To reproduce...
  1. Open URL: https://editor.swagger.io/
  2. Navigate inside the "Code editor" and enter any value.
  3. Verify whether the screen reader announces the error information or not.

Actual Result
Screen reader does not announce the error information appears while editing the code elements.

Expected behavior

Screen reader should announce the error information appears while editing the code element
Example: Screen reader should announce error information as ' Errors, Resolver error Cannot set properties of undefined (setting 'swagger')' while editing the code elements.

Screenshots

https://github.com/user-attachments/assets/dd4192e9-c1e4-4235-87ef-0bb504a79adb
Image

Additional context or thoughts

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

Reproduce the issue at https://editor.swagger.io/ by editing a value in the Code editor with a screen reader enabled. Inspect how the editor presents the error information during editing and verify the behavior in Edge or Chrome. Done means the screen reader announces the displayed error, including the resolver error text.

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
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.