diff --git a/BREAKING-CHANGES.md b/BREAKING-CHANGES.md index 9c8837d8..94db9c79 100644 --- a/BREAKING-CHANGES.md +++ b/BREAKING-CHANGES.md @@ -2,6 +2,8 @@ A breaking change is a change to a component, such as a server, that could break a dependent component, such as a client, for example deleting an endpoint. When working with OpenAPI, breaking-changes can be caught by monitoring changes to the specification. +**oasiff detects over 100 kinds of breaking changes** + To detect breaking-changes between two specs run oasdiff with the `-check-breaking` flag: ``` oasdiff -check-breaking -base https://raw.githubusercontent.com/Tufin/oasdiff/main/data/openapi-test1.yaml -revision https://raw.githubusercontent.com/Tufin/oasdiff/main/data/openapi-test3.yaml