-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathopenai.yaml
More file actions
483 lines (459 loc) · 11.9 KB
/
Copy pathopenai.yaml
File metadata and controls
483 lines (459 loc) · 11.9 KB
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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
openapi: 3.1.0
info:
title: Arduino Project Manager API
description: API for managing Arduino projects using arduino-cli, with caching for project and library files, just-in-time reading, and read-only library browsing.
version: 2.1.0
servers:
- url: [PLACE_YOUR_PUBLIC_NGROK_URL_HERE]
description: Ngrok tunnel URL for the FastAPI server
paths:
/check_folder:
post:
operationId: checkFolder
summary: Check if project folder exists
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
project_name:
type: string
required:
- project_name
responses:
"200":
description: Existence status
"500":
description: Server error
/read_files:
post:
deprecated: true
operationId: readFiles
summary: DEPRECATED - Only returns filenames
description: >
Deprecated. Formerly returned all file contents, now only returns filenames to avoid huge payloads.
Use /read_file to fetch contents of an individual file.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
project_name:
type: string
required:
- project_name
responses:
"200":
description: Filenames
"404":
description: Project not found
"500":
description: Server error
/list_files_in_project:
get:
operationId: listFilesInProject
summary: List filenames in a project
parameters:
- in: query
name: project_name
schema:
type: string
required: true
responses:
"200":
description: Filenames
"404":
description: Project not found
"500":
description: Server error
/read_file:
post:
operationId: readFile
summary: Read contents of a single project file
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
project_name:
type: string
file_path:
type: string
required:
- project_name
- file_path
responses:
"200":
description: File contents
"404":
description: File or project not found
"500":
description: Server error
/create_project:
post:
operationId: createProject
summary: Create a new project folder and one file
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
project_name:
type: string
sketch_content:
type: string
file_path:
type: string
required:
- project_name
- sketch_content
responses:
"200":
description: Project creation
"400":
description: Project exists
"500":
description: Server error
/update_sketch:
post:
operationId: updateSketch
summary: Update or create a file in an existing project
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
project_name:
type: string
sketch_content:
type: string
file_path:
type: string
required:
- project_name
- sketch_content
responses:
"200":
description: Update success
"404":
description: Project not found
"500":
description: Server error
/compile_project:
post:
operationId: compileProject
summary: Compile a project
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
project_name:
type: string
required:
- project_name
responses:
"200":
description: Compilation result
"404":
description: Project or main .ino not found
"500":
description: Error compiling
/upload_project:
post:
operationId: uploadProject
summary: Upload project to an Arduino board
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
project_name:
type: string
port:
type: string
required:
- project_name
- port
responses:
"200":
description: Upload result
"404":
description: Project or main .ino not found
"500":
description: Error uploading
/list_projects:
get:
operationId: listProjects
summary: List all project folders
responses:
"200":
description: List of project folders
"500":
description: Server error
/list_libraries:
get:
operationId: listLibraries
summary: List library folders in Arduino/libraries
responses:
"200":
description: Library list
"500":
description: Server error
/list_files_in_library:
get:
operationId: listFilesInLibrary
summary: List filenames in a specific library
parameters:
- in: query
name: library_name
schema:
type: string
required: true
responses:
"200":
description: Filenames
"404":
description: Library not found
"500":
description: Server error
/read_library_file:
post:
operationId: readLibraryFile
summary: Read a single file from a library (read-only)
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
library_name:
type: string
file_path:
type: string
required:
- library_name
- file_path
responses:
"200":
description: File contents
"404":
description: File/library not found
"500":
description: Server error
/copy_library_example:
post:
operationId: copyLibraryExample
summary: Copy an example folder from a library into a local project
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
library_name:
type: string
example_folder:
type: string
new_project_name:
type: string
required:
- library_name
- example_folder
- new_project_name
responses:
"200":
description: Copy success
"404":
description: Library or example not found
"500":
description: Server error
# -----------------------------
# Library Management Endpoints
# -----------------------------
/list_libraries_installed:
get:
operationId: listLibrariesInstalled
summary: Run `arduino-cli lib list` to see installed libraries
responses:
"200":
description: CLI output
"500":
description: Error listing libraries
/search_library:
post:
operationId: searchLibrary
summary: Search libraries by keyword
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
keyword:
type: string
required:
- keyword
responses:
"200":
description: CLI output
"500":
description: Error searching libraries
/install_library:
post:
operationId: installLibrary
summary: Install a library
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
library_name:
type: string
required:
- library_name
responses:
"200":
description: CLI output
"500":
description: Error installing library
/uninstall_library:
post:
operationId: uninstallLibrary
summary: Uninstall a library
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
library_name:
type: string
required:
- library_name
responses:
"200":
description: CLI output
"500":
description: Error uninstalling library
/update_library:
post:
operationId: updateLibrary
summary: Update a specific library
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
library_name:
type: string
required:
- library_name
responses:
"200":
description: CLI output
"500":
description: Error updating library
/update_all_libraries:
post:
operationId: updateAllLibraries
summary: Update all libraries
responses:
"200":
description: CLI output
"500":
description: Error updating libraries
# -----------------------------
# Board/Core Management
# -----------------------------
/list_connected_boards:
get:
operationId: listConnectedBoards
summary: List boards currently connected
responses:
"200":
description: CLI output
"500":
description: Error listing boards
/search_cores:
post:
operationId: searchCores
summary: Search board cores
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
keyword:
type: string
required:
- keyword
responses:
"200":
description: CLI output
"500":
description: Error searching cores
/install_core:
post:
operationId: installCore
summary: Install a board core
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
core:
type: string
required:
- core
responses:
"200":
description: CLI output
"500":
description: Error installing core
/uninstall_core:
post:
operationId: uninstallCore
summary: Uninstall a board core
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
core:
type: string
required:
- core
responses:
"200":
description: CLI output
"500":
description: Error uninstalling core