# AUTO-GENERATED tier-A mirror spec — do not edit.
# Source: openapi/runtime/metadata-schemas.yaml (runtime 0.124.0)
#  + policy: openapi/mirror-policies/metadata-schemas.json
# Regenerate: node scripts/generate-mirror-specs.mjs
openapi: 3.0.3
info:
  title: naturali.ai — Metadata Schemas API
  version: 1.0.0
  description: >-
    Metadata schemas: what a resource's `metadata` must satisfy in a project — one JSON Schema per
    resource type and selector, compiled when declared and enforced by the resource's own write
    path, so a document write that violates the declaration in force is refused whichever route it
    came through. A fully runtime-backed module — this spec is generated verbatim from the runtime's
    own, re-rooted under /v1/projects/{project_id}. The project in the path is authorized by
    naturali and enforced upstream by the project's scoped credential.


    This module mirrors the upstream runtime verbatim (tier A): paths are the runtime's own
    re-rooted under /v1/projects/{project_id}, and every field, method, status code and error shape
    passes through unchanged. Errors raised by the runtime arrive in its envelope; errors raised by
    naturali itself (authentication, project resolution, an unreachable runtime) use naturali's.
  contact:
    name: naturali.ai
    url: https://naturali.ai
servers:
  - url: "{baseUrl}"
    description: Host of your naturali.ai deployment; every path carries the /v1 prefix.
    variables:
      baseUrl:
        description: Base host URL.
        default: https://api.naturali.ai
tags:
  - name: Metadata Schemas
    description: Declare the structure a resource's metadata must satisfy
security:
  - bearerAuth: []
  - oauth2:
      - mcp:access
paths:
  /v1/projects/{project_id}/metadata-schemas:
    get:
      tags:
        - Metadata Schemas
      summary: List metadata schemas
      description: Returns the declarations in scope, oldest first. `resource_type` narrows them to one
        governed resource.
      operationId: listMetadataSchemas
      parameters:
        - name: resource_type
          in: query
          required: false
          description: Return only the declarations governing this resource.
          schema:
            type: string
            enum:
              - document
        - $ref: "#/components/parameters/Limit"
        - $ref: "#/components/parameters/Cursor"
      responses:
        "200":
          description: The declarations in scope
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/Page"
                  - properties:
                      data:
                        type: array
                        items:
                          $ref: "#/components/schemas/MetadataSchemaRecord"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          $ref: "#/components/responses/ProjectNotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
    post:
      tags:
        - Metadata Schemas
      summary: Declare a metadata schema
      description: >
        Declares what `metadata` must satisfy for one resource type under one selector. A document
        is selected by `path_prefix`, matched on a path boundary: `/reports` covers
        `/reports/q1.txt` and never `/reports-archive/q1.txt`.


        The schema is compiled here, so one JSON Schema cannot parse is refused rather than stored —
        a stored one would be a rule that silently governs nothing. One selector has one schema per
        resource type; a second declaration of the same one is `409 NAME_CONFLICT`. The reserved
        root `/.system` cannot be governed: a platform-written document carries no caller metadata.
      operationId: createMetadataSchema
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - resource_type
                - schema
              properties:
                resource_type:
                  type: string
                  enum:
                    - document
                  description: The resource whose metadata this declaration governs. A type appears here once its
                    write path reads the registry, so a declaration always has a door that enforces
                    it.
                  example: document
                path_prefix:
                  type: string
                  description: "The selector a `document` declaration must carry: the directory it governs."
                  example: /reports
                schema:
                  type: object
                  description: A JSON Schema. Its keywords are its own vocabulary and are stored as written.
                  example:
                    type: object
                    required:
                      - quarter
                    properties:
                      quarter:
                        type: string
      responses:
        "201":
          description: The declaration
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MetadataSchemaRecord"
        "400":
          description: Bad Request — unknown `resource_type`, a missing or unusable selector, the reserved
            root, or a schema that is not valid JSON Schema
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          $ref: "#/components/responses/ProjectNotFound"
        "409":
          description: Conflict — this selector is already declared for this type
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "413":
          $ref: "#/components/responses/PayloadTooLarge"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
        "502":
          $ref: "#/components/responses/AdmissionUnavailable"
        4XX:
          $ref: "#/components/responses/AdmissionRefused"
    parameters:
      - $ref: "#/components/parameters/ProjectId"
  /v1/projects/{project_id}/metadata-schemas/validate:
    post:
      tags:
        - Metadata Schemas
      summary: Check metadata against what is declared
      description: >
        Answers what a write would be told, without writing: a caller preparing a batch learns which
        declaration would refuse it, and why, before it sends anything.


        It reports; it does not enforce. The refusal itself lives in each resource's own write path,
        because a check a writer has to call is advisory and the writer who skips it is the one the
        rule exists for.
      operationId: validateMetadata
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - path
              properties:
                path:
                  type: string
                  description: The path the document would be filed at, which decides which declaration governs it.
                  example: /reports/q1.txt
                metadata:
                  description: The bag to judge. Absent or `null` is judged as an empty bag.
                  example:
                    quarter: Q1
                  allOf:
                    - $ref: "#/components/schemas/NullableMetadataBag"
      responses:
        "200":
          description: The verdict
          content:
            application/json:
              schema:
                type: object
                required:
                  - valid
                  - resource_type
                  - metadata_schema_id
                  - path_prefix
                  - error
                properties:
                  valid:
                    type: boolean
                    description: Whether a write of this metadata at this path would be accepted.
                    example: false
                  resource_type:
                    type: string
                    enum:
                      - document
                    example: document
                  metadata_schema_id:
                    type: string
                    nullable: true
                    description: The declaration that would refuse it; `null` when the metadata is accepted or nothing
                      governs the path.
                    example: mdschema_V1StGXR8Z5jdHi6B
                  path_prefix:
                    type: string
                    nullable: true
                    description: The refusing declaration's selector.
                    example: /reports
                  error:
                    allOf:
                      - $ref: "#/components/schemas/StoredError"
                    nullable: true
                    description: The error the write would be refused with; its message names what the metadata
                      violates, field by field.
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          $ref: "#/components/responses/ProjectNotFound"
        "413":
          $ref: "#/components/responses/PayloadTooLarge"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
        "502":
          $ref: "#/components/responses/AdmissionUnavailable"
        4XX:
          $ref: "#/components/responses/AdmissionRefused"
    parameters:
      - $ref: "#/components/parameters/ProjectId"
  /v1/projects/{project_id}/metadata-schemas/{metadata_schema_id}:
    get:
      tags:
        - Metadata Schemas
      summary: Get a metadata schema
      description: Returns one declaration by id.
      operationId: getMetadataSchema
      parameters:
        - name: metadata_schema_id
          in: path
          required: true
          schema:
            type: string
            example: mdschema_V1StGXR8Z5jdHi6B
      responses:
        "200":
          description: The declaration
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MetadataSchemaRecord"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          description: Not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
    patch:
      tags:
        - Metadata Schemas
      summary: Update a metadata schema
      description: "Changes the schema, the selector, or both. `resource_type` is fixed at creation: it
        decides the selector's spelling and which write path reads the row, so changing it would
        silently repoint the declaration at a different door — delete it and declare again instead."
      operationId: updateMetadataSchema
      parameters:
        - name: metadata_schema_id
          in: path
          required: true
          schema:
            type: string
            example: mdschema_V1StGXR8Z5jdHi6B
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                path_prefix:
                  type: string
                  description: The declaration's new selector.
                  example: /reports/quarterly
                schema:
                  type: object
                  description: Replaces the declared JSON Schema.
                  example:
                    type: object
                    required:
                      - quarter
                      - owner
                    properties:
                      quarter:
                        type: string
                      owner:
                        type: string
      responses:
        "200":
          description: The declaration
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MetadataSchemaRecord"
        "400":
          description: Bad Request — an unusable selector, or a schema that is not valid JSON Schema
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          description: Not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "409":
          description: Conflict — this selector is already declared for this type
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "413":
          $ref: "#/components/responses/PayloadTooLarge"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
        "502":
          $ref: "#/components/responses/AdmissionUnavailable"
        4XX:
          $ref: "#/components/responses/AdmissionRefused"
    delete:
      tags:
        - Metadata Schemas
      summary: Delete a metadata schema
      description: Removes the declaration. Documents already stored keep the metadata they hold — the
        rule governed writes, not rows.
      operationId: deleteMetadataSchema
      parameters:
        - name: metadata_schema_id
          in: path
          required: true
          schema:
            type: string
            example: mdschema_V1StGXR8Z5jdHi6B
      responses:
        "204":
          description: Deleted
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          description: Not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
        "502":
          $ref: "#/components/responses/AdmissionUnavailable"
        4XX:
          $ref: "#/components/responses/AdmissionRefused"
    parameters:
      - $ref: "#/components/parameters/ProjectId"
components:
  schemas:
    MetadataSchemaRecord:
      type: object
      properties:
        id:
          type: string
          description: Public ID (mdschema_ prefix)
          example: mdschema_V1StGXR8Z5jdHi6B
        project_id:
          x-naturali-ref: projects
          type: string
          example: proj_V1StGXR8Z5jdHi6B
        resource_type:
          type: string
          enum:
            - document
          description: The resource whose metadata this declaration governs.
          example: document
        path_prefix:
          type: string
          description: The selector, in the field its resource type is addressed by. A document's is the
            directory it is filed under.
          example: /reports
        schema:
          type: object
          description: The declared JSON Schema, as written.
          example:
            type: object
            required:
              - quarter
            properties:
              quarter:
                type: string
        created_at:
          type: string
          format: date-time
          example: 2024-01-01T00:00:00.000Z
        updated_at:
          type: string
          format: date-time
          example: 2024-01-01T00:00:00.000Z
    Page:
      type: object
      description: One page of a list. Rows inserted or removed between two calls neither repeat nor skip
        a row on the next page.
      required:
        - data
        - next_cursor
      properties:
        data:
          type: array
          description: This page's items, in the list's order.
          items: {}
        next_cursor:
          type: string
          nullable: true
          description: Pass as `cursor` to fetch the next page; `null` on the last page.
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          description: Structured error. Every error response uses this shape, so `code` can be read without
            first checking the type of `error`.
          required:
            - code
            - message
            - hint
          properties:
            code:
              type: string
              pattern: ^[A-Z][A-Z0-9_]*$
              description: Machine-readable error code, UPPER_SNAKE whether naturali or the runtime raises it.
              example: FORBIDDEN
            message:
              type: string
              description: Human-readable explanation.
              example: Your role in this project does not carry this action.
            hint:
              type: string
              description: What to do about it, naming the routes of this API to call. For people and agents; it
                may change, so branch on `code`.
              example: Use a credential whose scope includes this action, or ask a project `admin` or `owner` to
                act; the caller's role or key excludes it.
            meta:
              type: object
              additionalProperties: true
              description: Structured context, such as the `resource` and `limit` of a `PLAN_LIMIT_REACHED`.
    NullableMetadataBag:
      type: object
      nullable: true
      description: "A `MetadataBag` on a request field where `null` is meaningful: a full-replacement
        update that clears the bag. A record whose bag is unset leaves the field out."
      example:
        author: John
        revision: 2
    StoredError:
      type: object
      description: Why a resource's work failed, in the shape of an error response's `error` without
        `hint`. Every `error` field a resource records carries it, so `code` can be read without
        first checking the type of `error`.
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: A key from the server's ERROR_CODES registry, documented on the Error Codes page.
            `INTERNAL_ERROR`, with the message `Internal Server Error`, records an unexpected
            failure whose detail reaches the server log only.
          example: AI_PROVIDER_ERROR
        message:
          type: string
          example: "Provider returned 402: insufficient credits"
        meta:
          type: object
          additionalProperties: true
          description: The failure's own structured context, when it names any.
  parameters:
    ProjectId:
      name: project_id
      in: path
      required: true
      description: Project public ID (proj_ prefix).
      schema:
        type: string
        example: proj_V1StGXR8Z5jdHi6B
    Limit:
      name: limit
      in: query
      required: false
      description: Results per page, 1 to 100 (default 50). Above 100 it is clamped; below 1 or not an
        integer it is `400`.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
    Cursor:
      name: cursor
      in: query
      required: false
      description: The previous page's `next_cursor`; omit it for the first page. A cursor this list did
        not issue is `400`.
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A naturali API key (nat_sk_…) or a session JWT.
    oauth2:
      type: oauth2
      description: "A connected app's OAuth access token, issued by this API's authorization server
        (discovery: /.well-known/oauth-authorization-server). Its one scope carries every operation,
        confined to the projects the user chose when approving the app."
      flows:
        authorizationCode:
          authorizationUrl: https://api.naturali.ai/authorize
          tokenUrl: https://api.naturali.ai/token
          refreshUrl: https://api.naturali.ai/token
          scopes:
            mcp:access: Every operation this API serves, on the projects the grant covers.
  responses:
    BadRequest:
      description: The request was malformed or failed validation.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    TooManyRequests:
      description: "`QUOTA_EXCEEDED` — a `requests` quota on the calling API key or its project is spent
        for the window; `Retry-After` says when it reopens"
      headers:
        Retry-After:
          description: Seconds until the quota window admits a request again
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    InternalError:
      description: Unexpected server error — `INTERNAL_ERROR`, with the raw message never forwarded
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    PayloadTooLarge:
      description: "`REQUEST_REJECTED` — the request body is over the size the body parser accepts"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    AdmissionUnavailable:
      description: The deployment's admission service is asked about this write and did not answer —
        `ADMISSION_UNAVAILABLE`; the write did not happen
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    AdmissionRefused:
      description: The deployment's admission service refused this write — answered under the service's
        own `4xx` status, with its `code` (matching `^[A-Za-z_][A-Za-z0-9_]{0,63}$`, not necessarily
        an `ERROR_CODES` key), `message` and `meta`; the write did not happen. A status this
        operation also declares on its own is documented there
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    ProjectNotFound:
      description: The project does not exist or the caller is not a member of it (`RESOURCE_NOT_FOUND`).
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
