Octri

docs pages

Endpoint pages are generated from your spec, one per endpoint. On its own, this command lists them with each one's slug, title, type and when it changed. Running octri docs on its own does the same. Add --json for each page's ID, which the commands that change one page take.

bash
octri docs pages [list | generate | regenerate <id> | publish <id> | title <id> <title>]

octri docs pages generate

Queues pages for generation and prints how many. On its own it rebuilds only pages that were never written, or whose part of the spec changed since. Follow the run with octri specs status.

A page you've edited in API Studio keeps your edit. Regenerating it changes the copy underneath, not what readers see, which can look like the command did nothing.

Flags

--allboolean

Rewrites every page, changed or not.

--clear-overridesboolean

Also throws away your edits to pages. Needs --yes.

--yesboolean

Confirms --clear-overrides.

octri docs pages regenerate <docPageId>

Queues one page for regeneration.

Arguments

<docPageId>stringrequired

The page's ID, from octri docs pages --json.

octri docs pages publish <docPageId>

Publishes one page's draft, so readers see your latest edit to it.

Arguments

<docPageId>stringrequired

The page's ID.

octri docs pages title <docPageId> <title>

Renames a page.

Arguments

<docPageId>stringrequired

The page's ID.

<title>stringrequired

The new title. Everything after the ID is the title, so it can have spaces.

Examples

List pages

bash
octri docs pages
Output
✔ Loading doc pages

Doc pages (23)
  SLUG                                      TITLE                            TYPE      UPDATED
  ────────────────────────────────────────  ───────────────────────────────  ────────  ───────
  get-customers                             List customers                   endpoint  22d ago
  post-customers                            Create a customer                endpoint  22d ago
  delete-customers-customerid               Delete a customer                endpoint  25d ago
  get-customers-customerid                  Retrieve a customer              endpoint  22d ago
  patch-customers-customerid                Update a customer                endpoint  25d ago
  get-customers-customerid-subscriptions    List a customer's subscriptions  endpoint  25d ago
  get-events                                List events                      endpoint  25d ago
  …