Skip to main content

apiome schema

Global options such as --base-url, --tenant and --json go before the command — see CLI reference. Exit codes are listed in Exit codes.

apiome schema​

Test payloads against cataloged schemas (CI evidence).

apiome schema [OPTIONS] COMMAND [ARGS]...

Subcommands: test.

apiome schema test​

Run schema tests server-side and gate on the verdicts.

Exit codes: 0 every case passed; 6 at least one case failed (a payload's verdict did not match its expectation, or a mutant did not violate its intended constraint); 1 a case could not be checked at all, a transport/server fault, or an empty run; 2 bad usage, rejected credentials, or a schema reference the server refused (any 4xx).

apiome schema test [OPTIONS]

Options

OptionTypeDefaultRequiredDescription
--schematextyesPath-shaped schema reference: project/{slug}/{version}/{type}, catalog/{item}/{version}/{type}, or registry/{namespace}/{name}; the trailing /{type} segment is optional. {version} is a version label, a revision id, or 'latest'.
--payloadpath (repeatable)Payload file to validate (repeatable). JSON by default; *.xml is sent as XML.
--generate / --no-generateflag--no-generateRun the generated set: valid instances plus single-constraint mutants, each verified server-side. Default: off, except in --suite mode where it is on.
--suitepathSuite mode: a directory of saved payload files (all expected valid), or an IXH-1.1 corpus manifest whose 'instance-payload' entries are run with expectations from validity_class. Also runs the generated set unless --no-generate.
--seedinteger range0Synthesis seed: the same schema and seed generate byte-identical payloads.
--junitpathWrite the run as JUnit XML to this file ('-' for stdout).