swagger-api / swagger-api/swagger-ui

Schema not being clear when it's an array in version 3.1.0

Open
#9,593 2 comments 4 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)
  • OS: [macOS]
  • Browser: [chrome]
  • Version: [Version 121.0.6167.160 ]
  • Method of installation: [npm]
  • Swagger-UI version: [v5.6.2]
  • Swagger/OpenAPI version: [e.g. Swagger 3.0, OpenAPI 3.1.0]
Content & configuration

Example Swagger/OpenAPI definition:

https://editor-next.swagger.io/

Swagger-UI configuration options:
default config of https://editor-next.swagger.io/ and https://editor.swagger.io/

Describe the bug you're encountering

Using the version 3.1.0. The display of the schema is not showing the name of the objects

Version 3.0.3
Screenshot 2024-02-14 at 11 53 18
Version 3.1.0
Screenshot 2024-02-14 at 11 54 28

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 reproducing the schema rendering in the provided Swagger Editor URLs with the reported OpenAPI 3.1.0 setup, then compare it with version 3.0.3 using the screenshots as the expected behavior. Trace the frontend schema display path to determine why object names disappear for array schemas; done means those names are shown again without regressing the 3.0.3 behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, openapi
Domain
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.