sourceos-spec/openapi.agent-plane.patch.yaml at main · SourceOS-Linux/sourceos-spec · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# 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.