-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy paththinx-api-openapi.yaml
More file actions
1252 lines (1193 loc) · 31 KB
/
thinx-api-openapi.yaml
File metadata and controls
1252 lines (1193 loc) · 31 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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: THiNX Device Management API
description: |
THiNX Device Management API provides functionality for managing IoT devices,
firmware updates, and related services. The API supports both v1 and v2 endpoints.
version: 2.0.0
contact:
name: THiNX Support
url: https://thinx.cloud
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://rtm.thinx.cloud/api
description: Legacy API (v1)
- url: https://rtm.thinx.cloud/api/v2
description: Current API (v2)
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT token obtained from login endpoint
sessionCookie:
type: apiKey
in: cookie
name: x-thx-core
description: Session cookie obtained after login
apiKeyAuth:
type: apiKey
in: header
name: Authentication
description: API key for device authentication
ownerApiKeyAuth:
type: object
description: Owner ID and API key in request body
properties:
owner:
type: string
description: Owner ID
api_key:
type: string
description: API key
schemas:
Error:
type: object
properties:
success:
type: boolean
example: false
status:
type: string
description: Error message
LoginRequest:
type: object
required:
- username
- password
properties:
username:
type: string
description: User's username or email
password:
type: string
description: User's password
remember:
type: integer
description: Set to 1 to extend session duration
enum: [0, 1]
default: 0
TokenLoginRequest:
type: object
required:
- token
properties:
token:
type: string
description: OAuth token
LoginResponse:
type: object
properties:
status:
type: string
example: "OK"
success:
type: boolean
example: true
access_token:
type: string
description: JWT access token
refresh_token:
type: string
description: JWT refresh token
redirectURL:
type: string
description: URL to redirect to after login
DeviceListResponse:
type: object
properties:
success:
type: boolean
example: true
devices:
type: array
items:
$ref: '#/components/schemas/Device'
Device:
type: object
properties:
udid:
type: string
description: Unique device identifier
alias:
type: string
description: Human-readable device name
owner:
type: string
description: Owner identifier
status:
type: string
enum: [online, offline, unknown]
lastupdate:
type: string
format: date-time
firmware:
type: string
description: Current firmware version
mac:
type: string
description: MAC address
platform:
type: string
description: Device platform
keyhash:
type: string
description: Device key hash
source:
type: string
description: Source code identifier
auto_update:
type: boolean
description: Whether device auto-updates
mesh_ids:
type: array
items:
type: string
description: Mesh networks the device belongs to
transformers:
type: array
items:
type: string
description: Transformers applied to the device
environment:
type: object
additionalProperties: true
description: Environment variables
DeviceDetailRequest:
type: object
required:
- udid
properties:
udid:
type: string
description: Unique device identifier
DeviceEditRequest:
type: object
required:
- changes
properties:
changes:
type: object
properties:
udid:
type: string
description: Unique device identifier
alias:
type: string
description: Human-readable device name
auto_update:
type: boolean
description: Whether device auto-updates
transformers:
type: array
items:
type: string
description: Transformers applied to the device
environment:
type: object
additionalProperties: true
description: Environment variables
DeviceRegistrationRequest:
type: object
required:
- registration
properties:
registration:
type: object
required:
- mac
- firmware
- version
- checksum
- push
properties:
mac:
type: string
description: MAC address
firmware:
type: string
description: Firmware identifier
version:
type: string
description: Firmware version
checksum:
type: string
description: Firmware checksum
push:
type: string
description: Push notification token
alias:
type: string
description: Human-readable device name
owner:
type: string
description: Owner identifier
udid:
type: string
description: Unique device identifier (if already registered)
DeviceRegistrationResponse:
type: object
properties:
registration:
type: object
properties:
success:
type: boolean
example: true
status:
type: string
example: "OK"
udid:
type: string
description: Unique device identifier
timestamp:
type: integer
description: Registration timestamp
FirmwareRequest:
type: object
required:
- mac
- owner
- udid
properties:
mac:
type: string
description: MAC address
owner:
type: string
description: Owner identifier
udid:
type: string
description: Unique device identifier
version:
type: string
description: Current firmware version
checksum:
type: string
description: Current firmware checksum
use:
type: string
enum: [ott]
description: Use one-time token for firmware update
FirmwareResponse:
type: object
properties:
success:
type: boolean
example: true
status:
type: string
example: "OK"
url:
type: string
description: URL to download firmware
ott:
type: string
description: One-time token for firmware download
ApiKeyRequest:
type: object
required:
- alias
properties:
alias:
type: string
description: Human-readable API key name
ApiKeyResponse:
type: object
properties:
success:
type: boolean
example: true
api_key:
type: string
description: API key
hash:
type: string
description: API key hash
ApiKeyListResponse:
type: object
properties:
success:
type: boolean
example: true
keys:
type: array
items:
type: object
properties:
alias:
type: string
description: Human-readable API key name
hash:
type: string
description: API key hash
short:
type: string
description: Short version of API key hash
ApiKeyRevokeRequest:
type: object
properties:
fingerprint:
type: string
description: API key hash to revoke
fingerprints:
type: array
items:
type: string
description: Multiple API key hashes to revoke
SourceAttachRequest:
type: object
required:
- udid
- source_id
properties:
udid:
type: string
description: Unique device identifier
source_id:
type: string
description: Source code identifier
SourceDetachRequest:
type: object
required:
- udid
properties:
udid:
type: string
description: Unique device identifier
MeshAttachRequest:
type: object
required:
- udid
- mesh_id
properties:
udid:
type: string
description: Unique device identifier
mesh_id:
type: string
description: Mesh network identifier
MeshDetachRequest:
type: object
required:
- udid
- mesh_id
properties:
udid:
type: string
description: Unique device identifier
mesh_id:
type: string
description: Mesh network identifier
NotificationRequest:
type: object
required:
- udid
- reply
properties:
udid:
type: string
description: Unique device identifier
reply:
type: string
description: Notification message
PushConfigurationRequest:
type: object
required:
- udid
- envs
properties:
udid:
type: string
description: Unique device identifier
envs:
type: object
additionalProperties: true
description: Environment variables to push
TransformerRunRequest:
type: object
required:
- device_id
properties:
device_id:
type: string
description: Unique device identifier
BuildRequest:
type: object
required:
- build
properties:
build:
type: object
required:
- udid
- source_id
properties:
udid:
type: string
description: Unique device identifier
source_id:
type: string
description: Source code identifier
dryrun:
type: boolean
description: If true, only validate the build without actually building
default: false
BuildArtifactsRequest:
type: object
required:
- udid
- build_id
- owner
properties:
udid:
type: string
description: Unique device identifier
build_id:
type: string
description: Build identifier
owner:
type: string
description: Owner identifier
LastBuildRequest:
type: object
required:
- udid
properties:
udid:
type: string
description: Unique device identifier
EnvVariableRequest:
type: object
required:
- key
- value
properties:
key:
type: string
description: Environment variable name
value:
type: string
description: Environment variable value
EnvVariableDeleteRequest:
type: object
properties:
name:
type: string
description: Environment variable name to delete
names:
type: array
items:
type: string
description: Multiple environment variable names to delete
paths:
# Authentication endpoints
/login:
post:
summary: User login
description: Authenticate a user with username and password or OAuth token
tags:
- Authentication
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/LoginRequest'
- $ref: '#/components/schemas/TokenLoginRequest'
responses:
'200':
description: Successful login
content:
application/json:
schema:
$ref: '#/components/schemas/LoginResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/logout:
get:
summary: User logout
description: Destroy user session
tags:
- Authentication
security:
- sessionCookie: []
responses:
'302':
description: Redirect to login page
# Device endpoints
/device:
get:
summary: List devices
description: List all devices for the authenticated user
tags:
- Devices
security:
- bearerAuth: []
- sessionCookie: []
responses:
'200':
description: List of devices
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceListResponse'
'401':
description: Unauthorized
post:
summary: Get device details
description: Get detailed information about a specific device
tags:
- Devices
security:
- bearerAuth: []
- sessionCookie: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceDetailRequest'
responses:
'200':
description: Device details
content:
application/json:
schema:
$ref: '#/components/schemas/Device'
'401':
description: Unauthorized
'400':
description: Bad request
put:
summary: Edit device
description: Update device information
tags:
- Devices
security:
- bearerAuth: []
- sessionCookie: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceEditRequest'
responses:
'200':
description: Device updated
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
status:
type: string
example: "OK"
'401':
description: Unauthorized
'400':
description: Bad request
delete:
summary: Delete device
description: Revoke a device
tags:
- Devices
security:
- bearerAuth: []
- sessionCookie: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceDetailRequest'
responses:
'200':
description: Device deleted
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
status:
type: string
example: "OK"
'401':
description: Unauthorized
/device/configuration:
post:
summary: Push configuration
description: Push configuration to a device
tags:
- Devices
security:
- bearerAuth: []
- sessionCookie: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PushConfigurationRequest'
responses:
'200':
description: Configuration pushed
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
status:
type: string
example: "OK"
'401':
description: Unauthorized
/device/notification:
post:
summary: Send notification
description: Send a notification to a device
tags:
- Devices
security:
- bearerAuth: []
- sessionCookie: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationRequest'
responses:
'200':
description: Notification sent
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
status:
type: string
example: "published"
'401':
description: Unauthorized
# Source endpoints
/source/attach:
put:
summary: Attach source
description: Attach a source code repository to a device
tags:
- Sources
security:
- bearerAuth: []
- sessionCookie: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SourceAttachRequest'
responses:
'200':
description: Source attached
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
status:
type: string
example: "OK"
'401':
description: Unauthorized
/source/detach:
put:
summary: Detach source
description: Detach a source code repository from a device
tags:
- Sources
security:
- bearerAuth: []
- sessionCookie: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SourceDetachRequest'
responses:
'200':
description: Source detached
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
status:
type: string
example: "OK"
'401':
description: Unauthorized
# Mesh endpoints
/mesh/attach:
put:
summary: Attach to mesh
description: Attach a device to a mesh network
tags:
- Mesh
security:
- bearerAuth: []
- sessionCookie: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MeshAttachRequest'
responses:
'200':
description: Device attached to mesh
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
status:
type: string
example: "OK"
'401':
description: Unauthorized
/mesh/detach:
put:
summary: Detach from mesh
description: Detach a device from a mesh network
tags:
- Mesh
security:
- bearerAuth: []
- sessionCookie: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MeshDetachRequest'
responses:
'200':
description: Device detached from mesh
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
status:
type: string
example: "OK"
'401':
description: Unauthorized
# API Key endpoints
/apikey:
get:
summary: List API keys
description: List all API keys for the authenticated user
tags:
- API Keys
security:
- bearerAuth: []
- sessionCookie: []
responses:
'200':
description: List of API keys
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKeyListResponse'
'401':
description: Unauthorized
post:
summary: Create API key
description: Create a new API key
tags:
- API Keys
security:
- bearerAuth: []
- sessionCookie: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKeyRequest'
responses:
'200':
description: API key created
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKeyResponse'
'401':
description: Unauthorized
delete:
summary: Revoke API key
description: Revoke one or more API keys
tags:
- API Keys
security:
- bearerAuth: []
- sessionCookie: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKeyRevokeRequest'
responses:
'200':
description: API key(s) revoked
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
status:
type: array
items:
type: string
description: List of revoked API key hashes
'401':
description: Unauthorized
# Transformer endpoints
/transformer/run:
post:
summary: Run transformer
description: Run a transformer on a device
tags:
- Transformers
security:
- bearerAuth: []
- sessionCookie: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TransformerRunRequest'
responses:
'200':
description: Transformer executed
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
status:
type: string
example: "OK"
'401':
description: Unauthorized
# Build endpoints
/build:
post:
summary: Trigger build
description: Trigger a build for a device
tags:
- Builds
security:
- bearerAuth: []
- sessionCookie: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BuildRequest'
responses:
'200':
description: Build triggered
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
status:
type: string
example: "OK"
'401':
description: Unauthorized
'400':
description: Bad request
/build/artifacts:
post:
summary: Get build artifacts
description: Get artifacts for a specific build