OpenAPITools / OpenAPITools/openapi-diff
No backward compatible changes in Schema are marked as Compatible
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 190
- PR merge metrics
- No merged PRs in 30d
Description
Hello, Thanks alot for this great library. I am testing this library and found the following bugs when comparing Schemas,
Library version: 'org.openapitools.openapidiff:openapi-diff-core:2.1.0-beta.8'
- Removing an attribute from a Model is a non-backward compatible change, but It is marked as COMPATIBLE.
- Updating description of an attribute is a Metadata change but this is also marked as COMPATIBLE
After several tests, I deduced, The current version is able to detect any change in schema models, but all changes are marked as COMPATIBLE. I think the compatibility checks including metadata change checks are missing.
Please have a look and provide a roadmap when this feature can be fixed. Thanks alot for all the effort and excellent work.
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 reported comparisons with openapi-diff-core 2.1.0-beta.8, focusing on schema property removal and attribute description changes. Trace the schema compatibility checks; done means removed model attributes are reported as non-compatible and description-only changes are classified as metadata changes rather than compatible.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100