Skip to content

Commit

Permalink
Update BREAKING-CHANGES.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Reuven Harrison authored Jun 13, 2023
1 parent 6cba0db commit a41a3c2
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions BREAKING-CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a41a3c2

Please sign in to comment.