This repository has been archived by the owner on Nov 14, 2023. It is now read-only.
/
swagger.yml
1797 lines (1756 loc) · 46.9 KB
/
swagger.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
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:
version: 0.16.54
title: Ziti Fabric
description: OpenZiti Fabric API
contact:
name: OpenZiti
url: https://openziti.discourse.group
email: help@openziti.org
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
host: demo.ziti.dev
basePath: /fabric/v1
schemes:
- https
consumes:
- application/json
produces:
- application/json
#######################################################################################################################
#
# Paths - Endpoints and their associated HTTP methods
#
#######################################################################################################################
paths:
###################################################################
# Services
##################################################################
'/services':
get:
summary: List services
description: |
Retrieves a list of service resources; supports filtering, sorting, and pagination. Requires admin access.
tags:
- Service
operationId: listServices
parameters:
- $ref: '#/parameters/limit'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/filter'
responses:
'200':
$ref: '#/responses/listServices'
'401':
$ref: '#/responses/unauthorizedResponse'
post:
summary: Create a service resource
description: Create a service resource. Requires admin access.
tags:
- Service
operationId: createService
parameters:
- name: service
in: body
required: true
description: A service to create
schema:
$ref: '#/definitions/serviceCreate'
responses:
'201':
$ref: '#/responses/createResponse'
'400':
$ref: '#/responses/badRequestResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
'/services/{id}':
parameters:
- $ref: '#/parameters/id'
get:
summary: Retrieves a single service
description: Retrieves a single service by id. Requires admin access.
tags:
- Service
operationId: detailService
responses:
'200':
$ref: '#/responses/detailService'
'404':
$ref: '#/responses/notFoundResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
put:
summary: Update all fields on a service
description: Update all fields on a service by id. Requires admin access.
tags:
- Service
operationId: updateService
parameters:
- name: service
in: body
required: true
description: A service update object
schema:
$ref: '#/definitions/serviceUpdate'
responses:
'200':
$ref: '#/responses/updateResponse'
'400':
$ref: '#/responses/badRequestResponse'
'404':
$ref: '#/responses/notFoundResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
patch:
summary: Update the supplied fields on a service
description: Update the supplied fields on a service. Requires admin access.
tags:
- Service
operationId: patchService
parameters:
- name: service
in: body
required: true
description: A service patch object
schema:
$ref: '#/definitions/servicePatch'
responses:
'200':
$ref: '#/responses/patchResponse'
'400':
$ref: '#/responses/badRequestResponse'
'404':
$ref: '#/responses/notFoundResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
delete:
summary: Delete a service
description: Delete a service by id. Requires admin access.
tags:
- Service
operationId: deleteService
responses:
'200':
$ref: '#/responses/deleteResponse'
'400':
$ref: '#/responses/badRequestResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
'409':
$ref: '#/responses/cannotDeleteReferencedResourceResponse'
'/services/{id}/terminators':
parameters:
- $ref: '#/parameters/id'
get:
summary: List of terminators assigned to a service
description: |
Retrieves a list of terminator resources that are assigned specific service; supports filtering, sorting, and pagination.
tags:
- Service
operationId: listServiceTerminators
parameters:
- $ref: '#/parameters/limit'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/filter'
responses:
'200':
$ref: '#/responses/listTerminators'
'401':
$ref: '#/responses/unauthorizedResponse'
'400':
$ref: '#/responses/badRequestResponse'
###################################################################
# Routers
##################################################################
'/routers':
get:
summary: List routers
description: |
Retrieves a list of router resources; supports filtering, sorting, and pagination. Requires admin access.
tags:
- Router
operationId: listRouters
parameters:
- $ref: '#/parameters/limit'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/filter'
responses:
'200':
$ref: '#/responses/listRouters'
'401':
$ref: '#/responses/unauthorizedResponse'
post:
summary: Create a router resource
description: Create a router resource. Requires admin access.
tags:
- Router
operationId: createRouter
parameters:
- name: router
in: body
required: true
description: A router to create
schema:
$ref: '#/definitions/routerCreate'
responses:
'201':
$ref: '#/responses/createResponse'
'400':
$ref: '#/responses/badRequestResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
'/routers/{id}':
parameters:
- $ref: '#/parameters/id'
get:
summary: Retrieves a single router
description: Retrieves a single router by id. Requires admin access.
tags:
- Router
operationId: detailRouter
responses:
'200':
$ref: '#/responses/detailRouter'
'404':
$ref: '#/responses/notFoundResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
put:
summary: Update all fields on a router
description: Update all fields on a router by id. Requires admin access.
tags:
- Router
operationId: updateRouter
parameters:
- name: router
in: body
required: true
description: A router update object
schema:
$ref: '#/definitions/routerUpdate'
responses:
'200':
$ref: '#/responses/updateResponse'
'400':
$ref: '#/responses/badRequestResponse'
'404':
$ref: '#/responses/notFoundResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
patch:
summary: Update the supplied fields on a router
description: Update the supplied fields on a router. Requires admin access.
tags:
- Router
operationId: patchRouter
parameters:
- name: router
in: body
required: true
description: A router patch object
schema:
$ref: '#/definitions/routerPatch'
responses:
'200':
$ref: '#/responses/patchResponse'
'400':
$ref: '#/responses/badRequestResponse'
'404':
$ref: '#/responses/notFoundResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
delete:
summary: Delete a router
description: Delete a router by id. Requires admin access.
tags:
- Router
operationId: deleteRouter
responses:
'200':
$ref: '#/responses/deleteResponse'
'400':
$ref: '#/responses/badRequestResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
'409':
$ref: '#/responses/cannotDeleteReferencedResourceResponse'
'/routers/{id}/terminators':
parameters:
- $ref: '#/parameters/id'
get:
summary: List of terminators assigned to a router
description: |
Retrieves a list of terminator resources that are assigned specific router; supports filtering, sorting, and pagination.
tags:
- Router
operationId: listRouterTerminators
parameters:
- $ref: '#/parameters/limit'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/filter'
responses:
'200':
$ref: '#/responses/listTerminators'
'401':
$ref: '#/responses/unauthorizedResponse'
'400':
$ref: '#/responses/badRequestResponse'
###################################################################
# Terminators
##################################################################
'/terminators':
get:
summary: List terminators
description: |
Retrieves a list of terminator resources; supports filtering, sorting, and pagination. Requires admin access.
tags:
- Terminator
operationId: listTerminators
parameters:
- $ref: '#/parameters/limit'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/filter'
responses:
'200':
$ref: '#/responses/listTerminators'
'401':
$ref: '#/responses/unauthorizedResponse'
'400':
$ref: '#/responses/badRequestResponse'
post:
summary: Create a terminator resource
description: Create a terminator resource. Requires admin access.
tags:
- Terminator
operationId: createTerminator
parameters:
- name: terminator
in: body
required: true
description: A terminator to create
schema:
$ref: '#/definitions/terminatorCreate'
responses:
'201':
$ref: '#/responses/createResponse'
'400':
$ref: '#/responses/badRequestResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
'/terminators/{id}':
parameters:
- $ref: '#/parameters/id'
get:
summary: Retrieves a single terminator
description: Retrieves a single terminator by id. Requires admin access.
tags:
- Terminator
operationId: detailTerminator
responses:
'200':
$ref: '#/responses/detailTerminator'
'404':
$ref: '#/responses/notFoundResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
put:
summary: Update all fields on a terminator
description: Update all fields on a terminator by id. Requires admin access.
tags:
- Terminator
operationId: updateTerminator
parameters:
- name: terminator
in: body
required: true
description: A terminator update object
schema:
$ref: '#/definitions/terminatorUpdate'
responses:
'200':
$ref: '#/responses/updateResponse'
'400':
$ref: '#/responses/badRequestResponse'
'404':
$ref: '#/responses/notFoundResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
patch:
summary: Update the supplied fields on a terminator
description: Update the supplied fields on a terminator. Requires admin access.
tags:
- Terminator
operationId: patchTerminator
parameters:
- name: terminator
in: body
required: true
description: A terminator patch object
schema:
$ref: '#/definitions/terminatorPatch'
responses:
'200':
$ref: '#/responses/patchResponse'
'400':
$ref: '#/responses/badRequestResponse'
'404':
$ref: '#/responses/notFoundResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
delete:
summary: Delete a terminator
description: Delete a terminator by id. Requires admin access.
tags:
- Terminator
operationId: deleteTerminator
responses:
'200':
$ref: '#/responses/deleteResponse'
'400':
$ref: '#/responses/badRequestResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
'409':
$ref: '#/responses/cannotDeleteReferencedResourceResponse'
###################################################################
# Links
##################################################################
'/links':
get:
summary: List links
description: |
Retrieves a list of link resources; does not supports filtering, sorting, or pagination. Requires admin access.
tags:
- Link
operationId: listLinks
responses:
'200':
$ref: '#/responses/listLinks'
'401':
$ref: '#/responses/unauthorizedResponse'
'/links/{id}':
parameters:
- $ref: '#/parameters/id'
get:
summary: Retrieves a single link
description: Retrieves a single link by id. Requires admin access.
tags:
- Link
operationId: detailLink
responses:
'200':
$ref: '#/responses/detailLink'
'404':
$ref: '#/responses/notFoundResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
patch:
summary: Update the supplied fields on a link
description: Update the supplied fields on a link. Requires admin access.
tags:
- Link
operationId: patchLink
parameters:
- name: link
in: body
required: true
description: A link patch object
schema:
$ref: '#/definitions/linkPatch'
responses:
'200':
$ref: '#/responses/patchResponse'
'400':
$ref: '#/responses/badRequestResponse'
'404':
$ref: '#/responses/notFoundResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
delete:
summary: Delete a link
description: Delete a link by id. Requires admin access.
tags:
- Link
operationId: deleteLink
responses:
'200':
$ref: '#/responses/deleteResponse'
'400':
$ref: '#/responses/badRequestResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
###################################################################
# Circuits
##################################################################
'/circuits':
get:
summary: List circuits
description: |
Retrieves a list of circuit resources; does not supports filtering, sorting, or pagination. Requires admin access.
tags:
- Circuit
operationId: listCircuits
responses:
'200':
$ref: '#/responses/listCircuits'
'401':
$ref: '#/responses/unauthorizedResponse'
'/circuits/{id}':
parameters:
- $ref: '#/parameters/id'
get:
summary: Retrieves a single circuit
description: Retrieves a single circuit by id. Requires admin access.
tags:
- Circuit
operationId: detailCircuit
responses:
'200':
$ref: '#/responses/detailCircuit'
'404':
$ref: '#/responses/notFoundResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
delete:
summary: Delete a circuit
description: Delete a circuit by id. Requires admin access.
tags:
- Circuit
operationId: deleteCircuit
parameters:
- name: options
in: body
required: false
description: A circuit delete object
schema:
$ref: '#/definitions/circuitDelete'
responses:
'200':
$ref: '#/responses/deleteResponse'
'400':
$ref: '#/responses/badRequestResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
'409':
$ref: '#/responses/cannotDeleteReferencedResourceResponse'
###################################################################
# Inspections
###################################################################
'/inspections':
post:
summary: Inspect system values
description: |
Requests system information, such as stack dumps or information about capabilities. Requires admin access.
tags:
- Inspect
operationId: inspect
parameters:
- name: request
in: body
required: true
description: An inspect request
schema:
$ref: '#/definitions/inspectRequest'
responses:
'200':
$ref: '#/responses/inspectResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
###################################################################
# Database
###################################################################
'/database':
post:
summary: Create a new database snapshot
description: Create a new database snapshot. Requires admin access.
security:
- ztSession: [ ]
tags:
- Database
operationId: createDatabaseSnapshot
responses:
'200':
$ref: '#/responses/emptyResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
'429':
$ref: '#/responses/rateLimitedResponse'
'/database/snapshot':
post:
summary: Create a new database snapshot with path
description: Create a new database snapshot with path. Requires admin access.
tags:
- Database
operationId: createDatabaseSnapshotWithPath
parameters:
- name: snapshot
in: body
required: true
description: snapshot parameters
schema:
$ref: '#/definitions/databaseSnapshotCreate'
responses:
'200':
$ref: '#/responses/databaseSnapshotCreateResult'
'401':
$ref: '#/responses/unauthorizedResponse'
'429':
$ref: '#/responses/rateLimitedResponse'
'/database/check-data-integrity':
post:
summary: Starts a data integrity scan on the datastore
description: Starts a data integrity scan on the datastore. Requires admin access. Only once instance may run at a time, including runs of fixDataIntegrity.
security:
- ztSession: [ ]
tags:
- Database
operationId: checkDataIntegrity
responses:
'202':
$ref: '#/responses/emptyResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
'429':
$ref: '#/responses/rateLimitedResponse'
'/database/fix-data-integrity':
post:
summary: Runs a data integrity scan on the datastore, attempts to fix any issues it can and returns any found issues
description: Runs a data integrity scan on the datastore, attempts to fix any issues it can, and returns any found issues. Requires admin access. Only once instance may run at a time, including runs of checkDataIntegrity.
security:
- ztSession: [ ]
tags:
- Database
operationId: fixDataIntegrity
responses:
'202':
$ref: '#/responses/emptyResponse'
'429':
$ref: '#/responses/rateLimitedResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
'/database/data-integrity-results':
get:
summary: Returns any results found from in-progress integrity checks
description: Returns any results found from in-progress integrity checks. Requires admin access.
security:
- ztSession: [ ]
tags:
- Database
operationId: dataIntegrityResults
responses:
'200':
$ref: '#/responses/dataIntegrityCheckResult'
'401':
$ref: '#/responses/unauthorizedResponse'
###################################################################
# Raft
##################################################################
'/raft/list-members':
get:
summary: Returns all members of a cluster and their current status
description: Returns all members of a cluster and their current status
tags:
- Raft
operationId: raftListMembers
responses:
'200':
$ref: '#/responses/raftListMembersResponse'
'401':
$ref: '#/responses/unauthorizedResponse'
#######################################################################################################################
#
# Parameters - Reusable parameters
#
#######################################################################################################################
parameters:
id:
name: id
required: true
type: string
in: path
description: The id of the requested resource
limit:
name: limit
type: integer
in: query
offset:
name: offset
type: integer
in: query
filter:
name: filter
type: string
in: query
#######################################################################################################################
#
# Responses - Envelope Wrapped Definitions
#
#######################################################################################################################
responses:
###################################################################
# Errors
##################################################################
badRequestResponse:
description: The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
'application/json':
error:
args:
urlVars: {}
cause:
field: '(root)'
type: required
value:
fooField: abc
fooField2: def
message: '(root): fooField3 is required'
details:
context: '(root)'
field: '(root)'
property: fooField3
causeMessage: schema validation failed
code: COULD_NOT_VALIDATE
message: The supplied request contains an invalid document
requestId: ac6766d6-3a09-44b3-8d8a-1b541d97fdd9
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
unauthorizedResponse:
description: The currently supplied session does not have the correct access rights to request this resource
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
'application/json':
error:
args:
urlVars: {}
cause: ''
causeMessage: ''
code: UNAUTHORIZED
message: The request could not be completed. The session is not authorized or the
credentials are invalid
requestId: 0bfe7a04-9229-4b7a-812c-9eb3cc0eac0f
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
invalidAuthResponse:
description: The authentication request could not be processed as the credentials are invalid
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
'application/json':
error:
args:
urlVars: {}
cause: ''
causeMessage: ''
code: INVALID_AUTH
message: The authentication request failed
requestId: 5952ed10-3091-474f-a691-47ebab6990dc
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
notFoundResponse:
description: The requested resource does not exist
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
'application/json':
error:
args:
urlVars:
id: 71a3000f-7dda-491a-9b90-a19f4ee6c406
cause:
causeMessage: ''
code: NOT_FOUND
message: The resource requested was not found or is no longer available
requestId: 270908d6-f2ef-4577-b973-67bec18ae376
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
cannotDeleteReferencedResourceResponse:
description: The resource requested to be removed/altered cannot be as it is referenced by another object.
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
'application/json':
error:
args:
urlVars:
id: 71a3000f-7dda-491a-9b90-a19f4ee6c406
causeMessage: 'referenced by /some-resource/05f4f710-c155-4a74-86d5-77558eb9cb42'
code: CONFLICT_CANNOT_MODIFY_REFERENCED
message: The resource cannot be deleted/modified. Remove all referencing resources first.
requestId: 270908d6-f2ef-4577-b973-67bec18ae376
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
rateLimitedResponse:
description: The resource requested is rate limited and the rate limit has been exceeded
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
'application/json':
error:
args:
urlVars: {}
causeMessage: 'you have hit a rate limit in the requested operation'
code: RATE_LIMITED
message: The resource is rate limited and the rate limit has been exceeded. Please try again later
requestId: 270908d6-f2ef-4577-b973-67bec18ae376
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
###################################################################
# Standard Responses
##################################################################
emptyResponse:
description: Base empty response
schema:
$ref: '#/definitions/empty'
deleteResponse:
description: The delete request was successful and the resource has been removed
schema:
$ref: '#/definitions/empty'
updateResponse:
description: The update request was successful and the resource has been altered
schema:
$ref: '#/definitions/empty'
patchResponse:
description: The patch request was successful and the resource has been altered
schema:
$ref: '#/definitions/empty'
createResponse:
description: The create request was successful and the resource has been added at the following location
schema:
$ref: '#/definitions/createEnvelope'
###################################################################
# Services
##################################################################
listServices:
description: A list of services
schema:
$ref: '#/definitions/listServicesEnvelope'
detailService:
description: A single service
schema:
$ref: '#/definitions/detailServiceEnvelope'
###################################################################
# Routers
##################################################################
listRouters:
description: A list of routers
schema:
$ref: '#/definitions/listRoutersEnvelope'
detailRouter:
description: A single router
schema:
$ref: '#/definitions/detailRouterEnvelope'
###################################################################
# Terminators
##################################################################
listTerminators:
description: A list of terminators
schema:
$ref: '#/definitions/listTerminatorsEnvelope'
detailTerminator:
description: A single terminator
schema:
$ref: '#/definitions/detailTerminatorEnvelope'
###################################################################
# Links
##################################################################
listLinks:
description: A list of links
schema:
$ref: '#/definitions/listLinksEnvelope'
detailLink:
description: A single link
schema:
$ref: '#/definitions/detailLinkEnvelope'
###################################################################
# Circuits
###################################################################
listCircuits:
description: A list of circuits
schema:
$ref: '#/definitions/listCircuitsEnvelope'
detailCircuit:
description: A single circuit
schema:
$ref: '#/definitions/detailCircuitEnvelope'
###################################################################
# Inspections
###################################################################
inspectResponse:
description: A response to an inspect request
schema:
$ref: '#/definitions/inspectResponse'
###################################################################
# Database
###################################################################
dataIntegrityCheckResult:
description: A list of data integrity issues found
schema:
$ref: '#/definitions/dataIntegrityCheckResultEnvelope'
databaseSnapshotCreateResult:
description: The path to the created snapshot
schema:
$ref: '#/definitions/databaseSnapshotCreateResultEnvelope'
###################################################################
# Raft
##################################################################
raftListMembersResponse:
description: A response to a raft list-members request
schema:
$ref: '#/definitions/raftMemberListResponse'
#######################################################################################################################
#
# Definitions - In & Out Models Only
#
#######################################################################################################################
definitions:
###################################################################
# Standard
##################################################################
pagination:
type: object
required:
- limit
- offset
- totalCount
properties:
limit:
type: number
format: int64
offset:
type: number
format: int64
totalCount:
type: number
format: int64
empty:
type: object
required:
- meta
- data
properties:
meta:
$ref: '#/definitions/meta'
data:
type: object
example: {}
meta:
type: object
properties:
filterableFields:
type: array
items:
type: string
x-omitempty: true
pagination:
$ref: '#/definitions/pagination'
apiEnrollmentVersion:
type: string
apiVersion:
type: string
createEnvelope:
type: object
properties:
meta:
$ref: '#/definitions/meta'
data:
$ref: '#/definitions/createLocation'
createLocation:
type: object
properties:
_links:
$ref: '#/definitions/links'
id:
type: string
baseEntity:
description: Fields shared by all Edge API entities