8000 Inconsistent rendering of schema titles, refs, and types across UI elements · Issue #5649 · scalar/scalar · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Inconsistent rendering of schema titles, refs, and types across UI elements #5649

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

Jump to bottom
Closed
DmitriiKhudiakov opened this issue May 14, 2025 · 0 comments · Fixed by #5676
Closed

Inconsistent rendering of schema titles, refs, and types across UI elements #5649

DmitriiKhudiakov opened this issue May 14, 2025 · 0 comments · Fixed by #5676
Assignees
@antlio
Labels
bug Something isn't working

Comments

@DmitriiKhudiakov
Copy link
Contributor
DmitriiKhudiakov commented May 14, 2025 •
edited
Loading

What happens?

Describe the bug

When generating API documentation with Scalar for an OpenAPI 3.1 spec, different UI elements display different schema identifiers: sometimes the title, sometimes the component key (ref), and sometimes the raw JSON type (object/array). This inconsistency is confusing for end users.

Sandbox link

To Reproduce

  1. Define an OpenAPI document with a schema whose components.schemas key differs from its internal title.
  2. Reference that schema (or use it in a oneOf with a discriminator) in a path operation.
  3. Generate the docs with Scalar.
  4. Observe:
    • Left sidebar (Models) and section headers show the schema’s title.
    • Field type labels (e.g. object, array SubModel__Schema_Ref[]) use the JSON type or the component key.
    • “Show …” links for nested schemas again display the title.

What did you expect to happen?

All UI elements should consistently use the same identifier—ideally the human-readable title—or clearly distinguish between “Type”, “Schema Ref”, and “Schema Title” with explicit labels.

Screenshots

Image

OpenAPI Document

https://sandbox.scalar.com/e/aW4Rr
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@antlio antlio

Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(api-reference): show schema titles in the models section DmitriiKhudiakov/scalar
2 participants
@antlio @DmitriiKhudiakov
0