Roboto Pages API

openapi: 3.2.0
info:
  description: 'Read-only JSON API over the Roboto Docs documentation: Documentation for the Roboto platform.


    Every operation is public and needs no authentication. Errors are RFC 9457 problem details (`application/problem+json`) with a stable `code`, a `detail`, and a `resolution` hint.'
  title: Roboto Docs Pages API
  version: 2.2.4
  x-generator: blume@2.2.4
servers:
- description: Roboto Docs
  url: https://www.roboto.ai/docs
security: []
tags:
- description: Enumerate and read documentation pages.
  name: Pages
paths:
  /api/docs/pages.json:
    get:
      description: Every documentation page with its route, title, description, content type, locale, facets, and the URLs of its rendered, Markdown, and JSON forms. Unfiltered; on a versioned site every version is listed with its `version`. Use it to enumerate the docs or to find a page when search is too narrow.
      operationId: listPages
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagesIndex'
          description: The page index.
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: An error, as problem details.
      summary: List every page
      tags:
      - Pages
  /api/docs/pages/{route}.json:
    get:
      description: 'A single page as JSON: its index entry plus the page''s agent Markdown (frontmatter included, components downleveled to plain Markdown). Take `route` from `listPages` or `searchDocs`.'
      operationId: getPage
      parameters:
      - description: The page route without its leading slash (`guides/install`), or `index` for the home page. May contain slashes.
        in: path
        name: route
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page'
          description: The page.
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: No page has that route.
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: An error, as problem details.
      summary: Get a page as JSON
      tags:
      - Pages
components:
  schemas:
    Page:
      allOf:
      - $ref: '#/components/schemas/PageSummary'
      - properties:
          markdown:
            description: 'The page as agent Markdown: frontmatter included, components downleveled to plain Markdown.'
            type: string
        required:
        - markdown
        type: object
      description: A page's index entry plus its full Markdown body.
    PageSummary:
      properties:
        contentType:
          description: The page's content type (frontmatter `type`).
          type: string
        description:
          type: string
        facets:
          additionalProperties:
            type: string
          description: Facet values the site declares for the page's content type (`content.types.<type>.facets`), key → value.
          type: object
        json:
          description: This page's JSON representation (the `getPage` operation).
          format: uri-reference
          type: string
        lastModified:
          description: ISO 8601 last-modified date, when known.
          type:
          - string
          - 'null'
        locale:
          description: The page's locale code.
          type: string
        markdownUrl:
          description: The page's raw-Markdown mirror (the `getPageMarkdown` operation).
          format: uri-reference
          type: string
        route:
          description: The page's route (`/guides/install`); the key every other operation takes.
          type: string
        title:
          type: string
        url:
          description: Where the rendered page is served.
          format: uri-reference
          type: string
        version:
          description: 'Docs version the page belongs to on a versioned site: `""` for the current docs, else an archived version id. Absent on unversioned sites.'
          type: string
      required:
      - contentType
      - json
      - lastModified
      - locale
      - markdownUrl
      - route
      - title
      - url
      type: object
    PagesIndex:
      properties:
        count:
          type: integer
        generator:
          description: The Blume version that built the site.
          type: string
        pages:
          items:
            $ref: '#/components/schemas/PageSummary'
          type: array
        site:
          type:
          - string
          - 'null'
      required:
      - count
      - generator
      - pages
      - site
      type: object
    Problem:
      description: RFC 9457 problem details, with a stable code and a resolution hint.
      properties:
        code:
          description: Stable error code (e.g. `PAGE_NOT_FOUND`).
          type: string
        detail:
          description: Human-readable explanation of this occurrence.
          type: string
        instance:
          description: The request path the problem occurred on.
          type: string
        links:
          description: Recovery links, when there is somewhere useful to go.
          items:
            properties:
              href:
                type: string
              label:
                type: string
            required:
            - href
            - label
            type: object
          type: array
        resolution:
          description: What to do next.
          type: string
        status:
          type: integer
        title:
          type: string
        type:
          description: Problem type URI; `about:blank` by default.
          type: string
      required:
      - code
      - detail
      - resolution
      - status
      - title
      - type
      type: object
externalDocs:
  description: Roboto Docs documentation
  url: https://www.roboto.ai/docs