swagger-api / swagger-api/swagger-ui
DefaultModelExpandDepth does not expand Enum values
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
When defining DefaultModelExpandDepth (and DefaultModelsExpandDepth likewise), the models expand nicely by default, however any enum values will not be expanded.
See this example:
vs
This way it is not possible to show a complete "picture" of the actual model and it's possibilities upon first view.
Personally I'd just also collapse the EnumModel based on the given configuration, but if the current behavior is expected, it would be nice to have an option to toggle it.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the reported behavior with DefaultModelExpandDepth and DefaultModelsExpandDepth, using the example and screenshots in the issue. Trace how model expansion treats enum values and clarify whether enums should follow the configured depth or need a separate option; done when the intended behavior is visible on the initial model view.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100