swagger-api / swagger-api/swagger-ui

Suggestion: UI > Model

Open
#3,898 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

cat: style & presentation type: enhancement
Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Hi -

Thanks for great UI.

Small suggestion: I don't think a user of the UI is interested in names of swagger-models, so I think those are just a distraction and clutter. I'm referring to these (example: "request:lab:create:data"):

image

Maybe do show them in the "Models" section that appears on the bottom (where all models are listed), but maybe not "inline" (within request and response info). If those "collapsing" arrows are instead displayed next to the name of attribute, everything would continue to work just fine. Alternatively, maybe do continue display the model name, but in less distracting fashion (tooltips over attributes names, tiny font, or similar). I see tooltips are present anyway (although, kind of, redundantly).

I'm following jsonapi.org specs to structure my inputs and outputs, and those have a lot more "depth" and "flavors" (across various methods) compared to the Petstore sample, so unimportant information being out of the way helps understanding that structure better, I think.

Not criticizing; just a suggestion :)

Thank you for the great code. I like this UI much better than v2!

Thanks.
Hari

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

The issue concerns model names shown inline in request and response information and the separate Models section, but it names no files or tests. Start by locating the UI components that render those areas and confirm which presentation should change. Done means the inline model information is less distracting while model details remain available in the Models section.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.