swagger-api / swagger-api/validator-badge
Validation fails for ApiImplicitParam when name property has value of "format"
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 227
- Forks
- 81
- Avg merge
- 2h 3m
- Merged PRs (30d)
- 1
Description
Assigned the name property of an @ApiImplictParam the value of "format". The generated swagger json and yaml could not be validated when imported into swagger editor. Current workaround is to surround "format" in quotes i.e. "\"format\""
version = 1.5.10
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
Reproduce the validation failure from the generated Swagger JSON and YAML using validator-badge version 1.5.10, then compare the result with Swagger Editor. Investigate how an @ApiImplictParam whose name is "format" is represented, and consider the issue done when the generated artifacts validate without surrounding the value in extra quotes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi
- Domain
- api, testing
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100