Skip to main content

apiome convert

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

apiome convert​

Convert a catalog item to OpenAPI (POST .../convert); print the fidelity summary + warning.

A commit (the default) creates a publishable Project/version from the converted OpenAPI document; --dry-run returns the fidelity report only. --projection-out additionally writes the machine-readable projection manifest (CPDO-1.3). Exits non-zero on a low-fidelity tier unless --force — a hint that the converted spec is substantially incomplete.

apiome convert [OPTIONS] ARTIFACT

Arguments

ArgumentTypeRequiredDescription
ARTIFACTtextyesCatalog item id (the non-OpenAPI import) to convert.

Options

OptionTypeDefaultRequiredDescription
--totextopenapiConversion target (only 'openapi' today; the verb is target-generic).
--dry-runflagPreview only: return the fidelity report with no project created.
--outtextWrite the would-be OpenAPI document here (dry-run only; '-' for stdout).
--projection-outtextWrite the machine-readable projection manifest here ('-' for stdout): which source construct became which OpenAPI pointer, and why anything did not.
--forceflagDo not exit non-zero on a low-fidelity result.
--titletextFallback API title, applied only if the source declares none.
--api-versiontextFallback API version, applied only if the source declares none.
--servertext (repeatable)Fallback server URL (repeatable), applied only if the source has none.