Octri

docs versions

Lists the versions published on your docs site: each one's version, label, endpoint count, when it was published and its spec ID. The default one is marked. Each subcommand takes a spec ID from specs list, and changes are live straight away. See versioning.

bash
octri docs versions [list | publish <specId> | label <specId> <label> | default <specId> | unpublish <specId>]

octri docs versions publish <specId>

Adds a spec version to your docs site.

Arguments

<specId>stringrequired

The spec version.

octri docs versions label <specId> <label>

Sets the name readers see in the version menu, such as v2 (beta).

Arguments

<specId>stringrequired

The spec version.

<label>stringrequired

The label. Everything after the ID is the label.

octri docs versions default <specId>

Makes a version the one readers land on.

Arguments

<specId>stringrequired

The spec version.

octri docs versions unpublish <specId>

Takes a version off your docs site. The spec stays in your project.

Arguments

<specId>stringrequired

The spec version.

Examples

Publish a version and list them

bash
octri docs versions
Output
✔ Loading published versions

Published versions (1)
     VERSION     LABEL              ENDPOINTS  PUBLISHED  SPEC
  ─  ──────────  ─────────────────  ─────────  ─────────  ────────────────────────
  ●  2024-08-01  2024-08 (current)  23         0s ago     6acd4f5218c2528b59327451