Octri

docs show

Prints one endpoint page: its title, then what's stored for it. An endpoint page holds structured content, such as its description and parameters, so that prints as JSON. Take the slug from docs pages.

bash
octri docs show <slug>

Arguments

<slug>stringrequired

The page's slug, such as get-customers.

Examples

Show a page

bash
octri docs show get-customers
Output
✔ Loading get-customers
── get-customers ───────────────────────────────────────────────────────────────────────────────────
{
  "page": {
    "id": "6acd4f5218c2528b59327457",
    "projectId": "6acd4f5218c2528b5932744f",
    "specId": "6acd4f5218c2528b59327451",
    "type": "endpoint",
    "slug": "get-customers",
    "title": "List customers",
    "generationStatus": "template",
    "viewCount": 1,
    "content": {
      "description": "Newest first. Page with `starting_after`, using the id of the last customer on the previous page.",
  …
  • octri docs pages: List, regenerate, retitle and publish the endpoint pages generated from your spec.