As your API evolves, it will undergo changes. Some of these changes may be "breaking" while others are not.
The changelog provides a list of all significant changes between two versions of the OpenAPI specification, including non-breaking changes.
To generate the changelog between two specs run oasdiff with the changelog command:
oasdiff changelog https://raw.githubusercontent.com/Tufin/oasdiff/main/data/openapi-test1.yaml https://raw.githubusercontent.com/Tufin/oasdiff/main/data/openapi-test3.yaml
The changes are categorized into three levels:
ERR- Errors are definite breaking changes which should be avoidedWARN- Warnings are potential breaking changes which developers should be aware of, but cannot be confirmed programmaticallyINFO- Changes which are not breaking yet still important to know about
The changelog is an extension of the breaking changes output with additional INFO-level changes.
See the breaking changes documentation for additional options that can be also be used with changelog command.
To see the full list of supported changes, run:
oasdiff checks
By default, changes are displayed as human-readable text with color.
You can specify the --format flag to output changes in other formats: json, yaml, html, githubactions or junit.
An additional format singleline displays each change on a single line, this can be useful to prepare ignore files
When outputting changes to a Unix terminal, oasdiff automatically adds colors with ANSI color escape sequences.
If output is piped into another process or redirected to a file, oasdiff disables color.
To control color manually, use the --color flag with always or never.
If you encounter a change that isn't logged by oasdiff you may add a custom check.