incompatible api diff result when one of property in model becomes not required

Open
#535 2 comments 1 reaction 0 assignees View on GitHub

Maintainers usually reply within 5 days

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
38/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
java, openapi

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.

Description

Breaking/Non-Breaking classification

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"
        ], ...
Dominant language
Java
Stars
1.1k
Forks
191
Avg merge
4d 23h
Merged PRs (30d)
1

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OpenAPITools/openapi-diff

All issues in OpenAPITools/openapi-diff

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.