Configurable selection of checks and their severity levels

[Patrick-Bayer]

Hi all,

i wrote a test to ensure backwards compatibility of our API that fails when the oasdiff breaking command returns a warning or an error.
I discovered that changing the type of a property from 'number' to 'integer' and its format from 'float' to 'int64' is not considered a breaking change. To us, it is a breaking change and therefore we want our test to fail.
With that use case in mind, is it possible to configure the severity level of checks and the selection of checks performed?

Best regards
Patrick

[reuvenharrison]

Hi @Patrick-Bayer,
Could you please share the 2 specs that you are comparing so I can see the context of the change.

This is important to determine if this is a bug or not.
For example: a change in request will behave differently than a change in response, and there are many other factors that can affect the result.

Thanks,
Reuven

[Patrick-Bayer]

Hi @reuvenharrison,

thanks for your response! The two specs are the following

components:
    schemas:
        Unternehmen:
            type: object
            properties:
                id:
                    type: number
                    format: float

components:
    schemas:
        Unternehmen:
            type: object
            properties:
                id:
                    type: integer
                    format: int64

The diff would then be

GET /unternehmen
- Responses changed
  - Modified response: 200
    - Content changed
      - Modified media type: application/json
        - Schema changed
          - Items changed
            - Properties changed
              - Modified property: id
                - Type changed from 'number' to 'integer'
                - Format changed from 'float' to 'int64'

[reuvenharrison]

Ok, so this is in the response.
Note that the revised type/format (integer/int64) are narrower than the original (number/float) so the client should not break upon this change.
Having said that I would like to change oasdiff changelog so that it outputs an INFO-level message for this kind of change.
If you still want a breaking change, please submit an issue to request the enhancement.
Reuven

[Patrick-Bayer]

Yes, you're right. This is totally fine for the response.

Is it possible to configure the severity level of checks and the selection of checks performed?

Finally, it would be great if you could briefly address this question. Thanks!

[reuvenharrison]

Severity levels are not configurable. Please submit an issue if you need this functionality.

[reuvenharrison]

Severity levels are now customizable: https://github.com/Tufin/oasdiff/blob/main/docs/BREAKING-CHANGES.md#customizing-severity-levels

[Patrick-Bayer]

That's great news, thanks!