swagger-api / swagger-api/swagger-parser
Security definition includes a description in the spec, is it not parsed?
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 867
- Forks
- 560
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 7
Description
https://github.com/Swagger2Markup/swagger2markup uses this project to parse swagger and according to the dev of it ( @robwin ), it does not get this attributed, is it possible that this parsers missed it?
It is not required field, but included in the spec : https://swagger.io/specification/#securityDefinitionsObject
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 missing attribute through Swagger2Markup, then compare the parser's security definition output with the description field in the Swagger Security Definitions Object specification. Done means the optional description is parsed and exposed in the resulting Java model, with coverage for a security definition that includes it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100