Skip to main content

apiome formats

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

apiome formats​

List the formats this deployment supports, in which directions and at which versions.

Args:
ctx: The Typer context, carrying the root flags (``--json``, ``--timeout``, ``--insecure``)
and the resolved settings.
json_output: Print the endpoint's response verbatim. Accepted here as well as on the root
command (``apiome --json formats``) so the flag works in the position users reach for.
paradigm: Optional paradigm filter, validated and applied server-side.
direction: Optional capability filter (``import`` / ``export`` / ``both``), validated here
so a typo is a usage error rather than a 422 from the API.
Raises:
typer.Exit: With :data:`~apiome_cli.exit_codes.EXIT_USAGE` when ``--direction`` is not one
of the three accepted values.
apiome formats [OPTIONS]

Options

OptionTypeDefaultRequiredDescription
--jsonflagEmit the raw matrix JSON on stdout (machine-readable).
--paradigmtextShow only formats in this paradigm: rest, rpc, event, graph, data_schema, agent.
--directiontextShow only formats with this capability: import (everything Apiome can read), export (everything it can write), or both (formats that round-trip).