Shouldn't change in the type of any existing Request or Response property be a breaking change?

Issue #40 new
Rico M created an issue

openapi-diff: ^0.23.5

This change in request property shows as a non-breaking change

{
  breakingDifferencesFound: false,
  nonBreakingDifferences: [
    {
      type: 'non-breaking',
      action: 'add',
      code: 'request.body.scope.add',
      destinationSpecEntityDetails: [Array],
      entity: 'request.body.scope',
      source: 'json-schema-diff',
      sourceSpecEntityDetails: [Array],
      details: [Object]
    }
  ],
  unclassifiedDifferences: []
}

            "OldClient": {
                "required": [
                    "buyer",
                    "keeperId"
                ],
                "type": "object",
                "properties": {
                    "buyer": {
                        "$ref": "#/components/schemas/Person"
                    }
                    "name": {
                        "type": "string",
                        "nullable": true
                    }
                    "contactNumber": {
                        "type": "string",
                        "nullable": true
                    }
                    "keeperId": {
                        "type": "string",
                        "nullable": true
                    }
                },
                "additionalProperties": false
            },
            "NewClient": {
                "required": [
                    "buyer"
                ],
                "type": "object",
                "properties": {
                    "id": {
                        "type": "string",
                        "nullable": true
                    },
                    "buyer": {
                        "$ref": "#/components/schemas/Person"
                    },
                    "name": {
                        "type": "string",
                        "nullable": true
                    },
                    "contactNumber": {
                        "type": "string",
                        "nullable": true
                    },
                    "keeperId": {
                        "type": "string",
                        "nullable": true
                    }
                },
                "additionalProperties": true
            }

Comments (7)

  1. Sebastian Tello Account Deactivated

    @Rico M , I can’t tell from what you shared, can you please include the whole definition of those NewClient and OldClient references?

    Also, I’m not sure if the tool will be able to process that application/json-patch+json content-type.

    Please, when reporting issues include the version of the library you are running.

  2. Rico M reporter
    • edited description

    updated the ticket with the library version and OldClient/NewClient definition

    openapi-diff: ^0.23.5

  3. Log in to comment