Octri

docs endpoints

Lists draft endpoints: ones added, or marked for removal, ahead of the next publish, the same drafts Add endpoint makes in API Studio. Nothing here changes your spec until publish, which writes every draft into it as a new version. Until then, readers, SDKs and MCP tools see nothing. See endpoints.

bash
octri docs endpoints [list | add | edit | remove | discard | publish]

octri docs endpoints add <METHOD> <path> --summary <text>

Drafts a new endpoint.

Arguments

<METHOD>stringrequired

GET, POST and so on, in any case.

<path>stringrequired

The OpenAPI path, such as /customers/{id}.

Flags

--summary <text>stringrequired

The endpoint's one-line summary.

--description <text>string

A longer description.

octri docs endpoints edit <draftId>

Changes a draft's summary or description.

Arguments

<draftId>stringrequired

The draft, from the list.

Flags

--summary <text>string

The new summary.

--description <text>string

The new description.

octri docs endpoints remove <METHOD> <path>

Marks an endpoint your spec has for removal on the next publish.

Arguments

<METHOD>stringrequired

The endpoint's method.

<path>stringrequired

Its path.

octri docs endpoints discard <draftId>

Drops a draft without publishing it.

Arguments

<draftId>stringrequired

The draft.

octri docs endpoints publish

Writes every draft into the spec as a new version, then follows the pipeline that version starts. If the spec already matches the drafts, nothing is published.

Flags

--commit-to-githubbooleandefault: the project's docs setting

Commits the new spec back to the connected repository. --no-commit-to-github doesn't.

Examples

Draft an endpoint

bash
octri docs endpoints add GET /customers/{id}/notes --summary "List a customer's notes"
Output
✔ Drafting GET /customers/{id}/notes
✔ Drafted GET /customers/{id}/notes 6aedf5d4f8a05765fb1944e7
  octri docs endpoints publish: write the drafts into the spec

List drafts

bash
octri docs endpoints
Output
✔ Loading draft endpoints

Draft endpoints (1)
  CHANGE  ENDPOINT                   SUMMARY                  UPDATED  ID
  ──────  ─────────────────────────  ───────────────────────  ───────  ────────────────────────
  add     GET /customers/{id}/notes  List a customer's notes  0s ago   6aedf5d4f8a05765fb1944e7
  octri docs endpoints publish: write the drafts into the spec