swagger-api / swagger-api/swagger-parser
Migrate swagger Java YAML parser away from 1.1 to YAML 1.2
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 867
- Forks
- 560
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 7
Description
Why?
Because there are advanced features of YAML that the OpenAPI specification doesn't support, and these are still acted upon within the current YAML parser.
A simple example is using no as a boolean false, the classic Norway country code can be confused for false :D
country_codes:
# - ...
- no # Get's parsed as false by YAML 1.1
ping @frantuma in case I'm recreating an already existing issue.
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
The issue names no files, tests, or entry points. Start by locating the Swagger Java YAML parser and its existing parser tests, then compare current YAML 1.1 behavior with YAML 1.2; done means OpenAPI parsing no longer treats YAML 1.1-only booleans such as no as false.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100