apiome paths

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

apiome paths

List and inspect OpenAPI path templates for a project version.

apiome paths [OPTIONS] COMMAND [ARGS]...

Subcommands: list, show.

apiome paths list

List path templates and operations (GET /versions/{version_id}/paths).

apiome paths list [OPTIONS]

Options

Option	Type	Default	Required	Description
--project	text		yes	Project UUID or slug.
--version	text		yes	Version UUID, slug, or label.
--tag	text (repeatable)			Filter by OpenAPI operation tag (repeatable).
--method	text (repeatable)			Filter by HTTP method (repeatable).
--q	text			Case-insensitive text search over path, method, operationId, summary, and tags.
--limit	integer range	50		Maximum rows per API page (server enforces its own max).
--all	flag			Fetch all API pages when resolving paths and operations.

apiome paths show

Show one path template and its operations (GET /versions/{version_id}/paths/{path_id}).

apiome paths show [OPTIONS] PATH_REF

Arguments

Argument	Type	Required	Description
PATH_REF	text	yes	Path UUID or OpenAPI path template.

Options

Option	Type	Default	Required	Description
--project	text		yes	Project UUID or slug.
--version	text		yes	Version UUID, slug, or label.
--tag	text (repeatable)			Filter operations by OpenAPI tag (repeatable).
--method	text (repeatable)			Filter operations by HTTP method (repeatable).