Octri

specs push

Uploads a spec file to the selected project as a new version, then waits for everything that follows: the spec parses in seconds, then the doc pages, the search index and the changelog are written behind it. The spinner names the stage it's on, and the command returns once the whole pipeline has settled, so the next command sees the new version.

The new version becomes the current spec. Docs readers see it once you publish the version. See importing a spec for the formats Octri reads.

bash
octri specs push <file> [--no-wait]

Arguments

<file>pathrequired

The spec, in YAML or JSON. Pass - to read it from stdin.

Flags

--no-waitboolean

Return once the upload is accepted, without following the pipeline. Check on it later with octri specs status.

Examples

Push a spec

bash
octri specs push openapi.yaml

Push from another command

- reads the spec from stdin, so a build step can pipe its output straight in.

bash
./scripts/bundle-spec.sh | octri specs push -