-
Notifications
You must be signed in to change notification settings - Fork 1
/
OpenAPISpecification.yaml
1139 lines (1138 loc) · 35.4 KB
/
OpenAPISpecification.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
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
swagger: '2.0'
info:
description: >-
The interface of the Delphi instance registry, which is responsible for
connecting instances within the system as well as providing basic status
information about them. For more information on Delphi, see
https://github.com/delphi-hub/.
version: 1.5.0
title: Delphi Instance Registry
host: 'localhost:8087'
consumes:
- application/json
produces:
- application/json
basePath: /
tags:
- name: Basic Operations
description: >-
Operations on instances that are not necessarily running in docker
containers
- name: Docker Operations
description: Operations on instances that are running in a docker container
- name: User Management
description: Operations related to the user database of Delphi-Management
schemes:
- https
- http
paths:
/configuration:
get:
tags:
- Meta
summary: Retreives general configuration information
description: >-
Retrieves an object containing the most important configuration values
of the registry. This contains the docker and traefik URIs.
operationId: configurationInfo
responses:
'200':
description: Configuration object
schema:
type: object
properties:
DockerHttpApi:
type: string
example: '172.0.2.1:9095'
TraefikProxyUri:
type: string
example: '172.0.2.1:80'
/users/authenticate:
post:
tags:
- User Management
summary: Authenticates a user and returns a valid JWT
description: >-
This endpoints validates the username and password that must be
supplied in the Authorization header (using HTTP Basic Authentication).
If valid, a JSON Web Token will be generated and returned, that may be
used to authenticate the user for subsequent requests.
operationId: authenticate
parameters:
- in: header
name: Delphi-Authorization
description: Valid JWT that autenticates the calling entity.
type: string
required: true
- in: header
name: Authorization
description: >-
HTTP Basic Authentication following the schema 'Basic
<User:Password> where the concatination of username and password is
Base64-Encoded.
type: string
required: true
responses:
'200':
description: 'Supplied data is valid, a Token object is returned'
schema:
$ref: '#/definitions/Token'
'401':
description: 'Unauthorized, invalid username / password supplied.'
/users/refreshToken:
post:
tags:
- User Management
summary: Generate a new token with refresh token
description: >-
This endpoints returns a new token and refresh token with the provide refresh token. It ensures that the user do not need to login frequently if the token got expired, system can generate new token with the refresh token. Refresh token will be valid for more time then normal token.
operationId: refreshToken
parameters:
- in: header
name: Authorization
description: Valid JWT refresh token.
type: string
required: true
responses:
'200':
description: 'Supplied data is valid, a Token object is returned'
schema:
$ref: '#/definitions/Token'
'401':
description: 'The supplied authentication is invalid'
/users/add:
post:
tags:
- User Management
summary: Adds a new users for the registry
description: >-
Adds a new user that is passed in the requests entity. The id of the
user will be returned.
operationId: addUser
parameters:
- in: body
name: DelphiUser
description: The user to add
required: true
schema:
type: object
required:
- userName
- secret
- userType
properties:
userName:
type: string
example: MyUser
secret:
type: string
example: 123Pass
userType:
type: string
enum:
- Admin
- User
- Component
responses:
'200':
description: 'OK, user has been added, id is returned'
schema:
type: integer
format: int64
example: 42
'400':
description: 'Bad request, name already exists'
/users:
get:
tags:
- User Management
summary: Gets a list of all registered users
description: >-
Returns a list of all users registered at the registry. Requires caller to have admin privileges.
operationId: allUsers
responses:
'200':
description: "OK, list of users is being returned"
schema:
type: array
items:
$ref: '#/definitions/User'
/users/{Id}:
get:
tags:
- User Management
summary: Gets the user with the specified id
description: >-
Returns the user with the specified id, if that id is present at the registry.
operationId: retrieveUser
parameters:
- in: path
name: Id
required: true
description: Id of the user to retrieve
type: integer
format: int64
responses:
'200':
description: "OK, user is being returned"
schema:
$ref: '#/definitions/User'
'404':
description: "Id not found"
/users/{Id}/remove:
post:
tags:
- User Management
summary: Removes the user with the specified id
description: >-
Removes the user with the specified id, if that id is present at the registry.
operationId: removeUser
parameters:
- in: path
name: Id
required: true
description: Id of the user to remove
type: integer
format: int64
responses:
'200':
description: "OK, user has been removed"
'404':
description: "Id not found"
/instances/register:
post:
tags:
- Basic Operations
summary: Register a new instance at the registry
description: >-
This commands registers the given instance at the registry and will
return the ID that was assigned to that instance. This is meant for
instances that are not running inside a docker container, as those will
be registered on calling /deploy.
operationId: addInstance
parameters:
- in: body
name: InstanceToRegister
description: >-
The instance that will be registered with this call. The ID
attribute is optional and will be ignored, as the registry assignes
a new unique id to the instance.
required: true
schema:
$ref: '#/definitions/Instance'
responses:
'200':
description: The ID of the registered instance
schema:
type: integer
format: int64
example: 42
'405':
description: Invalid input
/instances:
get:
tags:
- Basic Operations
summary: Get all instances of the specified type
description: >-
This command retrieves a list of all instances that are registered at
the registry and that have the specified type. If no type is specified,
all instances are being returned.
operationId: instanceOfType
parameters:
- name: ComponentType
in: query
description: Type of the instances to be retrieved
required: false
type: string
enum:
- Crawler
- WebApi
- WebApp
- DelphiManagement
- ElasticSearch
responses:
'200':
description: List of instances of the specified type
schema:
type: array
items:
$ref: '#/definitions/Instance'
'400':
description: Invalid value
'/instances/{Id}/deregister':
post:
tags:
- Basic Operations
summary: Deregister an instance from the registry
description: >-
This command deregisteres the instance with the given ID from the
registry. This means that it can no longer be matched to other
instances, and it can not be monitored by the management application
anymore.
operationId: deregisterInstance
parameters:
- name: Id
in: path
description: The ID of the instance to be deregistered.
required: true
type: integer
format: int64
responses:
'200':
description: Sucessfully Deregistered
'400':
description: Invalid Status Value
'404':
description: Instance not found
'405':
description: Validation exception
'/instances/{Id}/matchingInstance':
get:
tags:
- Basic Operations
summary: Get a matching instance of the specified type
description: >-
This command retrieves an instance from the registry that has the
specified type and is currently running / has the best matching results
on the server.
operationId: matchingInstance
parameters:
- in: path
name: Id
description: Id of the instance that is requesting a dependency
required: true
type: integer
format: int64
- name: ComponentType
in: query
description: Type of the instance to be retrieved
required: true
type: string
enum:
- Crawler
- WebApi
- WebApp
- DelphiManagement
- ElasticSearch
responses:
'200':
description: The instance that the registry matched with
schema:
$ref: '#/definitions/Instance'
'400':
description: Invalid status value
'/instances/{Id}':
get:
tags:
- Basic Operations
summary: Get the instance with the specified id
description: >-
This command retrieves the instance with the specified id from the
server. If that id is not present, 404 will be returned.
operationId: instance
parameters:
- in: path
name: Id
description: Id of the instance
required: true
type: integer
format: int64
responses:
'200':
description: The instance that was requested
schema:
$ref: '#/definitions/Instance'
'404':
description: The id was not found on the server
'500':
description: Internal server error
/instances/count:
get:
tags:
- Basic Operations
summary: Gets the number of instances running for the specified type
description: >-
This command retrieves the number of registered instances of the
specified type that are currently running. If no type is specified, the
number of all instances is being returned
operationId: numberOfInstances
parameters:
- name: ComponentType
in: query
description: Type of the instances to be counted
required: false
type: string
enum:
- Crawler
- WebApi
- WebApp
- DelphiManagement
- ElasticSearch
responses:
'200':
description: Number of instances running for the specified type
schema:
type: integer
format: int32
example: 7
'400':
description: Invalid ID supplied
'404':
description: Instances not found
'/instances/{Id}/matchingResult':
post:
tags:
- Basic Operations
summary: Posts a matching result to the instance registry
description: >-
This command posts a matching result to the instance registry. This
means that the sender tried to connect to the instance with the
specified ID, and it was either successful or not (indicated by the
parameter 'MatchingSuccessful').
operationId: matchInstance
consumes:
- application/json
parameters:
- in: body
name: MatchingData
description: Data necessary for processing the matching result
required: true
schema:
type: object
required:
- MatchingSuccessful
- SenderId
properties:
MatchingSuccessful:
description: >-
Boolean value indicating whether the matching was successful
or not
type: boolean
SenderId:
description: Id of the instance that is submitting the result
type: integer
format: int64
- in: path
name: Id
description: The ID of the instance that the sender was trying to reach.
required: true
type: integer
format: int64
responses:
'200':
description: successful operation
'400':
description: Invalid ID supplied
'404':
description: No match found
'/instances/{Id}/eventList':
get:
tags:
- Basic Operations
summary: Gets the list of events associated to the specified instance
description: >-
This command retrieves a list of events that are associated to the
instance with the specified id.
operationId: eventList
parameters:
- name: Id
in: path
description: Id of the instance
required: true
type: integer
format: int64
- name: StartPage
in: query
description: Page number
type: integer
format: int64
- name: PageItems
in: query
description: Number of items in a page
type: integer
format: int64
- name: LimitItems
in: query
description: Number of item need to provide
type: integer
format: int64
responses:
'200':
description: List of events for the specified instance
schema:
type: array
items:
$ref: '#/definitions/Event'
'404':
description: Instance not found
'/instances/{Id}/linksFrom':
get:
tags:
- Basic Operations
summary: Retrieves outgoing links from an instance
description: >-
This command retreives a list of outgoing links from the instance with
the specified id.
operationId: linksFrom
parameters:
- name: Id
in: path
description: Id of the instance
required: true
type: integer
format: int64
responses:
'200':
description: List of InstanceLinks from the specified instance
schema:
type: array
items:
$ref: '#/definitions/InstanceLink'
'404':
description: Instance not found
'/instances/{Id}/linksTo':
get:
tags:
- Basic Operations
summary: Retrieves incoming links to an instance
description: >-
This command retreives a list of incoming links from the instance with
the specified id.
operationId: linksTo
parameters:
- name: Id
in: path
description: Id of the instance
required: true
type: integer
format: int64
responses:
'200':
description: List of InstanceLinks to the specified instance
schema:
type: array
items:
$ref: '#/definitions/InstanceLink'
'404':
description: Instance not found
/instances/network:
get:
tags:
- Basic Operations
summary: Retrieves the current instance network
description: >-
Retrieves the instance network, meaning a list of all instances
currently registered at the registry.
operationId: network
responses:
'200':
description: The instance network
schema:
type: array
items:
$ref: '#/definitions/Instance'
'/instances/{Id}/label':
post:
tags:
- Basic Operations
consumes:
- application/json
summary: Add a label to the instance with the specified id
description: >-
This command will add the specified label to the instance with the
specified id.
operationId: addLabel
parameters:
- name: Id
in: path
description: Id of the instance
required: true
type: integer
format: int64
- in: body
name: Label
description: Label added to the instance.
required: true
schema:
type: string
example: private
responses:
'200':
description: Label successfully added
'400':
description: 'Bad request, your label exceeded the character limit'
'404':
description: 'Not found, the id you specified could not be found'
'/instances/{Id}/label/{Label}/delete':
post:
tags:
- Basic Operations
consumes:
- application/json
summary: Removes a label from the instance with the specified id
description: >-
This command will remove the specified label from the instance with the
specified id.
operationId: removeLabel
parameters:
- name: Id
in: path
description: Id of the instance
required: true
type: integer
format: int64
- name: Label
in: path
description: Label that need to be deleted
required: true
type: string
responses:
'200':
description: Label successfully deleted
'400':
description: 'Bad request, your label exceeded the character limit'
'404':
description: 'Not found, the id you specified could not be found'
'/instances/{Id}/logs':
get:
tags:
- Basic Operations
summary: Retrieve the logging output of the specified instance
description: >-
This command retrieves the docker container logging output for the
specified instance, if the instance is in fact running inside a docker
container.
operationId: retreiveLogs
parameters:
- name: Id
in: path
description: Id of the instance
required: true
type: integer
format: int64
- name: StdErr
in: query
description: Switch to select the stderr channel
required: false
type: boolean
responses:
'200':
description: 'Success, log string is being returned'
schema:
type: string
example: I am logging output ..
'400':
description: Selected instance not running inside docker container
'404':
description: Id not found on the server
'500':
description: Internal Server Error
'/instances/{Id}/attach':
get:
tags:
- Basic Operations
summary: Stream logging output from instance
description: >-
This command streams the docker container logging output for the
specified instance. NOTE: This is a websocket endpoint, so only valid
websocket requests will be processed. Swagger does not provide
sufficient support for websockets, so this documentation might be
confusing as it defines a HTTP method, etc. The names of parameters and
response-codes are valid though.
operationId: streamLogs
parameters:
- name: Id
in: path
description: Id of the instance
required: true
type: integer
format: int64
- name: StdErr
in: query
description: Switch to select the stderr channel
required: false
type: boolean
responses:
'200':
description: 'Success, logs are being streamed via websocket connection.'
'400':
description: Selected instance not running inside docker container
'404':
description: Id not found on the server
'500':
description: Internal Server Error
/instances/deploy:
post:
tags:
- Docker Operations
summary: Deploys a new instance of the specified type
description: >-
This command deploys a new instance of the specified ComponentType onto
the docker host. It will also initiate the registration process.
Immediatley after this call is finished the instance will be contained
in the registry, but its state will be 'Stopped' until the instance
itself called /reportStart, which will change the state to 'Running'
operationId: deploy
parameters:
- name: DeploymentData
in: body
required: true
schema:
type: object
required:
- ComponentType
properties:
ComponentType:
description: Type of the instance to be deployed
enum:
- Crawler
- WebApi
- WebApp
- DelphiManagement
- ElasticSearch
example: Crawler
InstanceName:
description: Name for the new instance
type: string
example: MyCrawler
responses:
'202':
description: Operation accepted
'500':
description: Internal server error
'/instances/{Id}/reportStart':
post:
tags:
- Docker Operations
summary: Reports the successful start of an instances to the registry
description: >-
This command informs the registry about an instance that successfully
reached the state 'Running'. This is only applicable to instances
running inside a docker container, as non-container instances would not
be registered before startup. Container instances are registered when
/deploy is called.
operationId: reportStart
parameters:
- name: Id
in: path
description: The ID of the instance.
required: true
type: integer
format: int64
responses:
'200':
description: Report successfully processed.
'400':
description: >-
Bad request, the instance with the specified ID is not deployed as a
docker container.
'404':
description: ID not found on server
'500':
description: Internal server error
'/instances/{Id}/reportStop':
post:
tags:
- Docker Operations
summary: Reports the manual stop of an instances to the registry
description: >-
This command informs the registry about an instance that was stopped
manually, meaning not via calling /stop on the instance registry. This
is only applicable to instances running inside a docker container, as
non-container instances would deregister themselves when stopped.
operationId: reportStop
parameters:
- name: Id
in: path
description: The ID of the instance.
required: true
type: integer
format: int64
responses:
'200':
description: Report successfully processed.
'400':
description: >-
Bad request, the instance with the specified ID is not deployed as a
docker container.
'404':
description: ID not found on server
'500':
description: Internal server error
'/instances/{Id}/reportFailure':
post:
tags:
- Docker Operations
summary: Report the failure of an instance to the registry
description: >-
This commands allows instances to report a failure that lead to the
termination of their execution. The instanceregistry will update the
state of the component accordingly and not use this component for
matching in the future. This is only applicable for instances running
inside a docker container, as the failure of non-container instances
will immediately lead to them being deregistered, since they cannot be
restarted.
operationId: reportFailure
parameters:
- name: Id
in: path
description: The ID of the instance.
required: true
type: integer
format: int64
responses:
'200':
description: Report successfully processed.
'400':
description: >-
Bad request, the instance with the specified ID is not deployed as a
docker container.
'404':
description: ID not found on server
'500':
description: Internal server error
'/instances/{Id}/pause':
post:
tags:
- Docker Operations
summary: Pauses the specified instances' docker container
description: >-
This command pauses the docker container of the instance with the
specified ID. Will change the instance state from 'Running' to 'Paused'
operationId: pause
parameters:
- name: Id
in: path
description: The ID of the instance.
required: true
type: integer
format: int64
responses:
'202':
description: 'Accepted, the operation will be completed in the future.'
'400':
description: >-
Bad request, the instance with the specified ID is either not
running or not deployed as a docker container at all.
'404':
description: ID not found on server
'500':
description: Internal server error
'/instances/{Id}/resume':
post:
tags:
- Docker Operations
summary: Resumes the specified instances' docker container
description: >-
This command resumes the execution of the docker container of the
instance with the specified ID. Will change the instance state from
'Paused' to 'Running'.
operationId: resume
parameters:
- name: Id
in: path
description: The ID of the instance.
required: true
type: integer
format: int64
responses:
'202':
description: 'Accepted, the operation will be completed in the future.'
'400':
description: >-
Bad request, the instance with the specified ID is either not paused
or not deployed as a docker container at all.
'404':
description: ID not found on server
'500':
description: Internal server error
'/instances/{Id}/stop':
post:
tags:
- Docker Operations
summary: Stops the specified instances' docker container
description: >-
This command stops the docker container of the instance with the
specified ID. The instance will be properly shut down by calling its
/stop command first. Will change the instance state to 'Stopped'.
operationId: stop
parameters:
- name: Id
in: path
description: The ID of the instance.
required: true
type: integer
format: int64
responses:
'202':
description: 'Accepted, the operation will be completed in the future.'
'400':
description: >-
Bad request, the instance with the specified ID is either already
stopped or not deployed as a docker container at all.
'404':
description: ID not found on server
'500':
description: Internal server error
'/instances/{Id}/start':
post:
tags:
- Docker Operations
summary: Starts the specified instances' docker container
description: >-
This command starts the docker container of the instance with the
specified ID. Will change the instance state from 'Stopped' to
'Running'.
operationId: start
parameters:
- name: Id
in: path
description: The ID of the instance.
required: true
type: integer
format: int64
responses:
'202':
description: 'Accepted, the operation will be completed in the future.'
'400':
description: >-
Bad request, the instance with the specified ID is either not
stopped or not deployed as a docker container at all.
'404':
description: ID not found on server
'500':
description: Internal server error
'/instances/{Id}/delete':
post:
tags:
- Docker Operations
summary: Deletes the specified instances' docker container
description: >-
This command deletes the docker container of the instance with the
specified ID. The container needs to be stopped first. This will remove
any data the instance registry holds about the instance.
operationId: delete
parameters:
- name: Id
in: path
description: The ID of the instance.
required: true
type: integer
format: int64
responses:
'202':
description: 'Accepted, the operation will be completed in the future.'
'400':
description: >-
Bad request, the instance with the specified ID is either not
stopped or not deployed as a docker container at all.
'404':
description: ID not found on server
'500':
description: Internal server error
'/instances/{Id}/assignInstance':
post:
tags:
- Docker Operations
summary: Assignes a new dependency to the specified instance
description: >-
This command assignes a new dependency to the instance with the
specified id. Internally, this will stop the instance, assign the new
dependency and start the instance again. This is why this is only
applicable to docker instances.
operationId: assignInstance
parameters:
- in: path
name: Id
description: The ID of the instance whichs dependency should be updated
required: true
type: integer
format: int64
- in: body
name: AssignedInstanceId
description: The ID of the instance that should be assigned as dependency.
required: true
schema:
type: integer
format: int64
example: 42
responses:
'202':
description: 'Accepted, the operation will be completed in the future.'
'400':
description: >-
Bad request, the instance with the specified ID is not running
inside a docker container or the assigned instance is of the wrong
component type.
'404':
description: One of the ids was not found on the server
'500':
description: Internal server error
'/instances/{Id}/command':
post:
tags:
- Docker Operations
summary: Runs a command into a docker container
description: This command runs a specified command inside a docker container.
operationId: command
parameters:
- in: path
name: Id
description: The ID of the instance that is a docker container
required: true
type: integer
format: int64
- in: body
name: CommandData
description: The data needed to run the command
required: true
schema:
type: object
required:
- Command
properties:
Command:
type: string
example: rm -rf *
Privileged:
type: boolean