Markdown report command

Generate a markdown report of OpenAPI changes.

---

Use markdown-report when you want a shareable file instead of a terminal session. It renders the semantic change report as markdown, which makes it useful for pull requests, release notes, and internal docs.

Example:

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

---

Useful flags

Write to a specific file

Use --report-file to choose the output filename.

openapi-changes markdown-report --report-file changes.md ./ sample-specs/petstorev3.json

Include the raw unified diff

Use --include-diff to append a collapsible unified diff of the raw spec for each commit.

openapi-changes markdown-report --include-diff ./ sample-specs/petstorev3.json

Theme flags

The command also exposes the shared terminal theme flags:

openapi-changes markdown-report --tektronix ./ sample-specs/petstorev3.json

See Command Arguments for the shared flags.