craaft Version API

openapi: 3.2.0
info:
  title: Craaft Version API
  version: 1.0.0
  description: 'Personal-access-token API for Craaft. See `docs/api.md` for the

    narrative guide, rate limits, and worked examples.'
  contact:
    name: Craaft
servers:
- url: https://craaft.io/api/v1
  description: Production
- url: http://localhost:8080/api/v1
  description: Local
security:
- bearerAuth: []
tags:
- name: Version
paths:
  /version:
    get:
      summary: Build information for the running server
      operationId: getVersion
      description: 'Unauthenticated so monitoring can poll it without managing

        credentials, and cheap enough to use as a liveness probe: it touches

        neither the database nor the session store. Use it to confirm which

        artifact is live without shelling into a container.'
      security: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionInfo'
      tags:
      - Version
components:
  schemas:
    VersionInfo:
      type: object
      description: 'Build-info triplet stamped in at link time via `-X` ldflags. A plain

        `go run` leaves the defaults in place, so `dev` / `unknown` means an

        unstamped build rather than a broken one.

        '
      required:
      - version
      - commit
      - buildTime
      properties:
        version:
          type: string
          description: Release tag, or `dev` when unstamped
        commit:
          type: string
          description: Short commit SHA, or `unknown` when unstamped
        buildTime:
          type: string
          description: RFC3339 build timestamp, or `unknown` when unstamped
  securitySchemes:
    sessionAuth:
      type: apiKey
      in: cookie
      name: craaft_session
      description: 'Browser session cookie (`__Host-craaft_session` in production,

        `craaft_session` in dev), set at sign-in. Not obtainable through

        this API - it''s here only so the handful of session-only routes

        below (the OAuth consent screen''s own endpoints, connected-apps

        management) can be marked accurately. They reject both bearer

        schemes with a 403.

        '
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: cra_<24 base64url chars>
      description: 'Two token schemes, same permissions. `cra_<24 base64url chars>` is a

        personal access token minted in Settings, doesn''t expire on its own,

        and is revoked from the same page. `cro_<32 base64url chars>` is an

        OAuth access token issued to an OAuth client (an MCP client such as

        Claude) via the authorization-code-with-PKCE flow; it expires after

        1 hour and the client refreshes it. Either token authenticates as

        the user who authorized it, with that user''s exact permissions.


        A token can be read-only: a personal access token created with

        access `read`, or an OAuth grant with scope `craaft:read`. A

        read-only token can send GET, HEAD and OPTIONS; any other method

        gets `403` with "this token is read-only; this request needs a

        token with read and write access", before the request is handled.


        A token can also be limited to chosen boards. Other boards then

        behave as if they don''t exist (`404`, or left out of lists), and

        `POST /projects`, `/imports`, `/members` and `/invitations` answer

        `403` with "this token is limited to some boards; this request

        needs a token for all boards".


        OAuth clients discover every endpoint they need - authorization,

        token, dynamic client registration, revocation - at

        `/.well-known/oauth-authorization-server` (RFC 8414); they don''t

        need to be told the URLs out of band.

        '