OpenAPITools / OpenAPITools/openapi-diff
Removing a mandatory or optional property in the input data : breaking change ?
Open
Nobody has claimed this yet.
Breaking/Non-Breaking classification
question
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 190
- PR merge metrics
- No merged PRs in 30d
Description
Removing a mandatory or optional property in the input data (request body) is NOT recognized as a breaking change in the tool.
Why not ?
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 reported comparison using two OpenAPI specifications whose request body differs by a removed mandatory or optional property. Read the request-body breaking-change detection entry point and existing comparison tests, then confirm that the tool reports the removal consistently with its expected compatibility rules.
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
- Needs clarification
- Newbie friendliness
- 25/100