swagger-api / swagger-api/swagger-codegen
swagger-codegen generate should provide an option to promote warnings into errors
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
After having some experience with writing the spec and observing warnings I get I come to conclusion that most of the warnings so far was a real problem in my spec definition.
Therefore I'd prefer to get straight up errors or at least have a way to promote warnings into errors so I can notice problems easier.
See
https://github.com/swagger-api/swagger-codegen/issues/5160
https://github.com/swagger-api/swagger-codegen/issues/5161
https://github.com/swagger-api/swagger-codegen/issues/5162 - example of not real issue which needs to be addressed before this issue.
Swagger-codegen version
current master; HEAD = 1c160df33897898da1c39f230c737eb6a313e6ba
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-codegen generate command and review issues 5160, 5161, and 5162 for the warning behavior and expected exceptions. Done means providing a documented option that promotes applicable warnings to errors while preserving the handling of warnings that are not real issues.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- cli, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100