-
-
Notifications
You must be signed in to change notification settings - Fork 6
/
api_definition.yml
326 lines (326 loc) · 7.78 KB
/
api_definition.yml
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
openapi: 3.0.1
info:
title: Cattle
description: 🐺 Platform to Run and Share Code.
contact:
email: hello@clivern.com
license:
name: Apache License 2.0
url: https://github.com/Clivern/Cattle/blob/main/LICENSE
version: 1.0.1
externalDocs:
description: Find out more about cattle
url: https://github.com/Clivern/Cattle
servers:
- url: https://cattle.sh/
paths:
/_health:
get:
tags:
- Liveness
summary: Get system health status
responses:
'200':
description: System is healthy
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResponse'
'500':
description: System is down
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResponse'
/_ready:
get:
tags:
- Readiness
summary: Get system readiness
responses:
'200':
description: System is ready to accept traffic
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResponse'
'500':
description: System not ready to accept traffic
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResponse'
/api/v1/execute:
post:
tags:
- Misc
summary: Execute a Code Item
requestBody:
description: The Code Request
content:
'*/*':
schema:
$ref: '#/components/schemas/CodeRequest'
required: true
responses:
'202':
description: Successful Operation
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'400':
description: Invalid Request
content: {}
'404':
description: Resource Not Found
content: {}
'500':
description: Internal Server Error
content: {}
x-codegen-request-body-name: body
/api/v1/code:
post:
tags:
- Code
summary: Create a Code Item
requestBody:
description: The Code Request
content:
'*/*':
schema:
$ref: '#/components/schemas/CodeRequest'
required: true
responses:
'202':
description: Successful Operation
content:
application/json:
schema:
$ref: '#/components/schemas/Code'
'400':
description: Invalid Request
content: {}
'404':
description: Resource Not Found
content: {}
'500':
description: Internal Server Error
content: {}
x-codegen-request-body-name: body
/api/v1/code/{id}:
get:
tags:
- Code
summary: Get a Code Item With ID (Slug or UUID)
parameters:
- name: id
in: path
description: The ID of the Code Item
required: true
schema:
type: string
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
$ref: '#/components/schemas/Code'
'400':
description: Invalid Request
content: {}
'404':
description: Resource Not Found
content: {}
'500':
description: Internal Server Error
content: {}
put:
tags:
- Code
summary: Update a Code Item With ID (UUID)
parameters:
- name: id
in: path
description: The ID of the Code Item
required: true
schema:
type: string
requestBody:
description: The Code Request
content:
'*/*':
schema:
$ref: '#/components/schemas/CodeRequest'
required: true
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
$ref: '#/components/schemas/Code'
'400':
description: Invalid Request
content: {}
'404':
description: Resource Not Found
content: {}
'500':
description: Internal Server Error
content: {}
x-codegen-request-body-name: body
delete:
tags:
- Code
summary: Delete a Code Item With ID (UUID)
parameters:
- name: id
in: path
description: The ID of the Code Item
required: true
schema:
type: string
responses:
'204':
description: Successful Operation
content: {}
'400':
description: Invalid Request
content: {}
'404':
description: Resource Not Found
content: {}
'500':
description: Internal Server Error
content: {}
/api/v1/code/{id}/run:
post:
tags:
- Code
summary: Run a Code Item With ID (UUID)
parameters:
- name: id
in: path
description: The ID of the Code Item
required: true
schema:
type: string
responses:
'202':
description: Successful Operation
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'400':
description: Invalid Request
content: {}
'404':
description: Resource Not Found
content: {}
'500':
description: Internal Server Error
content: {}
/api/v1/task/{id}:
get:
tags:
- Task
summary: Get a Task by ID (UUID)
parameters:
- name: id
in: path
description: The UUID of the task
required: true
schema:
type: string
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
$ref: '#/components/schemas/FinalTask'
'400':
description: Invalid Request
content: {}
'404':
description: Task Not Found
content: {}
'500':
description: Internal Server Error
content: {}
components:
schemas:
HealthResponse:
type: object
properties:
status:
type: string
errorMessage:
type: string
Task:
type: object
properties:
id:
type: integer
format: int64
status:
type: string
createdAt:
type: string
updatedAt:
type: string
FinalTask:
type: object
properties:
id:
type: integer
format: int64
result:
type: object
properties:
output:
type: string
build_time:
type: string
execution_time:
type: string
status:
type: string
createdAt:
type: string
updatedAt:
type: string
CodeRequest:
type: object
properties:
language:
type: string
version:
type: string
content:
type: string
Code:
type: object
properties:
id:
type: integer
format: int
uuid:
type: string
slug:
type: string
token:
type: string
language:
type: string
version:
type: string
content:
type: string
createdAt:
type: string
updatedAt:
type: string