-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathopenapi.yaml
11145 lines (11068 loc) · 369 KB
/
openapi.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
openapi: 3.1.0
info:
title: Konnect API - Go SDK
version: 0.0.1
description: The Konnect platform API
contact:
name: Kong Inc
url: https://konghq.com
email: [email protected]
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://global.api.konghq.com
- url: https://us.api.konghq.com
- url: https://eu.api.konghq.com
- url: https://au.api.konghq.com
security:
- personalAccessToken: []
- systemAccountAccessToken: []
- konnectAccessToken: []
tags:
- name: Control Planes
- name: Control Plane Groups
- name: Auth Settings
- name: Invites
- name: Roles
- name: Team Membership
- name: Teams
- name: Users
- name: System Accounts
- name: System Accounts - Access Tokens
- name: System Accounts - Roles
- name: System Accounts - Team Membership
- name: Me
- name: Authentication
- name: Impersonation Settings
- description: DP Nodes
name: DP Nodes
- description: DP Certificates
name: DP Certificates
- description: Custom Plugin Schemas
name: Custom Plugin Schemas
- description: >
Service entities are abstractions of your microservice interfaces or
formal APIs. For example, a service could be a data transformation
microservice or a billing API.
<br><br>
The main attribute of a service is the destination URL for proxying
traffic. This URL can be set as a single string or by specifying its
protocol, host, port and path individually.
<br><br>
Services are associated to routes, and a single service can have many
routes associated with it. Routes are entrypoints in Kong Gateway which
define rules to match client requests. Once a route is matched, Kong
Gateway proxies the request to its associated service. See the [Proxy
Reference](https://docs.konghq.com/gateway/latest/how-kong-works/routing-traffic/)
for a detailed explanation of how Kong proxies traffic.
<br><br>
Services can be both [tagged and filtered by
tags](https://docs.konghq.com/gateway/latest/admin-api/#tags).
name: Services
- description: >
Route entities define rules to match client requests. Each route is
associated with a service, and a service may have multiple routes
associated to it. Every request matching a given route will be proxied to
the associated service. You need at least one matching rule that applies
to the protocol being matched by the route.
<br><br>
The combination of routes and services, and the separation of concerns
between them, offers a powerful routing mechanism with which it is
possible to define fine-grained entrypoints in Kong Gateway leading to
different upstream services of your infrastructure.
<br><br>
Depending on the protocol, one of the following attributes must be set:
<br>
- `http`: At least one of `methods`, `hosts`, `headers`, or `paths`
- `https`: At least one of `methods`, `hosts`, `headers`, `paths`, or
`snis`
- `tcp`: At least one of `sources` or `destinations`
- `tls`: at least one of `sources`, `destinations`, or `snis`
- `tls_passthrough`: set `snis`
- `grpc`: At least one of `hosts`, `headers`, or `paths`
- `grpcs`: At least one of `hosts`, `headers`, `paths`, or `snis`
- `ws`: At least one of `hosts`, `headers`, or `paths`
- `wss`: At least one of `hosts`, `headers`, `paths`, or `snis`
<br>
A route can't have both `tls` and `tls_passthrough` protocols at same time.
<br><br>
Learn more about the router:
- [Configure routes using
expressions](https://docs.konghq.com/gateway/latest/key-concepts/routes/expressions)
- [Router Expressions language
reference](https://docs.konghq.com/gateway/latest/reference/router-expressions-language/)
name: Routes
- description: >
A plugin entity represents a plugin configuration that will be executed
during the HTTP request/response lifecycle. Plugins let you add
functionality to services that run behind a Kong Gateway instance, like
authentication or rate limiting.
You can find more information about available plugins and which values
each plugin accepts at the [Plugin Hub](https://docs.konghq.com/hub/).
<br><br>
When adding a plugin configuration to a service, the plugin will run on
every request made by a client to that service. If a plugin needs to be
tuned to different values for some specific consumers, you can do so by
creating a separate plugin instance that specifies both the service and
the consumer, through the service and consumer fields.
<br><br>
Plugins can be both [tagged and filtered by
tags](https://docs.konghq.com/gateway/latest/admin-api/#tags).
name: Plugins
- description: >
The consumer object represents a consumer - or a user - of a service.
You can either rely on Kong Gateway as the primary datastore, or you can
map the consumer list with your database to keep consistency between Kong
Gateway and your existing primary datastore.
name: Consumers
- description: >-
Consumer groups enable the organization and categorization of consumers
(users or applications) within an API ecosystem.
By grouping consumers together, you eliminate the need to manage them
individually, providing a scalable, efficient approach to managing
configurations.
name: Consumer Groups
- description: >
A certificate object represents a public certificate, and can be
optionally paired with the corresponding private key. These objects are
used by Kong Gateway to handle SSL/TLS termination for encrypted requests,
or for use as a trusted CA store when validating peer certificate of
client/service.
<br><br>
Certificates are optionally associated with SNI objects to tie a cert/key
pair to one or more hostnames.
<br><br>
If intermediate certificates are required in addition to the main
certificate, they should be concatenated together into one string.
name: Certificates
- description: >-
An SNI object represents a many-to-one mapping of hostnames to a
certificate.
<br><br>
A certificate object can have many hostnames associated with it. When Kong
Gateway receives an SSL request, it uses the SNI field in the Client Hello
to look up the certificate object based on the SNI associated with the
certificate.
name: SNIs
- description: >-
A CA certificate object represents a trusted certificate authority.
These objects are used by Kong Gateway to verify the validity of a client
or server certificate.
name: CA Certificates
- description: >-
The upstream object represents a virtual hostname and can be used to load
balance incoming requests over multiple services (targets).
<br><br>
An upstream also includes a [health
checker](https://docs.konghq.com/gateway/latest/how-kong-works/health-checks/),
which can enable and disable targets based on their ability or inability
to serve requests.
The configuration for the health checker is stored in the upstream object,
and applies to all of its targets.
name: Upstreams
- description: >
Vault objects are used to configure different vault connectors for
[managing
secrets](https://docs.konghq.com/gateway/latest/kong-enterprise/secrets-management/).
Configuring a vault lets you reference secrets from other entities.
This allows for a proper separation of secrets and configuration and
prevents secret sprawl.
<br><br>
For example, you could store a certificate and a key in a vault, then
reference them from a certificate entity. This way, the certificate and
key are not stored in the entity directly and are more secure.
<br><br>
Secrets rotation can be managed using
[TTLs](https://docs.konghq.com/gateway/latest/kong-enterprise/secrets-management/advanced-usage/).
name: Vaults
- description: >
A key object holds a representation of asymmetric keys in various formats.
When Kong Gateway or a Kong plugin requires a specific public or private
key to perform certain operations, it can use this entity.
name: Keys
- description: >
A JSON Web key set. Key sets are the preferred way to expose keys to
plugins because they tell the plugin where to look for keys or have a
scoping mechanism to restrict plugins to specific keys.
name: KeySets
- name: API-keys
- name: Basic-auth credentials
- name: JWTs
- name: HMAC-auth credentials
- name: MTLS-auth credentials
- name: ACLs
paths:
/v2/control-planes:
get:
summary: List Control Planes
responses:
'200':
$ref: '#/components/responses/ListControlPlanesResponse'
'400':
$ref: '#/components/responses/ControlPlanesBadRequest'
'401':
$ref: '#/components/responses/ControlPlaneUnauthenticated'
'403':
$ref: '#/components/responses/ControlPlanePermissionDenied'
'503':
$ref: '#/components/responses/ServiceUnavailable'
operationId: list-control-planes
description: >-
Returns an array of control plane objects containing information about
the Konnect Control Planes.
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/ControlPlaneFilter'
- $ref: '#/components/parameters/FilterByLabels'
- $ref: '#/components/parameters/ControlPlaneSort'
tags:
- Control Planes
parameters: []
post:
x-speakeasy-entity-operation: GatewayControlPlane#create
summary: Create Control Plane
operationId: create-control-plane
responses:
'201':
$ref: '#/components/responses/CreateControlPlaneResponse'
'400':
$ref: '#/components/responses/ControlPlanesBadRequest'
'401':
$ref: '#/components/responses/ControlPlaneUnauthenticated'
'403':
$ref: '#/components/responses/ControlPlanePermissionDenied'
'409':
$ref: '#/components/responses/ControlPlaneConflict'
'500':
$ref: '#/components/responses/InternalServerError'
'503':
$ref: '#/components/responses/ServiceUnavailable'
tags:
- Control Planes
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateControlPlaneRequest'
description: Create a control plane in the Konnect Organization.
/v2/control-planes/{controlPlaneId}/core-entities/acls:
get:
operationId: list-acl
summary: List all ACLs
description: List all ACLs
parameters:
- $ref: '#/components/parameters/PaginationSize'
- $ref: '#/components/parameters/PaginationOffset'
- $ref: '#/components/parameters/PaginationTagsFilter'
responses:
'200':
description: A successful response listing ACLs
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ACL'
next:
$ref: '#/components/schemas/PaginationNextResponse'
offset:
$ref: '#/components/schemas/PaginationOffsetResponse'
'401':
$ref: '#/components/responses/HTTP401Error'
tags:
- ACLs
parameters:
- $ref: '#/components/parameters/controlPlaneId'
/v2/control-planes/{controlPlaneId}/core-entities/acls/{ACLId}:
get:
operationId: get-acl
summary: Fetch an ACL
description: Get an ACL using ID.
responses:
'200':
description: Successfully fetched ACL
content:
application/json:
schema:
$ref: '#/components/schemas/ACL'
'401':
$ref: '#/components/responses/HTTP401Error'
'404':
description: Resource does not exist
tags:
- ACLs
parameters:
- $ref: '#/components/parameters/ACLId'
- $ref: '#/components/parameters/controlPlaneId'
/v2/control-planes/{controlPlaneId}/core-entities/basic-auths:
get:
operationId: list-basic-auth
summary: List all Basic-auth credentials
description: List all Basic-auth credentials
parameters:
- $ref: '#/components/parameters/PaginationSize'
- $ref: '#/components/parameters/PaginationOffset'
- $ref: '#/components/parameters/PaginationTagsFilter'
responses:
'200':
description: A successful response listing Basic-auth credentials
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/BasicAuth'
next:
$ref: '#/components/schemas/PaginationNextResponse'
offset:
$ref: '#/components/schemas/PaginationOffsetResponse'
'401':
$ref: '#/components/responses/HTTP401Error'
tags:
- Basic-auth credentials
parameters:
- $ref: '#/components/parameters/controlPlaneId'
/v2/control-planes/{controlPlaneId}/core-entities/basic-auths/{BasicAuthId}:
get:
operationId: get-basic-auth
summary: Fetch a Basic-auth credential
description: Get a Basic-auth credential using ID.
responses:
'200':
description: Successfully fetched Basic-auth credential
content:
application/json:
schema:
$ref: '#/components/schemas/BasicAuth'
'401':
$ref: '#/components/responses/HTTP401Error'
'404':
description: Resource does not exist
tags:
- Basic-auth credentials
parameters:
- $ref: '#/components/parameters/BasicAuthId'
- $ref: '#/components/parameters/controlPlaneId'
/v2/control-planes/{controlPlaneId}/core-entities/ca_certificates:
get:
operationId: list-ca_certificate
summary: List all CA Certificates
description: List all CA Certificates
parameters:
- $ref: '#/components/parameters/PaginationSize'
- $ref: '#/components/parameters/PaginationOffset'
- $ref: '#/components/parameters/PaginationTagsFilter'
responses:
'200':
description: A successful response listing CA Certificates
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CACertificate'
next:
$ref: '#/components/schemas/PaginationNextResponse'
offset:
$ref: '#/components/schemas/PaginationOffsetResponse'
'401':
$ref: '#/components/responses/HTTP401Error'
tags:
- CA Certificates
parameters:
- $ref: '#/components/parameters/controlPlaneId'
post:
operationId: create-ca_certificate
summary: Create a new CA Certificate
description: Create a new CA Certificate
requestBody:
description: Description of the new CA Certificate for creation
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CACertificate'
responses:
'201':
description: Successfully created CA Certificate
content:
application/json:
schema:
$ref: '#/components/schemas/CACertificate'
'401':
$ref: '#/components/responses/HTTP401Error'
tags:
- CA Certificates
/v2/control-planes/{controlPlaneId}/core-entities/ca_certificates/{CACertificateId}:
delete:
operationId: delete-ca_certificate
summary: Delete a CA Certificate
description: Delete a CA Certificate
parameters:
- $ref: '#/components/parameters/CACertificateId'
responses:
'204':
description: Successfully deleted CA Certificate or the resource didn't exist
'401':
$ref: '#/components/responses/HTTP401Error'
tags:
- CA Certificates
get:
operationId: get-ca_certificate
summary: Fetch a CA Certificate
description: Get a CA Certificate using ID.
responses:
'200':
description: Successfully fetched CA Certificate
content:
application/json:
schema:
$ref: '#/components/schemas/CACertificate'
'401':
$ref: '#/components/responses/HTTP401Error'
'404':
description: Resource does not exist
tags:
- CA Certificates
parameters:
- $ref: '#/components/parameters/CACertificateId'
- $ref: '#/components/parameters/controlPlaneId'
put:
operationId: upsert-ca_certificate
summary: Upsert a CA Certificate
description: Create or Update CA Certificate using ID.
requestBody:
description: Description of the CA Certificate
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CACertificate'
responses:
'200':
description: Successfully upserted CA Certificate
content:
application/json:
schema:
$ref: '#/components/schemas/CACertificate'
'401':
$ref: '#/components/responses/HTTP401Error'
tags:
- CA Certificates
/v2/control-planes/{controlPlaneId}/core-entities/certificates:
get:
operationId: list-certificate
summary: List all Certificates
description: List all Certificates
parameters:
- $ref: '#/components/parameters/PaginationSize'
- $ref: '#/components/parameters/PaginationOffset'
- $ref: '#/components/parameters/PaginationTagsFilter'
responses:
'200':
description: A successful response listing Certificates
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Certificate'
next:
$ref: '#/components/schemas/PaginationNextResponse'
offset:
$ref: '#/components/schemas/PaginationOffsetResponse'
'401':
$ref: '#/components/responses/HTTP401Error'
tags:
- Certificates
parameters:
- $ref: '#/components/parameters/controlPlaneId'
post:
operationId: create-certificate
summary: Create a new Certificate
description: Create a new Certificate
requestBody:
description: Description of the new Certificate for creation
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Certificate'
responses:
'201':
description: Successfully created Certificate
content:
application/json:
schema:
$ref: '#/components/schemas/Certificate'
'401':
$ref: '#/components/responses/HTTP401Error'
tags:
- Certificates
/v2/control-planes/{controlPlaneId}/core-entities/certificates/{CertificateId}:
delete:
operationId: delete-certificate
summary: Delete a Certificate
description: Delete a Certificate
parameters:
- $ref: '#/components/parameters/CertificateId'
responses:
'204':
description: Successfully deleted Certificate or the resource didn't exist
'401':
$ref: '#/components/responses/HTTP401Error'
tags:
- Certificates
get:
operationId: get-certificate
summary: Fetch a Certificate
description: Get a Certificate using ID.
responses:
'200':
description: Successfully fetched Certificate
content:
application/json:
schema:
$ref: '#/components/schemas/Certificate'
'401':
$ref: '#/components/responses/HTTP401Error'
'404':
description: Resource does not exist
tags:
- Certificates
parameters:
- $ref: '#/components/parameters/CertificateId'
- $ref: '#/components/parameters/controlPlaneId'
put:
operationId: upsert-certificate
summary: Upsert a Certificate
description: Create or Update Certificate using ID.
requestBody:
description: Description of the Certificate
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Certificate'
responses:
'200':
description: Successfully upserted Certificate
content:
application/json:
schema:
$ref: '#/components/schemas/Certificate'
'401':
$ref: '#/components/responses/HTTP401Error'
tags:
- Certificates
/v2/control-planes/{controlPlaneId}/core-entities/certificates/{CertificateId}/snis:
get:
operationId: list-sni-with-certificate
summary: List all SNIs associated with a Certificate
description: List all SNIs associated with a Certificate
parameters:
- $ref: '#/components/parameters/CertificateId'
- $ref: '#/components/parameters/PaginationSize'
- $ref: '#/components/parameters/PaginationOffset'
- $ref: '#/components/parameters/PaginationTagsFilter'
responses:
'200':
description: A successful response listing SNIs
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SNI'
next:
$ref: '#/components/schemas/PaginationNextResponse'
offset:
$ref: '#/components/schemas/PaginationOffsetResponse'
tags:
- SNIs
parameters:
- $ref: '#/components/parameters/controlPlaneId'
post:
operationId: create-sni-with-certificate
summary: Create a new SNI associated with a Certificate
description: Create a new SNI associated with a Certificate
parameters:
- $ref: '#/components/parameters/CertificateId'
requestBody:
description: Description of new SNI for creation
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SNIWithoutParents'
responses:
'201':
description: Successfully created SNI
content:
application/json:
schema:
$ref: '#/components/schemas/SNI'
tags:
- SNIs
/v2/control-planes/{controlPlaneId}/core-entities/certificates/{CertificateId}/snis/{SNIId}:
delete:
operationId: delete-sni-with-certificate
summary: Delete a an SNI associated with a Certificate
description: Delete a an SNI associated with a Certificate using ID or name.
parameters:
- $ref: '#/components/parameters/CertificateId'
- $ref: '#/components/parameters/SNIId'
responses:
'204':
description: Successfully deleted SNI or the resource didn't exist
tags:
- SNIs
get:
operationId: get-sni-with-certificate
summary: Fetch an SNI associated with a Certificate
description: Get an SNI associated with a Certificate using ID or name.
parameters:
- $ref: '#/components/parameters/CertificateId'
- $ref: '#/components/parameters/SNIId'
responses:
'200':
description: Successfully fetched SNI
content:
application/json:
schema:
$ref: '#/components/schemas/SNI'
'404':
description: Resource does not exist
tags:
- SNIs
parameters:
- $ref: '#/components/parameters/controlPlaneId'
put:
operationId: upsert-sni-with-certificate
summary: Upsert an SNI associated with a Certificate
description: Create or Update an SNI associated with a Certificate using ID or name.
parameters:
- $ref: '#/components/parameters/CertificateId'
- $ref: '#/components/parameters/SNIId'
requestBody:
description: Description of the SNI
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SNIWithoutParents'
responses:
'200':
description: Successfully upserted SNI
content:
application/json:
schema:
$ref: '#/components/schemas/SNI'
tags:
- SNIs
/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups:
get:
operationId: list-consumer_group
summary: List all Consumer Groups
description: List all Consumer Groups
parameters:
- $ref: '#/components/parameters/PaginationSize'
- $ref: '#/components/parameters/PaginationOffset'
- $ref: '#/components/parameters/PaginationTagsFilter'
responses:
'200':
description: A successful response listing Consumer Groups
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ConsumerGroup'
next:
$ref: '#/components/schemas/PaginationNextResponse'
offset:
$ref: '#/components/schemas/PaginationOffsetResponse'
'401':
$ref: '#/components/responses/HTTP401Error'
tags:
- Consumer Groups
parameters:
- $ref: '#/components/parameters/controlPlaneId'
post:
operationId: create-consumer_group
summary: Create a new Consumer Group
description: Create a new Consumer Group
requestBody:
description: Description of the new Consumer Group for creation
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConsumerGroup'
responses:
'201':
description: Successfully created Consumer Group
content:
application/json:
schema:
$ref: '#/components/schemas/ConsumerGroup'
'401':
$ref: '#/components/responses/HTTP401Error'
tags:
- Consumer Groups
/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}:
delete:
operationId: delete-consumer_group
summary: Delete a Consumer Group
description: Delete a Consumer Group
parameters:
- $ref: '#/components/parameters/ConsumerGroupId'
responses:
'204':
description: Successfully deleted Consumer Group or the resource didn't exist
'401':
$ref: '#/components/responses/HTTP401Error'
tags:
- Consumer Groups
get:
operationId: get-consumer_group
summary: Fetch a Consumer Group
description: Get a Consumer Group using ID.
responses:
'200':
description: Successfully fetched Consumer Group
content:
application/json:
schema:
$ref: '#/components/schemas/ConsumerGroupInsideWrapper'
'401':
$ref: '#/components/responses/HTTP401Error'
'404':
description: Resource does not exist
tags:
- Consumer Groups
parameters:
- $ref: '#/components/parameters/ConsumerGroupId'
- $ref: '#/components/parameters/controlPlaneId'
put:
operationId: upsert-consumer_group
summary: Upsert a Consumer Group
description: Create or Update Consumer Group using ID.
requestBody:
description: Description of the Consumer Group
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ConsumerGroup'
responses:
'200':
description: Successfully upserted Consumer Group
content:
application/json:
schema:
$ref: '#/components/schemas/ConsumerGroup'
'401':
$ref: '#/components/responses/HTTP401Error'
tags:
- Consumer Groups
/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}/consumers:
delete:
operationId: remove-all-consumers-from-consumer-group
summary: Remove consumers from consumer group
description: >-
Removes all consumers from a consumer groups. This operation does not
delete the consumer group.
responses:
'204':
description: Consumers removed from group
'404':
description: Consumer group or consumer association does not exist
tags:
- Consumer Groups
get:
operationId: list-consumers-for-consumer-group
summary: List all Consumers in a Consumer Group
description: List all consumers in a consumer group
parameters:
- $ref: '#/components/parameters/PaginationSize'
- $ref: '#/components/parameters/PaginationOffset'
- $ref: '#/components/parameters/PaginationTagsFilter'
responses:
'200':
description: A successful response listing of consumers
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Consumer'
next:
$ref: '#/components/schemas/PaginationNextResponse'
offset:
$ref: '#/components/schemas/PaginationOffsetResponse'
tags:
- Consumer Groups
parameters:
- $ref: '#/components/parameters/ConsumerGroupIdManageConsumers'
- $ref: '#/components/parameters/controlPlaneId'
post:
x-speakeasy-entity-operation: GatewayConsumerGroupMember#create
operationId: add-consumer-to-group
summary: Add consumer to consumer group
description: Add a consumer to a consumer group
requestBody:
content:
application/json:
schema:
type: object
properties:
consumer:
type: string
example: cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b
x-speakeasy-name-override: consumer_id
responses:
'201':
description: Consumer added to group
content:
application/json:
schema:
type: object
properties:
consumer_group:
$ref: '#/components/schemas/ConsumerGroup'
consumers:
type: array
items:
$ref: '#/components/schemas/Consumer'
tags:
- Consumer Groups
/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}/consumers/{ConsumerId}:
delete:
x-speakeasy-entity-operation: GatewayConsumerGroupMember#delete
operationId: remove-consumer-from-group
summary: Remove consumer from consumer group
description: Remove a consumer from a consumer group
responses:
'204':
description: Consumer removed from group
tags:
- Consumer Groups
parameters:
- $ref: '#/components/parameters/ConsumerGroupIdManageConsumers'
- name: ConsumerId
in: path
required: true
schema:
type: string
- $ref: '#/components/parameters/controlPlaneId'
/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}/plugins:
get:
operationId: list-plugin-with-consumer_group
summary: List all Plugins associated with a Consumer Group
description: List all Plugins associated with a Consumer Group
parameters:
- $ref: '#/components/parameters/ConsumerGroupId'
- $ref: '#/components/parameters/PaginationSize'
- $ref: '#/components/parameters/PaginationOffset'
- $ref: '#/components/parameters/PaginationTagsFilter'
responses:
'200':
description: A successful response listing Plugins
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Plugin'
next:
$ref: '#/components/schemas/PaginationNextResponse'
offset:
$ref: '#/components/schemas/PaginationOffsetResponse'
tags:
- Plugins
parameters:
- $ref: '#/components/parameters/controlPlaneId'
post:
operationId: create-plugin-with-consumer_group
summary: Create a new Plugin associated with a Consumer Group
description: Create a new Plugin associated with a Consumer Group
parameters:
- $ref: '#/components/parameters/ConsumerGroupId'
requestBody:
description: Description of new Plugin for creation
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PluginWithoutParents'
responses:
'201':
description: Successfully created Plugin
content:
application/json:
schema:
$ref: '#/components/schemas/Plugin'
tags:
- Plugins
/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}/plugins/{PluginId}:
delete:
operationId: delete-plugin-with-consumer_group
summary: Delete a a Plugin associated with a Consumer Group
description: Delete a a Plugin associated with a Consumer Group using ID.
parameters:
- $ref: '#/components/parameters/ConsumerGroupId'
- $ref: '#/components/parameters/PluginId'
responses:
'204':
description: Successfully deleted Plugin or the resource didn't exist
tags:
- Plugins
get:
operationId: get-plugin-with-consumer_group
summary: Fetch a Plugin associated with a Consumer Group
description: Get a Plugin associated with a Consumer Group using ID.
parameters: