OpenAPITools / OpenAPITools/openapi-diff
incompatible api diff result when one of property in model becomes not required
Open
Nobody has claimed this yet.
Breaking/Non-Breaking classification
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 190
- PR merge metrics
- No merged PRs in 30d
Description
if in new api version some property is not required anymore, new api is recognized as not compatible
old api schema definition:
"SomeDto": {
"required": [
"prop1",
"prop2",
"prop3"
], ...
new api schema definition:
"SomeDto": {
"required": [
"prop1"
], ...
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 comparison with the old and new schema definitions shown in the issue, then trace where required-property changes are classified as incompatible. Done means the diff correctly handles a property becoming optional, with a regression test covering the example schemas.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi
- Domain
- api, backend-api-design
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100