swagger-api / swagger-api/swagger-codegen
Preview in editor differs from generated HTML
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
Preview in online editor https://editor.swagger.io/ is different than generated HTML/HTML2 client. The difference is in the body param, which is described as reference to JSON schema.
Swagger-codegen version
Used by https://editor.swagger.io/.
Swagger declaration file content or url
https://gist.github.com/Lolash/b7ac747b51aad1213808d7c62226a129
Steps to reproduce
Paste given yaml file into https://editor.swagger.io/ and take a look at any method, which has body as param. Body parameter is well described.
Then, generate HTML or HTML2 client and take a look at the same method. Body parameter is not described at all.
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 with the Swagger declaration in the linked gist and reproduce the discrepancy in https://editor.swagger.io/ using a method with a body parameter. Compare the generated HTML and HTML2 client output with the editor's description, then trace the relevant generation templates or entry points. Done means the body parameter is described consistently in the generated output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html, openapi
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100