apiome diff
Global options such as --base-url, --tenant and --json go before the command — see CLI reference. Exit codes are listed in Exit codes.
apiome diff
Diff a local OpenAPI file against a published project version (CI gate).
Uploads file as an inline candidate and classifies against a stored version via POST /v1/diff/{tenant}/classified. Exit codes: 0 = gate passed, 1 = threshold met, 2 = operational error.
With --consumers the report also names whose build each change breaks ("breaks billing-service") in all three formats. The threshold is unchanged: it still grades the whole specification, so a passing gate never depends on who has registered.
apiome diff [OPTIONS] FILE
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
FILE | file | yes | Path to the candidate OpenAPI YAML/JSON file. |
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--against | text | yes | Stored baseline as <project>@<version|latest> (e.g. payments@latest). | |
--fail-on | text | breaking | Exit 1 when changes at this level or higher are present: breaking (default) or warn (non-breaking and breaking). docs-only alone never fails. Exit 2 on auth/network/parse errors. | |
--format | text | text | Output format: text (default), json, or md (CTG-1.3 markdown changelog). | |
--consumers | flag | Add the CTG-4.2 per-consumer analysis: which registered consumers of the baseline project this change breaks. Needs consumer_contracts:view. |