mirror of
https://github.com/ilyakooo0/compaREST.git
synced 2024-11-23 22:12:16 +03:00
71 lines
3.2 KiB
Markdown
71 lines
3.2 KiB
Markdown
# openapi-diff
|
|
|
|
[](https://hackage.haskell.org/package/openapi-diff)
|
|
[](http://stackage.org/lts/package/openapi-diff)
|
|
[](http://stackage.org/nightly/package/openapi-diff)
|
|
[](LICENSE)
|
|
|
|
Compatibility checker for OpenAPI
|
|
|
|
|
|
```
|
|
Usage: openapi-diff (-c|--client ARG) (-s|--server ARG)
|
|
[--silent | --only-breaking | --all] [-o|--output ARG]
|
|
[--folding-block-quotes-style | --header-style]
|
|
A tool to check compatibility between two OpenApi specifications.
|
|
|
|
Usage examples
|
|
|
|
Compare files old.yaml with new.yaml and output the resulting report to
|
|
stdout:
|
|
|
|
openapi-diff -c old.yaml -s new.yaml
|
|
|
|
Only output breaking changes and write a styled HTML report to file
|
|
report.html:
|
|
|
|
openapi-diff -c old.yaml -s new.yaml --only-breaking -o report
|
|
|
|
Don't output anything, only fail if there are breaking changes:
|
|
|
|
openapi-diff -c old.json -s new.json --silent
|
|
|
|
Write full report suitable for embedding into a GitHub comment to
|
|
report.html:
|
|
|
|
openapi-diff -c old.json -s new.json --folding-block-quotes-style -o report.html
|
|
|
|
Available options:
|
|
-h,--help Show this help text
|
|
-c,--client ARG A path to the file containing the specification that
|
|
will be used for the client of the API. Can be either
|
|
a YAML or JSON file.
|
|
-s,--server ARG A path to the file containing the specification that
|
|
will be used for the server of the API. Can be either
|
|
a YAML or JSON file.
|
|
--silent Silence all output.
|
|
--only-breaking Only report breaking changes in the output.
|
|
--all Report both incompatible and compatible changes.
|
|
Compatible changes will not trigger a failure exit
|
|
code.
|
|
-o,--output ARG The file path where the output should be written. If
|
|
the option is omitted the result will be written to
|
|
stdout.
|
|
|
|
The file extension is used to determine the type of
|
|
the output file.
|
|
|
|
Supports many formats such as markdown, html, rtf,
|
|
doc, txt, rst, and many more.
|
|
|
|
Leave out the extension to produce a self-contained
|
|
HTML report with styling.
|
|
--folding-block-quotes-style
|
|
The report tree is structured using summary/detail
|
|
HTML elements and indented using block quotes. This
|
|
style renders well on GitHub.Intended for HTML output
|
|
format. Markdown has rendering bugs on GitHub.
|
|
--header-style The report tree is structured using increasing levels
|
|
of headers.
|
|
```
|