apiome contract
Global options such as --base-url, --tenant and --json go before the command — see CLI reference. Exit codes are listed in Exit codes.
apiome contract
Compile and inspect executable contract suites for a version.
apiome contract [OPTIONS] COMMAND [ARGS]...
Subcommands: suite.
apiome contract suite
Compile a contract suite (POST /v1/tenants/{tenant}/contracts/{ref}/suite).
Prints a summary, or the whole manifest with the global --json flag. Exits non-zero when the version yields no suite, or when the digest does not match the manifest's own bytes.
apiome contract suite [OPTIONS]
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--project | text | yes | Project slug or UUID (or Catalog item slug/UUID with --kind catalog). | |
--version | text | yes | Version label, revision UUID, or 'latest'. | |
--kind | text | project | Which surface the artifact lives on: project (default) or catalog. | |
--seed | integer range | 0 | Seed for generated values. The same version and seed give the same suite. | |
--examples / --no-examples | flag | --examples | Compile the examples declared in the source document (on by default). | |
--generated / --no-generated | flag | --generated | Compile schema-valid generated bodies (on by default). | |
--negative / --no-negative | flag | --negative | Compile the negative cases a contract needs to be worth running (on by default). | |
--operation | text (repeatable) | Restrict to this operation key (repeatable), e.g. 'GET /pets/{petId}'. | ||
--max-operations | integer range | Cap on compiled operations. Truncation is reported as a finding. | ||
--out | path | Write the manifest's canonical bytes to this file (the bytes the digest covers). |