Summary command

Print a terminal summary of OpenAPI changes.

---

The summary command prints a concise semantic overview of what changed. It is the quickest way to inspect a diff in the terminal or wire openapi-changes into CI.

Examples:

openapi-changes summary ./ sample-specs/petstorev3.json openapi-changes summary HEAD~1:openapi.yaml ./openapi.yaml

You should see something like this:

---

Useful flags

Markdown output

Use --markdown to render the summary as markdown. This is useful in CI logs, issue comments, and release notes.

openapi-changes summary --markdown ./ sample-specs/petstorev3.json

If you are capturing the output for a PR comment or other automation, combine it with --no-logo to suppress the startup banner:

openapi-changes summary --markdown --no-logo ./ sample-specs/petstorev3.json

Fail the build on any diff

Use --error-on-diff if any detected change should produce a non-zero exit code.

openapi-changes summary --error-on-diff ./ sample-specs/petstorev3.json

Include source locations

Use --with-lines to include source line and column locations in semantic tree leaves.

openapi-changes summary --with-lines ./ sample-specs/petstorev3.json

---

Terminal themes

Use the shared terminal theme flags to switch presentation:

openapi-changes summary --no-color ./ sample-specs/petstorev3.json openapi-changes summary --roger-mode ./ sample-specs/petstorev3.json openapi-changes summary --tektronix ./ sample-specs/petstorev3.json

--roger-mode is an alias for --no-color.

See Command Arguments for the shared flags.