openapi.agent-plane.patch.yaml

# Additive OpenAPI patch fragment for the agent-plane schema family.
# Merge this file into openapi.yaml at build time.
# All operations require bearerAuth (inherited from the base spec security requirement).

tags:
  - name: Agent Plane
    description: Agent sessions, execution decisions, skills, memory, and session receipts

paths:
  /v2/sessions:
    post:
      operationId: upsertAgentSession
      summary: Upsert an AgentSession
      description: Creates or updates an autonomous agent session record with its role, mode, substrate, and execution surface. Idempotent on `id`.
      tags: [Agent Plane]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: './schemas/AgentSession.json' }
      responses:
        '200':
          description: AgentSession created or updated successfully.
        '400':
          description: Request body is malformed JSON.
        '401':
          description: Missing or invalid authentication token.
        '403':
          description: Authenticated subject is not permitted to upsert sessions.
        '422':
          description: Request body is valid JSON but fails schema validation.

  /v2/execution/decide:
    post:
      operationId: decideExecution
      summary: Record an ExecutionDecision
      description: |
        Persists an immutable execution decision (allow, deny, ask, defer, or rewrite) made by
        an agent during a session. Returns the stored ExecutionDecision with its assigned URN.
        Idempotent on `id`.
      tags: [Agent Plane]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: './schemas/ExecutionDecision.json' }
      responses:
        '200':
          description: ExecutionDecision recorded and returned.
          content:
            application/json:
              schema: { $ref: './schemas/ExecutionDecision.json' }
        '400':
          description: Request body is malformed JSON.
        '401':
          description: Missing or invalid authentication token.
        '403':
          description: Authenticated subject is not permitted to record execution decisions.
        '422':
          description: Request body is valid JSON but fails schema validation.

  /v2/skills:
    post:
      operationId: upsertSkillManifest
      summary: Upsert a SkillManifest
      description: Creates or updates an agent skill manifest with its activation rules, requirements, and policy bindings. Idempotent on `id`.
      tags: [Agent Plane]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: './schemas/SkillManifest.json' }
      responses:
        '200':
          description: SkillManifest created or updated successfully.
        '400':
          description: Request body is malformed JSON.
        '401':
          description: Missing or invalid authentication token.
        '403':
          description: Authenticated subject is not permitted to upsert skill manifests.
        '422':
          description: Request body is valid JSON but fails schema validation.

  /v2/memory:
    post:
      operationId: upsertMemoryEntry
      summary: Upsert a MemoryEntry
      description: Creates or updates a persistent agent memory entry of kind rule, learned, or recap. Idempotent on `id`.
      tags: [Agent Plane]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: './schemas/MemoryEntry.json' }
      responses:
        '200':
          description: MemoryEntry created or updated successfully.
        '400':
          description: Request body is malformed JSON.
        '401':
          description: Missing or invalid authentication token.
        '403':
          description: Authenticated subject is not permitted to upsert memory entries.
        '422':
          description: Request body is valid JSON but fails schema validation.

  /v2/receipts/session:
    post:
      operationId: recordSessionReceipt
      summary: Record a SessionReceipt
      description: Persists the final outcome record for a completed AgentSession, including all produced artifacts and gate results. Idempotent on `id`.
      tags: [Agent Plane]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: './schemas/SessionReceipt.json' }
      responses:
        '200':
          description: SessionReceipt recorded successfully.
        '400':
          description: Request body is malformed JSON.
        '401':
          description: Missing or invalid authentication token.
        '403':
          description: Authenticated subject is not permitted to record session receipts.
        '422':
          description: Request body is valid JSON but fails schema validation.

  /v2/artifacts/manifest:
    post:
      operationId: upsertArtifactManifest
      summary: Upsert an ArtifactManifest
      description: Creates or updates a shell/document artifact manifest for a derived artifact such as a PDF.
      tags: [Agent Plane]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: './schemas/ArtifactManifest.json' }
      responses:
        '200':
          description: ArtifactManifest recorded successfully.

  /v2/artifacts/signature:
    post:
      operationId: recordSignedArtifact
      summary: Record a SignedArtifact
      description: Persists the signature metadata associated with a signed artifact.
      tags: [Agent Plane]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: './schemas/SignedArtifact.json' }
      responses:
        '200':
          description: SignedArtifact recorded successfully.

  /v2/artifacts/validation:
    post:
      operationId: recordPdfValidationReport
      summary: Record a PdfValidationReport
      description: Persists a PDF validation report for an artifact.
      tags: [Agent Plane]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: './schemas/PdfValidationReport.json' }
      responses:
        '200':
          description: PdfValidationReport recorded successfully.

  /v2/annotations/export:
    post:
      operationId: recordAnnotationExport
      summary: Record an AnnotationExport
      description: Persists an annotation export from PDF or HTML review surfaces.
      tags: [Agent Plane]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: './schemas/AnnotationExport.json' }
      responses:
        '200':
          description: AnnotationExport recorded successfully.

  /v2/runs/report:
    post:
      operationId: recordRunReport
      summary: Record a RunReport
      description: Persists a run report describing workflow artifacts and publication outputs.
      tags: [Agent Plane]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: './schemas/RunReport.json' }
      responses:
        '200':
          description: RunReport recorded successfully.

  /v2/diagnostics/noether:
    post:
      operationId: recordNoetherDiagnostic
      summary: Record a NoetherDiagnostic
      description: Persists a Noether diagnostic reading for a model layer or run.
      tags: [Agent Plane]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: './schemas/NoetherDiagnostic.json' }
      responses:
        '200':
          description: NoetherDiagnostic recorded successfully.

  /v2/publish/decisions:
    post:
      operationId: recordPublishDecision
      summary: Record a PublishDecision
      description: Persists a publish decision across knowledge, value, and ecosystem openness lanes.
      tags: [Agent Plane]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: './schemas/PublishDecision.json' }
      responses:
        '200':
          description: PublishDecision recorded successfully.

  /v2/mirror/receipts:
    post:
      operationId: recordMirrorReceipt
      summary: Record a MirrorReceipt
      description: Persists a receipt for an artifact mirrored to a downstream channel.
      tags: [Agent Plane]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: './schemas/MirrorReceipt.json' }
      responses:
        '200':
          description: MirrorReceipt recorded successfully.