-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathcloud-dataplane.yaml
More file actions
8274 lines (8231 loc) · 271 KB
/
Copy pathcloud-dataplane.yaml
File metadata and controls
8274 lines (8231 loc) · 271 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
components:
schemas:
ACL.Operation:
description: The operation that is allowed or denied (e.g. READ).
enum:
- OPERATION_ANY
- OPERATION_ALL
- OPERATION_READ
- OPERATION_WRITE
- OPERATION_CREATE
- OPERATION_DELETE
- OPERATION_ALTER
- OPERATION_DESCRIBE
- OPERATION_CLUSTER_ACTION
- OPERATION_DESCRIBE_CONFIGS
- OPERATION_ALTER_CONFIGS
- OPERATION_IDEMPOTENT_WRITE
- OPERATION_CREATE_TOKENS
- OPERATION_DESCRIBE_TOKENS
type: string
ACLAccessFilter:
properties:
host:
title: |-
The host to match. If not set, will default to match all hosts
with the specified `operation` and `permission_type`. Note that
the asterisk `*` is literal and matches hosts that are set to `*`
type: string
operation:
$ref: '#/components/schemas/ACLOperation'
permission_type:
$ref: '#/components/schemas/ACLPermissionType'
principal:
title: |-
The name of the principal, if not set will default to match
all principals with the specified `operation` and `permission_type`
type: string
title: Filter an ACL based on its access
type: object
ACLFilter:
properties:
access_filter:
$ref: '#/components/schemas/ACLAccessFilter'
resource_filter:
$ref: '#/components/schemas/ACLResourceFilter'
title: A filter for ACLs
type: object
ACLOperation:
enum:
- ACL_OPERATION_ANY
- ACL_OPERATION_READ
- ACL_OPERATION_WRITE
- ACL_OPERATION_CREATE
- ACL_OPERATION_REMOVE
- ACL_OPERATION_ALTER
- ACL_OPERATION_DESCRIBE
- ACL_OPERATION_CLUSTER_ACTION
- ACL_OPERATION_DESCRIBE_CONFIGS
- ACL_OPERATION_ALTER_CONFIGS
- ACL_OPERATION_IDEMPOTENT_WRITE
title: The ACL operation to match
type: string
ACLPattern:
description: |-
- ACL_PATTERN_ANY: Wildcard to match any pattern
- ACL_PATTERN_LITERAL: Match a literal string
- ACL_PATTERN_PREFIXED: Match a prefix
- ACL_PATTERN_PREFIX: Match a prefix
- ACL_PATTERN_MATCH: Match serves as a catch-all for all the names of a topic
the principal is authorized to access
enum:
- ACL_PATTERN_ANY
- ACL_PATTERN_LITERAL
- ACL_PATTERN_PREFIXED
- ACL_PATTERN_PREFIX
- ACL_PATTERN_MATCH
title: The ACL pattern type
type: string
ACLPermissionType:
enum:
- ACL_PERMISSION_TYPE_ANY
- ACL_PERMISSION_TYPE_ALLOW
- ACL_PERMISSION_TYPE_DENY
title: ACL permission types
type: string
ACLResource:
description: |-
- ACL_RESOURCE_ANY: Wildcard for selecting any ACL resource
- ACL_RESOURCE_CLUSTER: Cluster wide resource
- ACL_RESOURCE_GROUP: Consumer group resource
- ACL_RESOURCE_TOPIC: Topic resource
- ACL_RESOURCE_TXN_ID: Transaction ID resource
- ACL_RESOURCE_SR_SUBJECT: Schema Registry subject resource
- ACL_RESOURCE_SR_REGISTRY: Schema Registry wide resource
- ACL_RESOURCE_SR_ANY: Wildcard to match any SR ACL resource
enum:
- ACL_RESOURCE_ANY
- ACL_RESOURCE_CLUSTER
- ACL_RESOURCE_GROUP
- ACL_RESOURCE_TOPIC
- ACL_RESOURCE_TXN_ID
- ACL_RESOURCE_SR_SUBJECT
- ACL_RESOURCE_SR_REGISTRY
- ACL_RESOURCE_SR_ANY
title: The ACL resource types
type: string
ACLResourceFilter:
properties:
name:
title: |-
Name, if not given will default to match all items in `resource_type`.
Note that asterisk `*` is literal and matches resource ACLs
that are named `*`
type: string
pattern_type:
$ref: '#/components/schemas/ACLPattern'
resource_type:
$ref: '#/components/schemas/ACLResource'
title: A filter to match ACLs for resources
type: object
Action:
enum:
- ACTION_PREPARE
- ACTION_EXECUTE
- ACTION_FINISH
- ACTION_CANCEL
type: string
AddPartitionsToTopicsRequest:
properties:
partition_count:
description: The number of partitions to add for the topics.
format: int32
type: integer
topic_names:
description: The topic names.
items:
type: string
type: array
validate_only:
description: Validate the request only, do not execute it.
type: boolean
type: object
AddPartitionsToTopicsResponse:
properties:
statuses:
description: The status of the operation for each topic.
items:
$ref: '#/components/schemas/AlterTopicPartitionStatus'
type: array
type: object
AddTopicPartitionsBody:
properties:
partition_count:
description: The number of partitions to add to the topic.
format: int32
type: integer
validate_only:
description: Validate the request only, do not execute it.
type: boolean
type: object
AddTopicPartitionsResponse:
type: object
AlterTopicPartitionStatus:
properties:
error:
description: The error if any.
type: string
success:
description: Whether the operation was successful.
type: boolean
topic_name:
description: The topic name.
type: string
type: object
AnnotatedOption:
properties:
description:
type: string
value:
type: string
title: AnnotatedOption represents an annotated option
type: object
AuthenticationConfiguration:
properties:
plain_configuration:
$ref: '#/components/schemas/PlainConfig'
scram_configuration:
$ref: '#/components/schemas/ScramConfig'
title: |-
Authentication config. Supports:
* SASL/SCRAM
* SASL/PLAIN
type: object
AuthenticationInfo:
properties:
mechanism:
$ref: '#/components/schemas/AuthenticationMechanism'
state:
$ref: '#/components/schemas/AuthenticationState'
user_principal:
title: Authenticated user principal
type: string
title: Other Messages
type: object
AuthenticationMechanism:
enum:
- AUTHENTICATION_MECHANISM_MTLS
- AUTHENTICATION_MECHANISM_SASL_SCRAM
- AUTHENTICATION_MECHANISM_SASL_OAUTHBEARER
- AUTHENTICATION_MECHANISM_SASL_PLAIN
- AUTHENTICATION_MECHANISM_SASL_GSSAPI
title: |-
- AUTHENTICATION_MECHANISM_MTLS: Mutual TLS using client certificates
- AUTHENTICATION_MECHANISM_SASL_SCRAM: SASL SCRAM
- AUTHENTICATION_MECHANISM_SASL_OAUTHBEARER: SASL OAUTHBEARER (OAuth 2.0 / OpenID Connect)
- AUTHENTICATION_MECHANISM_SASL_PLAIN: SASL PLAIN (username/password in plaintext)
- AUTHENTICATION_MECHANISM_SASL_GSSAPI: SASL GSSAPI (Kerberos)
type: string
AuthenticationState:
enum:
- AUTHENTICATION_STATE_UNAUTHENTICATED
- AUTHENTICATION_STATE_SUCCESS
- AUTHENTICATION_STATE_FAILURE
type: string
BadRequest:
description: |-
Describes violations in a client request. This error type focuses on the
syntactic aspects of the request.
properties:
field_violations:
description: Describes all violations in a client request.
items:
$ref: '#/components/schemas/FieldViolation'
type: array
title: BadRequest
type: object
BatchDeleteQuotaRequest:
properties:
deletions:
items:
$ref: '#/components/schemas/QuotaDeletion'
type: array
type: object
BatchDeleteQuotaResponse:
properties:
failed_entities:
items:
$ref: '#/components/schemas/FailedEntity'
type: array
successful_entities:
items:
$ref: '#/components/schemas/SuccessfulEntity'
type: array
type: object
BatchSetQuotaRequest:
properties:
settings:
description: |-
A list of quota settings to apply. Each setting pairs an entity
with the specific values to be set for it.
items:
$ref: '#/components/schemas/QuotaSetting'
type: array
type: object
BatchSetQuotaResponse:
properties:
failed_entities:
items:
$ref: '#/components/schemas/FailedEntity'
type: array
successful_entities:
items:
$ref: '#/components/schemas/SuccessfulEntity'
type: array
type: object
BloblangFunctionSpec:
description: BloblangFunctionSpec represents a Bloblang function specification.
properties:
categories:
items:
type: string
type: array
description:
type: string
examples:
items:
type: string
type: array
name:
type: string
params:
$ref: '#/components/schemas/ParamSpec'
status:
type: string
version:
type: string
type: object
BloblangMethodSpec:
description: BloblangMethodSpec represents a Bloblang method specification.
properties:
categories:
items:
type: string
type: array
description:
type: string
examples:
items:
type: string
type: array
name:
type: string
params:
$ref: '#/components/schemas/ParamSpec'
status:
type: string
version:
type: string
type: object
ComponentList:
description: ComponentList contains the structured component data.
properties:
bloblang_functions:
items:
$ref: '#/components/schemas/BloblangFunctionSpec'
type: array
bloblang_methods:
items:
$ref: '#/components/schemas/BloblangMethodSpec'
type: array
buffers:
items:
$ref: '#/components/schemas/ComponentSpec'
type: array
caches:
items:
$ref: '#/components/schemas/ComponentSpec'
type: array
inputs:
items:
$ref: '#/components/schemas/ComponentSpec'
type: array
metrics:
items:
$ref: '#/components/schemas/ComponentSpec'
type: array
outputs:
items:
$ref: '#/components/schemas/ComponentSpec'
type: array
processors:
items:
$ref: '#/components/schemas/ComponentSpec'
type: array
rate_limits:
items:
$ref: '#/components/schemas/ComponentSpec'
type: array
scanners:
items:
$ref: '#/components/schemas/ComponentSpec'
type: array
tracers:
items:
$ref: '#/components/schemas/ComponentSpec'
type: array
version:
type: string
type: object
ComponentSpec:
description: ComponentSpec represents a component specification.
properties:
categories:
items:
type: string
type: array
config:
$ref: '#/components/schemas/FieldSpec'
description:
type: string
examples:
items:
type: string
type: array
footnotes:
type: string
name:
type: string
status:
$ref: '#/components/schemas/ComponentStatus'
summary:
type: string
type:
type: string
version:
type: string
type: object
ComponentStatus:
description: ComponentStatus represents the stability level of a component.
enum:
- COMPONENT_STATUS_STABLE
- COMPONENT_STATUS_BETA
- COMPONENT_STATUS_EXPERIMENTAL
- COMPONENT_STATUS_DEPRECATED
type: string
ComponentType:
description: Component type for this tool.
enum:
- COMPONENT_TYPE_PROCESSOR
- COMPONENT_TYPE_CACHE
- COMPONENT_TYPE_INPUT
- COMPONENT_TYPE_OUTPUT
type: string
Config:
properties:
name:
description: A topic-level config key (e.g. `segment.bytes`).
type: string
value:
description: A topic-level config value (e.g. 1073741824).
nullable: true
type: string
type: object
ConfigAlterOperation:
enum:
- CONFIG_ALTER_OPERATION_SET
- CONFIG_ALTER_OPERATION_DELETE
- CONFIG_ALTER_OPERATION_APPEND
- CONFIG_ALTER_OPERATION_SUBTRACT
type: string
ConfigSource:
enum:
- CONFIG_SOURCE_DYNAMIC_TOPIC_CONFIG
- CONFIG_SOURCE_DYNAMIC_BROKER_CONFIG
- CONFIG_SOURCE_DYNAMIC_DEFAULT_BROKER_CONFIG
- CONFIG_SOURCE_STATIC_BROKER_CONFIG
- CONFIG_SOURCE_DEFAULT_CONFIG
- CONFIG_SOURCE_DYNAMIC_BROKER_LOGGER_CONFIG
type: string
ConfigSynonym:
properties:
name:
type: string
source:
$ref: '#/components/schemas/ConfigSource'
value:
nullable: true
type: string
type: object
ConfigType:
enum:
- CONFIG_TYPE_BOOLEAN
- CONFIG_TYPE_STRING
- CONFIG_TYPE_INT
- CONFIG_TYPE_SHORT
- CONFIG_TYPE_LONG
- CONFIG_TYPE_DOUBLE
- CONFIG_TYPE_LIST
- CONFIG_TYPE_CLASS
- CONFIG_TYPE_PASSWORD
type: string
Configuration:
properties:
config_synonyms:
description: |-
If no config value is set at the topic level, it will inherit the value
set at the broker or cluster level. `name` is the corresponding config
key whose value is inherited. `source` indicates whether the inherited
config is default, broker, etc.
items:
$ref: '#/components/schemas/ConfigSynonym'
type: array
documentation:
description: Config documentation.
nullable: true
type: string
name:
description: A topic-level config key (e.g. `segment.bytes`).
type: string
read_only:
description: Whether the config is read-only, or is dynamic and can be altered.
type: boolean
sensitive:
description: Whether this is a sensitive config key and value.
type: boolean
source:
$ref: '#/components/schemas/ConfigSource'
type:
$ref: '#/components/schemas/ConfigType'
value:
description: A topic-level config value (e.g. 1073741824).
nullable: true
type: string
type: object
ConfigurationYAMLSchema:
properties:
component_type:
$ref: '#/components/schemas/ComponentType'
config_schema:
description: JSON schema of the configuration components that are allowed for MCP servers.
type: string
type: object
ConnectCluster:
properties:
address:
description: The host address of the Kafka Connect cluster.
type: string
info:
$ref: '#/components/schemas/ConnectCluster.Info'
name:
description: Unique name of connect cluster. For Redpanda Cloud, the value is `redpanda`.
type: string
plugins:
items:
$ref: '#/components/schemas/ConnectorPlugin'
type: array
type: object
ConnectCluster.Info:
properties:
commit:
description: The git commit ID of the connect worker source code.
type: string
kafka_cluster_id:
description: Cluster ID.
type: string
version:
description: Connect worker version.
type: string
type: object
Connector:
properties:
state:
description: State of the connector instance.
type: string
trace:
description: String value of stack trace.
type: string
worker_id:
description: ID of worker that the connector is assigned to.
type: string
type: object
ConnectorError:
properties:
content:
description: Detailed description of the error.
type: string
title:
description: Short description of the error.
type: string
type:
$ref: '#/components/schemas/ConnectorError.Type'
title: |-
ConnectorError is the error of a connector, this is holistic error
abstraction, made parsing the error trace of connector or Task
type: object
ConnectorError.Type:
description: Error level.
enum:
- TYPE_ERROR
- TYPE_WARNING
type: string
ConnectorHolisticState:
description: |-
State of a connector or one of its tasks, as described in the [Kafka Connect documentation](https://kafka.apache.org/documentation.html#connect_administration). Takes into account not just the state of the connector instance itself, but also the tasks within the connector.
- CONNECTOR_HOLISTIC_STATE_PAUSED: The connector or task has been administratively paused.
- CONNECTOR_HOLISTIC_STATE_RESTARTING: The connector or task is restarting.
- CONNECTOR_HOLISTIC_STATE_DESTROYED: The connector is destroyed, regardless of any tasks.
- CONNECTOR_HOLISTIC_STATE_STOPPED: The connector or task has been stopped.
- CONNECTOR_HOLISTIC_STATE_UNASSIGNED: - The connector or task has not yet been assigned to a worker,
- THe connector is running, but there are unassigned tasks.
- CONNECTOR_HOLISTIC_STATE_HEALTHY: The connector is running, > 0 tasks, all of them in running state.
- CONNECTOR_HOLISTIC_STATE_UNHEALTHY: - The connector has failed,
- The connector is running, but has no tasks,
- Connector is running and has tasks, but all tasks have failed.
- CONNECTOR_HOLISTIC_STATE_DEGRADED: The connector is running and has tasks, and at least one task, but not all, have failed.
- CONNECTOR_HOLISTIC_STATE_UNKNOWN: The connector or task state could not be determined.
enum:
- CONNECTOR_HOLISTIC_STATE_PAUSED
- CONNECTOR_HOLISTIC_STATE_RESTARTING
- CONNECTOR_HOLISTIC_STATE_DESTROYED
- CONNECTOR_HOLISTIC_STATE_STOPPED
- CONNECTOR_HOLISTIC_STATE_UNASSIGNED
- CONNECTOR_HOLISTIC_STATE_HEALTHY
- CONNECTOR_HOLISTIC_STATE_UNHEALTHY
- CONNECTOR_HOLISTIC_STATE_DEGRADED
- CONNECTOR_HOLISTIC_STATE_UNKNOWN
type: string
ConnectorInfoStatus:
properties:
info:
$ref: '#/components/schemas/ConnectorSpec'
name:
description: Name of connector.
type: string
status:
$ref: '#/components/schemas/ConnectorStatus'
type: object
ConnectorPlugin:
properties:
class:
type: string
type:
type: string
version:
type: string
type: object
ConnectorSpec:
description: |-
Connector specifications as defined in the Kafka Connect
API. You may include this in the request body when creating a new connector.
properties:
config:
additionalProperties:
type: string
description: Connector configuration properties.
type: object
name:
description: Name of connector.
type: string
tasks:
items:
$ref: '#/components/schemas/TaskInfo'
readOnly: true
type: array
type:
readOnly: true
type: string
required:
- name
- config
type: object
ConnectorStatus:
properties:
connector:
$ref: '#/components/schemas/Connector'
errors:
description: List of parsed connectors' and tasks' errors.
items:
$ref: '#/components/schemas/ConnectorError'
type: array
holistic_state:
$ref: '#/components/schemas/ConnectorHolisticState'
name:
description: Name of connector.
type: string
tasks:
description: Status of connector tasks. For more information, see the [https://docs.redpanda.com/current/deploy/deployment-option/cloud/managed-connectors/monitor-connectors/#connector-tasks](Monitor Connectors) documentation.
items:
$ref: '#/components/schemas/TaskStatus'
type: array
type:
description: Type of connector (sink or source).
type: string
type: object
ConsumerOffsetSyncOptions:
properties:
effective_interval:
readOnly: true
title: The effective interval for the task
type: string
group_filters:
items:
$ref: '#/components/schemas/NameFilter'
title: The filters
type: array
interval:
title: |-
Sync interval
If 0 provided, defaults to 30 seconds
type: string
paused:
title: |-
Allows user to pause the consumer offset sync task. If paused, then
the task will enter the 'paused' state and not sync consumer offsets from
the source cluster
type: boolean
title: Options for syncing consumer offsets
type: object
CreateACLRequest:
properties:
host:
description: |-
The host address to use for this ACL. To allow a principal
access from multiple hosts, you must create an ACL for each host.
type: string
operation:
$ref: '#/components/schemas/ACL.Operation'
permission_type:
$ref: '#/components/schemas/PermissionType'
principal:
description: |-
The user for whom this ACL applies. With the Kafka simple
authorizer, you must include the prefix "User:" with the user name.
type: string
resource_name:
description: |-
The name of the resource this ACL targets.
For requests with resource_type CLUSTER, this will default to "kafka-cluster".
type: string
resource_pattern_type:
$ref: '#/components/schemas/ResourcePatternType'
resource_type:
$ref: '#/components/schemas/ResourceType'
required:
- resource_type
- resource_pattern_type
- principal
- host
- operation
- permission_type
type: object
CreateACLResponse:
type: object
CreateConnectorResponse:
properties:
connector:
$ref: '#/components/schemas/ConnectorSpec'
type: object
CreateKafkaConnectSecretBody:
description: CreateKafkaConnectSecretRequest is the request of CreateKafkaConnectSecret.
properties:
labels:
additionalProperties:
type: string
description: Secret labels.
type: object
name:
description: Name of connector.
type: string
secret_data:
description: The secret data. Must be Base64-encoded.
format: byte
type: string
required:
- name
- secret_data
type: object
CreateKafkaConnectSecretResponse:
description: CreateKafkaConnectSecretResponse is the response of CreateKafkaConnectSecret.
properties:
secret:
$ref: '#/components/schemas/Secret'
type: object
CreateMCPServerResponse:
properties:
mcp_server:
$ref: '#/components/schemas/MCPServer'
type: object
CreatePipelineResponse:
properties:
pipeline:
$ref: '#/components/schemas/Pipeline'
type: object
CreateRoleResponse:
description: CreateRoleResponse is the response for CreateRole.
properties:
role:
$ref: '#/components/schemas/Role'
type: object
CreateSecretRequest:
description: CreateSecretRequest is the request of CreateSecret.
properties:
id:
description: Secret identifier.
type: string
labels:
additionalProperties:
type: string
description: Secret labels.
type: object
scopes:
items:
$ref: '#/components/schemas/Scope'
title: Secret scopes
type: array
secret_data:
description: The secret data. Must be Base64-encoded.
format: byte
type: string
required:
- secret_data
type: object
CreateSecretResponse:
description: CreateSecretResponse is the response of CreateSecret.
properties:
secret:
$ref: '#/components/schemas/Secret'
type: object
CreateTopicRequest.Topic:
properties:
configs:
description: |-
An array of key-value config pairs for a topic.
These correspond to Kafka topic-level configs.
items:
$ref: '#/components/schemas/Config'
type: array
name:
description: Name of topic.
type: string
partition_count:
description: |-
The number of partitions to give the topic. If specifying
partitions manually (see `replica_assignments`), set to -1.
Or, to use the cluster default partition count, set to null.
format: int32
nullable: true
type: integer
replica_assignments:
description: |-
Manually specify broker ID assignments for partition replicas. If manually assigning replicas, both `replication_factor` and
`partition_count` must be -1.
items:
$ref: '#/components/schemas/ReplicaAssignment'
type: array
replication_factor:
description: |-
The number of replicas every partition must have.
If specifying partitions manually (see `replica_assignments`), set to -1.
Or, to use the cluster default replication factor, set to null.
format: int32
nullable: true
type: integer
type: object
CreateTopicResponse:
properties:
partition_count:
description: |-
The number of partitions created for the topic.
This field has a default value of -1, which may be returned if the broker
does not support v5+ of this request which added support for returning
this information.
format: int32
type: integer
replication_factor:
description: |-
The number of replicas per topic partition.
This field has a default of -1, which may be returned if the broker
does not support v5+ of this request which added support for returning
this information.
format: int32
type: integer
topic_name:
description: Name of topic.
type: string
type: object
CreateUserRequest.User:
properties:
mechanism:
$ref: '#/components/schemas/SASLMechanism'
name:
description: Username.
type: string
password:
description: Password.
type: string
type: object
CreateUserResponse:
properties:
user:
$ref: '#/components/schemas/CreateUserResponse.User'
type: object
CreateUserResponse.User:
properties:
mechanism:
$ref: '#/components/schemas/SASLMechanism'
name:
title: Name of newly-created user
type: string
type: object
DeleteACLsRequest.Filter:
properties:
host:
description: |-
The host address to use for this ACL. To allow a principal
access from multiple hosts, you must create an ACL for each host.
nullable: true
type: string
operation:
$ref: '#/components/schemas/ACL.Operation'
permission_type:
$ref: '#/components/schemas/PermissionType'
principal:
description: |-
The user for whom this ACL applies. With the Kafka simple
authorizer, you must include the prefix "User:" with the user name.
nullable: true
type: string
resource_name:
description: The name of the resource this ACL targets.
nullable: true
type: string
resource_pattern_type:
$ref: '#/components/schemas/ResourcePatternType'
resource_type:
$ref: '#/components/schemas/ResourceType'
required:
- resource_type
- resource_pattern_type
- operation
- permission_type
type: object
DeleteACLsResponse:
properties:
matching_acls:
items:
$ref: '#/components/schemas/MatchingACL'
type: array
type: object
DeleteKafkaConnectSecretResponse:
description: DeleteKafkaConnectSecretResponse is the response of DeleteKafkaConnectSecret.
type: object
DeleteMCPServerResponse:
type: object
DeleteMountTaskResponse:
type: object
DeletePipelineResponse:
type: object
DeleteQuotaRequest:
properties:
entity:
$ref: '#/components/schemas/RequestQuotaEntity'
value_type:
$ref: '#/components/schemas/ValueType'
type: object
DeleteQuotaResponse:
type: object
DeleteRoleResponse:
description: DeleteRoleResponse is the response for DeleteRole.
type: object
DeleteSecretResponse:
description: DeleteSecretResponse is the response of DeleteSecret.
type: object
DeleteTopicResponse:
type: object
DeleteTransformResponse:
type: object
DeleteUserResponse:
type: object
DeployTransformRequest:
description: |-
Metadata required to deploy a new Wasm
transform in a Redpanda cluster.
properties:
environment_variables:
description: The environment variables you want to apply to your transform's environment
items:
$ref: '#/components/schemas/EnvironmentVariable'
type: array
input_topic_name:
description: The input topic to apply the transform to.
example: orders
type: string
name:
description: Name of the transform.
example: redact-payment-details-in-orders
type: string
output_topic_names:
description: Output topic to write the transform results to.
example: orders-redacted
items:
type: string
type: array
required:
- name
- input_topic_name
- output_topic_names
type: object
EarliestOffset:
description: Start at the earliest offset in the partition.
type: object
Entity:
properties:
entity_name:
type: string
entity_type:
$ref: '#/components/schemas/EntityType'
type: object
EntityType:
description: |-
The type of entity that the quota applies to.
- ENTITY_TYPE_USER: Not supported in Redpanda
- ENTITY_TYPE_IP: Not supported in Redpanda
enum:
- ENTITY_TYPE_CLIENT_ID
- ENTITY_TYPE_CLIENT_ID_PREFIX
- ENTITY_TYPE_USER
- ENTITY_TYPE_IP
type: string
EnvironmentVariable:
properties:
key:
description: The key of your environment variable.
example: LOG_LEVEL
type: string
value:
description: The value of your environment variable.
example: DEBUG