Skip to main content

diff:openapi

The diff:openapi command compares the current branch's OpenAPI spec file(s) with the main/master/head branch's OpenAPI spec file(s). This is useful for reviewing API changes between branches and detecting breaking changes in CI pipelines.

Usage​

pnpm psy diff:openapi

Options​

  • -f: Fail on breaking changes. Useful in CI to prevent merging branches that introduce breaking API changes.
  • -h, --help: Display help for command.

Example​

Fail if any breaking OpenAPI changes are detected (useful in CI):

pnpm psy diff:openapi -f