moxiedocs-com Check Drift API

openapi: 3.2.0
info:
  title: Moxie Docs Check Drift API
  version: '1'
  summary: Read a repository's generated documentation and check whether a set of changed files has documentation drift.
  description: Free to start on one repo, no card required. PR checks that flag doc gaps, living docs re-checked on every merge, MCP context for AI agents, hosted public knowledgebases, and Friday Cleanup PRs from GitHub.
  contact:
    name: jackalope.digital
    email: contact@moxiedocs.com
    url: https://jackalope.digital
  license:
    name: Proprietary
    url: https://moxiedocs.com/terms
servers:
- url: https://moxiedocs.com/api/v1
  description: Production
security:
- bearerAuth: []
tags:
- name: Check Drift
paths:
  /check-drift:
    post:
      operationId: checkDocumentationDrift
      summary: Check whether changed files have documentation drift
      description: Runs the same doc-impact analysis Moxie Docs uses on pull requests against an arbitrary list of changed file paths, and reports whether any generated doc is now stale or any changed path is undocumented.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - changedPaths
              properties:
                repository:
                  type: string
                  description: '`owner/name` (case-insensitive). Required when the token has access to more than one repository.'
                  example: acme/api
                changedPaths:
                  type: array
                  description: Repository-relative paths changed in the commit or PR being checked.
                  items:
                    type: string
                  minItems: 1
                  example:
                  - apps/web/src/app/api/billing/webhook/route.ts
      responses:
        '200':
          description: Drift analysis result.
          content:
            application/json:
              schema:
                type: object
                required:
                - hasDrift
                - message
                - details
                properties:
                  hasDrift:
                    type: boolean
                  message:
                    type: string
                  details:
                    type: array
                    items:
                      type: string
        '400':
          description: Missing `changedPaths`, or missing/ambiguous `repository`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded. Retry after the `Retry-After` header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Check Drift
components:
  schemas:
    Error:
      type: object
      required:
      - error
      - message
      properties:
        error:
          type: string
          description: Machine-readable error code, e.g. `Unauthorized`.
        message:
          type: string
          description: Human-readable resolution hint.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Repository-scoped MCP token with the `context:read` scope, created from the Moxie Docs dashboard (Settings -> MCP tokens) - no sales call required, available on every plan including the free tier.