OpenAPITools / OpenAPITools/openapi-diff
[OpenAPI 3.1.0 support] JsonSchema type changes not handled.
Open
Nobody has claimed this yet.
OpenAP 3.1.0 Support
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 190
- PR merge metrics
- No merged PRs in 30d
Description
While migration to OpenAPI 3.1.0 all Schema objects becomes JsonSchema. 3.1.0 deserializes schema "type" to array field "types". At least this part of SchemaDiff works incorrectly: SchemaDiff.java#L349-L352. Most probably such changes will affect other parts of library.
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 reading core/src/main/java/org/openapitools/openapidiff/core/compare/SchemaDiff.java around lines 349-352, then trace other schema comparisons affected by OpenAPI 3.1.0 deserializing type into types. Done means schema diffs correctly handle JsonSchema type changes throughout the affected comparison paths.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi
- Domain
- api
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100