-
Notifications
You must be signed in to change notification settings - Fork 0
/
openai.yaml
338 lines (338 loc) · 8.82 KB
/
openai.yaml
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
327
328
329
330
331
332
333
334
335
336
337
338
openapi: 3.0.0
info:
title: Filament Tracker API
description: API to manage filament spools for 3D printers
version: "1.0"
servers:
- url: http://localhost:3000
description: Local server
paths:
/spools:
get:
summary: Get a list of all non-archived spools with their usage history
responses:
'200':
description: A list of spools successfully retrieved
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SpoolWithHistory'
post:
summary: Add a new spool
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NewSpoolRequest'
responses:
'201':
description: Spool created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/NewSpoolResponse'
/spools/{id}:
parameters:
- name: id
in: path
required: true
description: The unique identifier of the spool
schema:
type: integer
get:
summary: Get details for a specific spool including usage history
responses:
'200':
description: Spool details successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/SpoolWithHistory'
'404':
description: Spool not found
put:
summary: Update details for a specific spool
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSpoolRequest'
responses:
'200':
description: Spool updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSpoolResponse'
delete:
summary: Delete a specific spool
responses:
'200':
description: Spool deleted successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
/spools/use/{id}:
parameters:
- name: id
in: path
required: true
description: The unique identifier of the spool to use
schema:
type: integer
post:
summary: Record usage of filament for a specific spool
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UseSpoolRequest'
responses:
'200':
description: Filament usage recorded successfully
content:
application/json:
schema:
$ref: '#/components/schemas/UseSpoolResponse'
'400':
description: Not enough filament
/spools/use/top:
post:
summary: Record usage of filament for the top spool in sort order
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UseSpoolRequest'
responses:
'200':
description: Filament usage recorded successfully
content:
application/json:
schema:
$ref: '#/components/schemas/UseSpoolResponse'
'400':
description: Not enough filament in the top spool
/spools/top:
get:
summary: Get details of the top spool in sort order
responses:
'200':
description: Top spool details successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/SpoolWithHistory'
'404':
description: Top spool not found
/spools/archived:
get:
summary: Get a list of all archived spools with their usage history
responses:
'200':
description: A list of archived spools successfully retrieved
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SpoolWithHistory'
/spools/sort/{id}:
parameters:
- name: id
in: path
required: true
description: The unique identifier of the spool to sort
schema:
type: integer
put:
summary: Update the sort order of a specific spool
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SortSpoolRequest'
responses:
'200':
description: Spool sort order updated successfully
/spools/archive/{id}:
parameters:
- name: id
in: path
required: true
description: The unique identifier of the spool to archive/unarchive
schema:
type: integer
put:
summary: Update the archive status of a specific spool
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ArchiveSpoolRequest'
responses:
'200':
description: Spool archive status updated successfully
/spools/{id}/history:
parameters:
- name: id
in: path
required: true
description: The unique identifier of the spool to get history for
schema:
type: integer
get:
summary: Get usage history for a specific spool
responses:
'200':
description: Spool usage history retrieved successfully
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UsageHistoryEntry'
/spools/{spoolId}/history/{entryId}:
parameters:
- name: spoolId
in: path
required: true
description: The unique identifier of the spool
schema:
type: integer
- name: entryId
in: path
required: true
description: The unique identifier of the usage history entry
schema:
type: integer
put:
summary: Update a usage entry for a spool
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUsageHistoryEntryRequest'
responses:
'200':
description: Spool usage history entry updated successfully
delete:
summary: Delete a usage entry for a spool
responses:
'200':
description: Spool usage history entry deleted successfully
components:
schemas:
SpoolWithHistory:
type: object
properties:
id:
type: integer
name:
type: string
color:
type: string
initialWeight:
type: integer
currentWeight:
type: integer
sort_order:
type: integer
is_archived:
type: integer
usage_history:
type: array
items:
$ref: '#/components/schemas/UsageHistoryEntry'
UsageHistoryEntry:
type: object
properties:
id:
type: integer
spool_id:
type: integer
used_amount:
type: integer
timestamp:
type: string
format: date-time
note:
type: string
NewSpoolRequest:
type: object
properties:
name:
type: string
color:
type: string
initialWeight:
type: integer
NewSpoolResponse:
type: object
properties:
id:
type: integer
sortOrder:
type: integer
UpdateSpoolRequest:
type: object
properties:
name:
type: string
color:
type: string
currentWeight:
type: integer
UpdateSpoolResponse:
type: object
properties:
message:
type: string
spool:
$ref: '#/components/schemas/SpoolWithHistory'
UseSpoolRequest:
type: object
properties:
weight:
type: integer
note:
type: string
filePath:
type: string
UseSpoolResponse:
type: object
properties:
message:
type: string
historyId:
type: integer
SortSpoolRequest:
type: object
properties:
sortOrder:
type: integer
ArchiveSpoolRequest:
type: object
properties:
isArchived:
type: integer
UpdateUsageHistoryEntryRequest:
type: object
properties:
used_amount:
type: integer
note:
type: string