sourceos-spec/openapi.fog.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
# Additive OpenAPI patch fragment for the Fog Layer (FogVault + FogCompute).
# Merge this file into openapi.yaml at build time.
# All operations require bearerAuth (inherited from the base spec security requirement).

tags:
  - name: Fog Layer
    description: FogVault topic/storage contracts and FogCompute offers, work orders, and receipts

paths:
  /v2/fog/topics:
    post:
      operationId: upsertFogTopic
      summary: Upsert a Fog topic definition
      description: Creates or updates a FogVault Topic contract. Idempotent on `id`.
      tags: [Fog Layer]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: './schemas/Topic.json' }
      responses:
        '200':
          description: Topic 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 fog topics.
        '422':
          description: Request body is valid JSON but fails schema validation.

  /v2/fog/offers:
    post:
      operationId: upsertFogOffer
      summary: Upsert a Fog compute offer
      description: Creates or updates a FogCompute Offer. Idempotent on `id`.
      tags: [Fog Layer]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: './schemas/Offer.json' }
      responses:
        '200':
          description: Offer 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 fog offers.
        '422':
          description: Request body is valid JSON but fails schema validation.

  /v2/fog/workorders:
    post:
      operationId: submitFogWorkOrder
      summary: Submit a Fog work order
      description: Records a FogCompute WorkOrder. Idempotent on `id`.
      tags: [Fog Layer]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: './schemas/WorkOrder.json' }
      responses:
        '200':
          description: WorkOrder recorded successfully.
        '400':
          description: Request body is malformed JSON.
        '401':
          description: Missing or invalid authentication token.
        '403':
          description: Authenticated subject is not permitted to submit fog work orders.
        '422':
          description: Request body is valid JSON but fails schema validation.

  /v2/fog/receipts:
    post:
      operationId: recordFogUsageReceipt
      summary: Record a Fog usage receipt
      description: Records a FogCompute UsageReceipt. Idempotent on `id`.
      tags: [Fog Layer]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: './schemas/UsageReceipt.json' }
      responses:
        '200':
          description: UsageReceipt 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 fog receipts.
        '422':
          description: Request body is valid JSON but fails schema validation.

  /v2/fog/settlements:
    post:
      operationId: recordFogSettlementEvent
      summary: Record a Fog settlement event
      description: Records an optional SettlementEvent that maps a usage receipt to a settlement backend.
      tags: [Fog Layer]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: './schemas/SettlementEvent.json' }
      responses:
        '200':
          description: SettlementEvent 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 fog settlements.
        '422':
          description: Request body is valid JSON but fails schema validation.