Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
reuvenharrison committed Oct 21, 2024
1 parent 529211e commit 37041bc
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/BREAKING-CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,14 @@ Where the file `oasdiff-levels.txt` contains a single line:
api-security-removed err
```

Checks can be customized with the following levels:
| Custom Level | Check Status |
| ------------- | ------------- |
| err | Enabled with level ERR |
| warn | Enabled with level WARN |
| info | Enabled with level INFO |
| none | Disabled |

### Customizing Breaking Changes Checks
If you encounter a change that isn't reported, you may:
1. Run `oasdiff checks` to see if the check is available, and [customize the level as needed](#customizing-severity-levels).
Expand Down

0 comments on commit 37041bc

Please sign in to comment.