diff --git a/providers/src/confluent/v00.00.00000/provider.yaml b/providers/src/confluent/v00.00.00000/provider.yaml
index eb1221c3..d69d4d14 100644
--- a/providers/src/confluent/v00.00.00000/provider.yaml
+++ b/providers/src/confluent/v00.00.00000/provider.yaml
@@ -92,15 +92,6 @@ providerServices:
title: iam API
version: v00.00.00000
description: confluent iam API
- kafka:
- id: kafka:v00.00.00000
- name: kafka
- preferred: true
- service:
- $ref: confluent/v00.00.00000/services/kafka.yaml
- title: kafka API
- version: v00.00.00000
- description: confluent kafka API
ksqldb_clusters:
id: ksqldb_clusters:v00.00.00000
name: ksqldb_clusters
@@ -191,15 +182,6 @@ providerServices:
title: schema_registry_clusters API
version: v00.00.00000
description: confluent schema_registry_clusters API
- share_group:
- id: share_group:v00.00.00000
- name: share_group
- preferred: true
- service:
- $ref: confluent/v00.00.00000/services/share_group.yaml
- title: share_group API
- version: v00.00.00000
- description: confluent share_group API
sql:
id: sql:v00.00.00000
name: sql
@@ -218,15 +200,6 @@ providerServices:
title: stream_sharing API
version: v00.00.00000
description: confluent stream_sharing API
- streams_group:
- id: streams_group:v00.00.00000
- name: streams_group
- preferred: true
- service:
- $ref: confluent/v00.00.00000/services/streams_group.yaml
- title: streams_group API
- version: v00.00.00000
- description: confluent streams_group API
sts:
id: sts:v00.00.00000
name: sts
diff --git a/providers/src/kafka/v00.00.00000/provider.yaml b/providers/src/kafka/v00.00.00000/provider.yaml
new file mode 100644
index 00000000..4b730ceb
--- /dev/null
+++ b/providers/src/kafka/v00.00.00000/provider.yaml
@@ -0,0 +1,36 @@
+id: kafka
+name: kafka
+version: v00.00.00000
+providerServices:
+ kafka:
+ id: kafka:v00.00.00000
+ name: kafka
+ preferred: true
+ service:
+ $ref: kafka/v00.00.00000/services/kafka.yaml
+ title: kafka API
+ version: v00.00.00000
+ description: Kafka REST v3 dataplane API
+ share_group:
+ id: share_group:v00.00.00000
+ name: share_group
+ preferred: true
+ service:
+ $ref: kafka/v00.00.00000/services/share_group.yaml
+ title: share_group API
+ version: v00.00.00000
+ description: kafka share_group API
+ streams_group:
+ id: streams_group:v00.00.00000
+ name: streams_group
+ preferred: true
+ service:
+ $ref: kafka/v00.00.00000/services/streams_group.yaml
+ title: streams_group API
+ version: v00.00.00000
+ description: kafka streams_group API
+config:
+ auth:
+ type: basic
+ username_var: KAFKA_API_KEY
+ password_var: KAFKA_API_SECRET
diff --git a/providers/src/confluent/v00.00.00000/services/kafka.yaml b/providers/src/kafka/v00.00.00000/services/kafka.yaml
similarity index 75%
rename from providers/src/confluent/v00.00.00000/services/kafka.yaml
rename to providers/src/kafka/v00.00.00000/services/kafka.yaml
index 4b0c18f7..4ebc6135 100644
--- a/providers/src/confluent/v00.00.00000/services/kafka.yaml
+++ b/providers/src/kafka/v00.00.00000/services/kafka.yaml
@@ -1,15 +1,17 @@
openapi: 3.0.0
info:
title: kafka API
- description: confluent kafka API
+ description: Kafka REST v3 dataplane API
version: 1.0.0
paths:
/kafka/v3/clusters/{cluster_id}:
get:
summary: Get Cluster
operationId: getKafkaCluster
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Return the Kafka cluster with the specified ``cluster_id``.
tags:
@@ -36,8 +38,10 @@ paths:
post:
summary: Batch Create ACLs
operationId: batchCreateKafkaAcls
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Create ACLs.
tags:
@@ -66,8 +70,10 @@ paths:
get:
summary: List ACLs
operationId: getKafkaAcls
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
- When calling `/acls` without the `principal` parameter, service
accounts are returned in numeric ID format (e.g., `User:12345`).
- To retrieve service accounts in the `sa-xxx` format, use
@@ -105,8 +111,10 @@ paths:
post:
summary: Create an ACL
operationId: createKafkaAcls
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Create an ACL.
tags:
@@ -134,8 +142,10 @@ paths:
delete:
summary: Delete ACLs
operationId: deleteKafkaAcls
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Delete the ACLs that match the search criteria.
tags:
@@ -169,11 +179,16 @@ paths:
get:
summary: List Dynamic Broker Configs
operationId: listKafkaClusterConfigs
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
- Return a list of dynamic cluster-wide broker configuration parameters for the specified Kafka
- cluster. Returns an empty list if there are no dynamic cluster-wide broker configuration parameters.
+ Return a list of dynamic cluster-wide broker configuration parameters
+ for the specified Kafka
+
+ cluster. Returns an empty list if there are no dynamic cluster-wide
+ broker configuration parameters.
tags:
- Configs (v3)
security:
@@ -198,10 +213,13 @@ paths:
post:
summary: Batch Alter Dynamic Broker Configs
operationId: updateKafkaClusterConfigs
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
- Update or delete a set of dynamic cluster-wide broker configuration parameters.
+
+ Update or delete a set of dynamic cluster-wide broker configuration
+ parameters.
tags:
- Configs (v3)
security:
@@ -228,10 +246,13 @@ paths:
get:
summary: Get Dynamic Broker Config
operationId: getKafkaClusterConfig
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
- Return the dynamic cluster-wide broker configuration parameter specified by ``name``.
+
+ Return the dynamic cluster-wide broker configuration parameter specified
+ by ``name``.
tags:
- Configs (v3)
security:
@@ -256,10 +277,13 @@ paths:
put:
summary: Update Dynamic Broker Config
operationId: updateKafkaClusterConfig
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
- Update the dynamic cluster-wide broker configuration parameter specified by ``name``.
+
+ Update the dynamic cluster-wide broker configuration parameter specified
+ by ``name``.
tags:
- Configs (v3)
security:
@@ -286,10 +310,13 @@ paths:
delete:
summary: Reset Dynamic Broker Config
operationId: deleteKafkaClusterConfig
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Reset the configuration parameter specified by ``name`` to its
+
default value by deleting a dynamic cluster-wide configuration.
tags:
- Configs (v3)
@@ -316,10 +343,13 @@ paths:
get:
summary: List Consumer Groups
operationId: listKafkaConsumerGroups
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Return the list of consumer groups that belong to the specified
+
Kafka cluster.
tags:
- Consumer Group (v3)
@@ -345,8 +375,10 @@ paths:
get:
summary: Get Consumer Group
operationId: getKafkaConsumerGroup
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Return the consumer group specified by the ``consumer_group_id``.
tags:
@@ -374,10 +406,13 @@ paths:
get:
summary: List Consumers
operationId: listKafkaConsumers
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Return a list of consumers that belong to the specified consumer
+
group.
tags:
- Consumer Group (v3)
@@ -404,10 +439,15 @@ paths:
get:
summary: Get Consumer Group Lag Summary
operationId: getKafkaConsumerGroupLagSummary
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy) [](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+ [](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster)
+
Return the maximum and total lag of the consumers belonging to the
+
specified consumer group.
tags:
- Consumer Group (v3)
@@ -434,10 +474,15 @@ paths:
get:
summary: List Consumer Lags
operationId: listKafkaConsumerLags
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy) [](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+ [](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster)
+
Return a list of consumer lags of the consumers belonging to the
+
specified consumer group.
tags:
- Consumer Group (v3)
@@ -464,8 +509,12 @@ paths:
get:
summary: Get Consumer Lag
operationId: getKafkaConsumerLag
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy) [](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+ [](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster)
+
Return the consumer lag on a partition with the given `partition_id`.
tags:
@@ -495,8 +544,10 @@ paths:
get:
summary: Get Consumer
operationId: getKafkaConsumer
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Return the consumer specified by the ``consumer_id``.
tags:
@@ -525,8 +576,10 @@ paths:
get:
summary: List Topics
operationId: listKafkaTopics
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Return the list of topics that belong to the specified Kafka cluster.
tags:
@@ -552,13 +605,21 @@ paths:
post:
summary: Create Topic
operationId: createKafkaTopic
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Create a topic.
- Also supports a dry-run mode that only validates whether the topic creation would succeed
- if the ``validate_only`` request property is explicitly specified and set to true. Note that
- when dry-run mode is being used the response status would be 200 OK instead of 201 Created.
+
+ Also supports a dry-run mode that only validates whether the topic
+ creation would succeed
+
+ if the ``validate_only`` request property is explicitly specified and
+ set to true. Note that
+
+ when dry-run mode is being used the response status would be 200 OK
+ instead of 201 Created.
tags:
- Topic (v3)
security:
@@ -587,8 +648,10 @@ paths:
get:
summary: Get Topic
operationId: getKafkaTopic
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Return the topic with the given `topic_name`.
tags:
@@ -618,11 +681,15 @@ paths:
patch:
summary: Update Partition Count
operationId: updatePartitionCountKafkaTopic
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Increase the number of partitions for a topic. To update other topic
- configurations, see https://docs.confluent.io/cloud/current/api.html#tag/Configs-(v3)/operation/updateKafkaTopicConfig.
+
+ configurations, see
+ https://docs.confluent.io/cloud/current/api.html#tag/Configs-(v3)/operation/updateKafkaTopicConfig.
tags:
- Topic (v3)
security:
@@ -637,7 +704,8 @@ paths:
'200':
$ref: '#/components/responses/GetTopicResponse'
'400':
- $ref: '#/components/responses/BadRequestErrorResponse_UpdatePartitionCountTopic'
+ $ref: >-
+ #/components/responses/BadRequestErrorResponse_UpdatePartitionCountTopic
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'403':
@@ -652,8 +720,10 @@ paths:
delete:
summary: Delete Topic
operationId: deleteKafkaTopic
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Delete the topic with the given `topic_name`.
tags:
@@ -683,10 +753,13 @@ paths:
get:
summary: List Topic Configs
operationId: listKafkaTopicConfigs
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
- Return the list of configuration parameters that belong to the specified topic.
+ Return the list of configuration parameters that belong to the specified
+ topic.
tags:
- Configs (v3)
security:
@@ -714,12 +787,18 @@ paths:
post:
summary: Batch Alter Topic Configs
operationId: updateKafkaTopicConfigBatch
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Update or delete a set of topic configuration parameters.
- Also supports a dry-run mode that only validates whether the operation would succeed if the
- ``validate_only`` request property is explicitly specified and set to true.
+
+ Also supports a dry-run mode that only validates whether the operation
+ would succeed if the
+
+ ``validate_only`` request property is explicitly specified and set to
+ true.
tags:
- Configs (v3)
security:
@@ -749,8 +828,10 @@ paths:
get:
summary: Get Topic Config
operationId: getKafkaTopicConfig
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Return the configuration parameter with the given `name`.
tags:
@@ -780,11 +861,15 @@ paths:
put:
summary: Update Topic Config
operationId: updateKafkaTopicConfig
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Update the configuration parameter with given `name`. To update the
+
number of partitions, see
+
https://docs.confluent.io/cloud/current/api.html#tag/Topic-(v3)/operation/updatePartitionCountKafkaTopic.
tags:
- Configs (v3)
@@ -815,10 +900,13 @@ paths:
delete:
summary: Reset Topic Config
operationId: deleteKafkaTopicConfig
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
- Reset the configuration parameter with given `name` to its default value.
+
+ Reset the configuration parameter with given `name` to its default
+ value.
tags:
- Configs (v3)
security:
@@ -847,8 +935,10 @@ paths:
get:
summary: List Partitions
operationId: listKafkaPartitions
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Return the list of partitions that belong to the specified topic.
tags:
@@ -878,8 +968,10 @@ paths:
get:
summary: Get Partition
operationId: getKafkaPartition
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Return the partition with the given `partition_id`.
tags:
@@ -910,10 +1002,14 @@ paths:
get:
summary: List All Topic Configs
operationId: listKafkaAllTopicConfigs
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
+
+ Return the list of configuration parameters for all topics hosted by the
+ specified
- Return the list of configuration parameters for all topics hosted by the specified
cluster.
tags:
- Configs (v3)
@@ -939,24 +1035,40 @@ paths:
post:
summary: Produce Records
operationId: produceRecord
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Produce records to the given topic, returning delivery reports for each
+
record produced. This API can be used in streaming mode by setting
+
"Transfer-Encoding: chunked" header. For as long as the connection is
+
kept open, the server will keep accepting records. Records are streamed
+
to and from the server as Concatenated JSON. For each record sent to the
+
server, the server will asynchronously send back a delivery report, in
+
the same order, each with its own error_code. An error_code of 200
+
indicates success. The HTTP status code will be HTTP 200 OK as long as
+
the connection is successfully established. To identify records that
+
have encountered an error, check the error_code of each delivery report.
- Note that the cluster_id is validated only when running in Confluent Cloud.
+
+ Note that the cluster_id is validated only when running in Confluent
+ Cloud.
+
This API currently does not support Schema Registry integration. Sending
+
schemas is not supported. Only BINARY, JSON, and STRING formats are
+
supported.
tags:
- Records (v3)
@@ -993,10 +1105,13 @@ paths:
get:
summary: List all cluster links in the dest cluster
operationId: listKafkaLinks
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
- ``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead.
+
+ ``link_id`` in ``ListLinksResponseData`` is deprecated and may be
+ removed in a future release. Use the new ``cluster_link_id`` instead.
tags:
- Cluster Linking (v3)
security:
@@ -1018,10 +1133,13 @@ paths:
post:
summary: Create a cluster link
operationId: createKafkaLink
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Cluster link creation requires source cluster security configurations in
+
the configs JSON section of the data request payload.
tags:
- Cluster Linking (v3)
@@ -1050,10 +1168,13 @@ paths:
get:
summary: Describe the cluster link
operationId: getKafkaLink
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
- ``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead.
+ ``link_id`` in ``ListLinksResponseData`` is deprecated and may be
+ removed in a future release. Use the new ``cluster_link_id`` instead.
tags:
- Cluster Linking (v3)
parameters:
@@ -1077,7 +1198,9 @@ paths:
delete:
summary: Delete the cluster link
operationId: deleteKafkaLink
- description: '[](#section/Versioning/API-Lifecycle-Policy)'
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
tags:
- Cluster Linking (v3)
security:
@@ -1103,10 +1226,13 @@ paths:
get:
summary: List New Topic Default Configs
operationId: listKafkaDefaultTopicConfigs
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
- List the default configuration parameters used if the topic were to be newly created.
+ List the default configuration parameters used if the topic were to be
+ newly created.
tags:
- Configs (v3)
security:
@@ -1132,7 +1258,9 @@ paths:
get:
summary: List all configs of the cluster link
operationId: listKafkaLinkConfigs
- description: '[](#section/Versioning/API-Lifecycle-Policy)'
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
tags:
- Cluster Linking (v3)
security:
@@ -1156,7 +1284,9 @@ paths:
get:
summary: Describe the config under the cluster link
operationId: getKafkaLinkConfigs
- description: '[](#section/Versioning/API-Lifecycle-Policy)'
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
tags:
- Cluster Linking (v3)
security:
@@ -1180,7 +1310,9 @@ paths:
put:
summary: Alter the config under the cluster link
operationId: updateKafkaLinkConfig
- description: '[](#section/Versioning/API-Lifecycle-Policy)'
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
tags:
- Cluster Linking (v3)
security:
@@ -1206,7 +1338,9 @@ paths:
delete:
summary: Reset the given config to default value
operationId: deleteKafkaLinkConfig
- description: '[](#section/Versioning/API-Lifecycle-Policy)'
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
tags:
- Cluster Linking (v3)
security:
@@ -1229,8 +1363,10 @@ paths:
- $ref: '#/components/parameters/LinkConfigName'
/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs:alter:
put:
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Batch Alter Cluster Link Configs
operationId: updateKafkaLinkConfigBatch
@@ -1261,10 +1397,13 @@ paths:
post:
summary: Create a mirror topic
operationId: createKafkaMirrorTopic
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
Create a topic in the destination cluster mirroring a topic in
+
the source cluster
tags:
- Cluster Linking (v3)
@@ -1290,8 +1429,10 @@ paths:
get:
summary: List mirror topics
operationId: listKafkaMirrorTopicsUnderLink
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
List all mirror topics under the link
tags:
@@ -1318,8 +1459,10 @@ paths:
get:
summary: List mirror topics
operationId: listKafkaMirrorTopics
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
List all mirror topics in the cluster
tags:
@@ -1345,7 +1488,9 @@ paths:
get:
summary: Describe the mirror topic
operationId: readKafkaMirrorTopic
- description: '[](#section/Versioning/API-Lifecycle-Policy)'
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
tags:
- Cluster Linking (v3)
parameters:
@@ -1371,7 +1516,9 @@ paths:
post:
summary: Promote the mirror topics
operationId: updateKafkaMirrorTopicsPromote
- description: '[](#section/Versioning/API-Lifecycle-Policy)'
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
tags:
- Cluster Linking (v3)
security:
@@ -1398,7 +1545,9 @@ paths:
post:
summary: Failover the mirror topics
operationId: updateKafkaMirrorTopicsFailover
- description: '[](#section/Versioning/API-Lifecycle-Policy)'
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
tags:
- Cluster Linking (v3)
security:
@@ -1425,7 +1574,9 @@ paths:
post:
summary: Pause the mirror topics
operationId: updateKafkaMirrorTopicsPause
- description: '[](#section/Versioning/API-Lifecycle-Policy)'
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
tags:
- Cluster Linking (v3)
security:
@@ -1452,7 +1603,9 @@ paths:
post:
summary: Resume the mirror topics
operationId: updateKafkaMirrorTopicsResume
- description: '[](#section/Versioning/API-Lifecycle-Policy)'
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
tags:
- Cluster Linking (v3)
security:
@@ -1479,7 +1632,9 @@ paths:
post:
summary: Reverse the local mirror topic and start the remote mirror topic
operationId: updateKafkaMirrorTopicsReverseAndStartMirror
- description: '[](#section/Versioning/API-Lifecycle-Policy)'
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
tags:
- Cluster Linking (v3)
security:
@@ -1506,7 +1661,9 @@ paths:
post:
summary: Reverse the local mirror topic and Pause the remote mirror topic
operationId: updateKafkaMirrorTopicsReverseAndPauseMirror
- description: '[](#section/Versioning/API-Lifecycle-Policy)'
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
tags:
- Cluster Linking (v3)
security:
@@ -1531,9 +1688,14 @@ paths:
- $ref: '#/components/parameters/ValidateOnly'
/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:truncate-and-restore:
post:
- summary: Truncates the local topic to the remote stopped mirror log end offsets and restores mirroring to the local topic to mirror from the remote topic
+ summary: >-
+ Truncates the local topic to the remote stopped mirror log end offsets
+ and restores mirroring to the local topic to mirror from the remote
+ topic
operationId: updateKafkaMirrorTopicsTruncateAndRestoreMirror
- description: '[](#section/Versioning/API-Lifecycle-Policy)'
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
tags:
- Cluster Linking (v3)
security:
@@ -1561,10 +1723,13 @@ paths:
get:
summary: List all configs of the group
operationId: listKafkaGroupConfigs
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
- List all configurations for the specified group. This API supports consumer groups, share groups, and streams groups.
+ List all configurations for the specified group. This API supports
+ consumer groups, share groups, and streams groups.
tags:
- Configs (v3)
security:
@@ -1590,10 +1755,13 @@ paths:
get:
summary: Get group config
operationId: getKafkaGroupConfig
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
- Get the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups.
+ Get the configuration with the specified name for the specified group.
+ This API supports consumer groups, share groups, and streams groups.
tags:
- Configs (v3)
security:
@@ -1619,10 +1787,14 @@ paths:
put:
summary: Update group config
operationId: updateKafkaGroupConfig
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
- Update the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups.
+ Update the configuration with the specified name for the specified
+ group. This API supports consumer groups, share groups, and streams
+ groups.
tags:
- Configs (v3)
security:
@@ -1650,10 +1822,15 @@ paths:
delete:
summary: Delete group config
operationId: deleteKafkaGroupConfig
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
- Delete the dynamic configuration override with the specified name for the specified group. After deletion, the default group configuration will be applied. This API supports consumer groups, share groups, and streams groups.
+ Delete the dynamic configuration override with the specified name for
+ the specified group. After deletion, the default group configuration
+ will be applied. This API supports consumer groups, share groups, and
+ streams groups.
tags:
- Configs (v3)
security:
@@ -1680,10 +1857,13 @@ paths:
post:
summary: Batch Alter Group Configs
operationId: updateKafkaGroupConfigBatch
- description: |-
- [](#section/Versioning/API-Lifecycle-Policy)
+ description: >-
+ [](#section/Versioning/API-Lifecycle-Policy)
+
- Batch alter configurations for the specified group. This API supports consumer groups, share groups, and streams groups.
+ Batch alter configurations for the specified group. This API supports
+ consumer groups, share groups, and streams groups.
tags:
- Configs (v3)
security:
@@ -1760,23 +1940,36 @@ components:
type: string
maxLength: 255
status:
- description: The HTTP status code applicable to this problem, expressed as a string value.
+ description: >-
+ The HTTP status code applicable to this problem, expressed as a
+ string value.
type: string
code:
description: An application-specific error code, expressed as a string value.
type: string
title:
- description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization.
+ description: >-
+ A short, human-readable summary of the problem. It **SHOULD NOT**
+ change from occurrence to occurrence of the problem, except for
+ purposes of localization.
type: string
detail:
- description: A human-readable explanation specific to this occurrence of the problem.
+ description: >-
+ A human-readable explanation specific to this occurrence of the
+ problem.
type: string
source:
type: object
- description: If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it.
+ description: >-
+ If this error was caused by a particular part of the API request,
+ the source will point to the query string parameter or request body
+ property that caused it.
properties:
pointer:
- description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/spec" for a spec object, or "/spec/title" for a specific field].
+ description: >-
+ A JSON Pointer [RFC6901] to the associated entity in the request
+ document [e.g. "/spec" for a spec object, or "/spec/title" for a
+ specific field].
type: string
parameter:
description: A string indicating which query parameter caused the error.
@@ -2442,7 +2635,11 @@ components:
description: The expected remote cluster ID.
type: string
cluster_link_id:
- description: The expected cluster link ID. Can be provided when creating the second side of a bidirectional link for validating the link ID is as expected. If it's not provided, it's inferred from the remote cluster.
+ description: >-
+ The expected cluster link ID. Can be provided when creating the
+ second side of a bidirectional link for validating the link ID is as
+ expected. If it's not provided, it's inferred from the remote
+ cluster.
type: string
configs:
items:
@@ -3103,75 +3300,114 @@ components:
example:
kind: KafkaCluster
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1
resource_name: crn:///kafka=cluster-1
cluster_id: cluster-1
controller:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1
acls:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls
brokers:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers
broker_configs:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs
consumer_groups:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups
topics:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics
partition_reassignments:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/-/partitions/-/reassignment
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/-/partitions/-/reassignment
BadRequestErrorResponse:
- description: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure.
+ description: >-
+ Indicates a bad request error. It could be caused by an unexpected
+ request body format or other forms of request validation failure.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
bad_request_cannot_deserialize:
- description: Thrown when trying to deserialize an integer from non-integer data.
+ description: >-
+ Thrown when trying to deserialize an integer from non-integer
+ data.
value:
error_code: 400
- message: 'Cannot deserialize value of type `java.lang.Integer` from String "A": not a valid `java.lang.Integer` value'
+ message: >-
+ Cannot deserialize value of type `java.lang.Integer` from
+ String "A": not a valid `java.lang.Integer` value
unsupported_version_exception:
- description: Thrown when the version of this API is not supported in the underlying Kafka cluster.
+ description: >-
+ Thrown when the version of this API is not supported in the
+ underlying Kafka cluster.
value:
error_code: 40035
- message: The version of this API is not supported in the underlying Kafka cluster.
+ message: >-
+ The version of this API is not supported in the underlying
+ Kafka cluster.
UnauthorizedErrorResponse:
- description: Indicates a client authentication error. Kafka authentication failures will contain error code 40101 in the response body.
+ description: >-
+ Indicates a client authentication error. Kafka authentication failures
+ will contain error code 40101 in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
kafka_authentication_failed:
- description: Thrown when using Basic authentication with wrong Kafka credentials.
+ description: >-
+ Thrown when using Basic authentication with wrong Kafka
+ credentials.
value:
error_code: 40101
message: Authentication failed
ForbiddenErrorResponse:
- description: Indicates a client authorization error. Kafka authorization failures will contain error code 40301 in the response body.
+ description: >-
+ Indicates a client authorization error. Kafka authorization failures
+ will contain error code 40301 in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
kafka_authorization_failed:
- description: Thrown when the caller is not authorized to perform the underlying operation.
+ description: >-
+ Thrown when the caller is not authorized to perform the
+ underlying operation.
value:
error_code: 40301
message: Request is not authorized
TooManyRequestsErrorResponse:
- description: Indicates that a rate limit threshold has been reached, and the client should retry again later.
+ description: >-
+ Indicates that a rate limit threshold has been reached, and the client
+ should retry again later.
content:
text/html:
schema:
type: string
example:
description: A sample response from Jetty's DoSFilter.
- value: Error 429 Too Many Requests HTTP ERROR 429 Too Many Requests
| URI: | /v3/clusters/my-cluster |
| STATUS: | 429 |
| MESSAGE: | Too Many Requests |
| SERVLET: | default |
+ value: >-
+ Error 429 Too Many
+ Requests HTTP ERROR 429 Too Many
+ Requests
| URI: |
+ /v3/clusters/my-cluster |
| STATUS: |
+ 429 |
| MESSAGE: | Too Many
+ Requests |
| SERVLET: | default |
+
ServerErrorResponse:
- description: A server-side problem that might not be addressable from the client side. Retriable Kafka errors will contain error code 50003 in the response body.
+ description: >-
+ A server-side problem that might not be addressable from the client
+ side. Retriable Kafka errors will contain error code 50003 in the
+ response body.
content:
application/json:
schema:
@@ -3183,14 +3419,18 @@ components:
error_code: 500
message: Internal Server Error
BadRequestErrorResponse_CreateAcls:
- description: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure.
+ description: >-
+ Indicates a bad request error. It could be caused by an unexpected
+ request body format or other forms of request validation failure.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
create_acls_cluster_name_invalid:
- description: Thrown when creating an ACL for a CLUSTER resource specifying the wrong resource name.
+ description: >-
+ Thrown when creating an ACL for a CLUSTER resource specifying
+ the wrong resource name.
value:
error_code: 40002
message: The only valid name for the CLUSTER resource is kafka-cluster"
@@ -3203,11 +3443,13 @@ components:
example:
kind: KafkaAclList
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?principal=User%3Aalice
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?principal=User%3Aalice
data:
- kind: KafkaAcl
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=TOPIC&resource_name=topic-&pattern_type=PREFIXED&principal=User%3Aalice&host=*&operation=ALL&permission=ALLOW
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=TOPIC&resource_name=topic-&pattern_type=PREFIXED&principal=User%3Aalice&host=*&operation=ALL&permission=ALLOW
cluster_id: cluster-1
resource_type: TOPIC
resource_name: topic-
@@ -3218,7 +3460,8 @@ components:
permission: ALLOW
- kind: KafkaAcl
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=CLUSTER&resource_name=kafka-cluster&pattern_type=LITERAL&principal=User%3Aalice&host=*&operation=DESCRIBE&permission=DENY
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=CLUSTER&resource_name=kafka-cluster&pattern_type=LITERAL&principal=User%3Aalice&host=*&operation=DESCRIBE&permission=DENY
cluster_id: cluster-1
resource_type: CLUSTER
resource_name: kafka-cluster
@@ -3244,7 +3487,8 @@ components:
data:
- kind: KafkaAcl
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=TOPIC&resource_name=topic-&pattern_type=PREFIXED&principal=User%3Aalice&host=*&operation=ALL&permission=ALLOW
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=TOPIC&resource_name=topic-&pattern_type=PREFIXED&principal=User%3Aalice&host=*&operation=ALL&permission=ALLOW
cluster_id: cluster-1
resource_type: TOPIC
resource_name: topic-
@@ -3255,7 +3499,8 @@ components:
permission: ALLOW
- kind: KafkaAcl
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=CLUSTER&resource_name=kafka-cluster&pattern_type=LITERAL&principal=User%3Aalice&host=*&operation=DESCRIBE&permission=DENY
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/acls?resource_type=CLUSTER&resource_name=kafka-cluster&pattern_type=LITERAL&principal=User%3Aalice&host=*&operation=DESCRIBE&permission=DENY
cluster_id: cluster-1
resource_type: CLUSTER
resource_name: kafka-cluster
@@ -3265,14 +3510,18 @@ components:
operation: DESCRIBE
permission: DENY
BadRequestErrorResponse_DeleteAcls:
- description: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure.
+ description: >-
+ Indicates a bad request error. It could be caused by an unexpected
+ request body format or other forms of request validation failure.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
delete_acls_unspecified_resource_type:
- description: Thrown when trying to delete ACLs without specifying a valid resource type.
+ description: >-
+ Thrown when trying to delete ACLs without specifying a valid
+ resource type.
value:
error_code: 400
message: resource_type cannot be unspecified or UNKNOWN
@@ -3285,12 +3534,14 @@ components:
example:
kind: KafkaClusterConfigList
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs
next: null
data:
- kind: KafkaClusterConfig
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/max.connections
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/max.connections
resource_name: crn:///kafka=cluster-1/broker-config=max.connections
cluster_id: cluster-1
config_type: BROKER
@@ -3309,7 +3560,8 @@ components:
source: DEFAULT_CONFIG
- kind: KafkaClusterConfig
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type
resource_name: crn:///kafka=cluster-1/broker-config=compression.type
cluster_id: cluster-1
config_type: BROKER
@@ -3335,7 +3587,8 @@ components:
example:
kind: KafkaClusterConfig
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/broker-configs/compression.type
resource_name: crn:///kafka=cluster-1/broker-config=compression.type
cluster_id: cluster-1
config_type: BROKER
@@ -3361,12 +3614,14 @@ components:
example:
kind: KafkaConsumerGroupList
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups
next: null
data:
- kind: KafkaConsumerGroup
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1
resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1
cluster_id: cluster-1
consumer_group_id: consumer-group-1
@@ -3376,14 +3631,18 @@ components:
type: CLASSIC
is_mixed_consumer_group: false
coordinator:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1
consumers:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers
lag_summary:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary
- kind: KafkaConsumerGroup
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-2
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-2
resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-2
cluster_id: cluster-1
consumer_group_id: consumer-group-2
@@ -3393,14 +3652,18 @@ components:
type: CLASSIC
is_mixed_consumer_group: false
coordinator:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/2
consumers:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-2/consumers
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-2/consumers
lag_summary:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-2/lag-summary
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-2/lag-summary
- kind: KafkaConsumerGroup
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-3
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-3
resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-3
cluster_id: cluster-1
consumer_group_id: consumer-group-3
@@ -3410,11 +3673,14 @@ components:
type: CLASSIC
is_mixed_consumer_group: false
coordinator:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/3
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/3
consumers:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-3/consumers
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-3/consumers
lag_summary:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-3/lag-summary
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-3/lag-summary
GetConsumerGroupResponse:
description: The consumer group.
content:
@@ -3424,7 +3690,8 @@ components:
example:
kind: KafkaConsumerGroup
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1
resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1
cluster_id: cluster-1
consumer_group_id: consumer-group-1
@@ -3434,11 +3701,14 @@ components:
type: CLASSIC
is_mixed_consumer_group: false
coordinator:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/brokers/1
consumers:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers
lag_summary:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary
ListConsumersResponse:
description: The list of consumers.
content:
@@ -3448,42 +3718,52 @@ components:
example:
kind: KafkaConsumerList
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers
next: null
data:
- kind: KafkaConsumer
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1
- resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1
+ resource_name: >-
+ crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-1
cluster_id: cluster-1
consumer_group_id: consumer-group-1
consumer_id: consumer-1
instance_id: consumer-instance-1
client_id: client-1
assignments:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1/assignments
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1/assignments
- kind: KafkaConsumer
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2
- resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-2
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2
+ resource_name: >-
+ crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-2
cluster_id: cluster-1
consumer_group_id: consumer-group-1
consumer_id: consumer-2
instance_id: consumer-instance-2
client_id: client-2
assignments:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2/assignments
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2/assignments
- kind: KafkaConsumer
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2
- resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-2
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2
+ resource_name: >-
+ crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-2
cluster_id: cluster-1
consumer_group_id: consumer-group-1
consumer_id: consumer-2
instance_id: consumer-instance-2
client_id: client-2
assignments:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2/assignments
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-2/assignments
GetConsumerGroupLagSummaryResponse:
description: The max and total consumer lag in a consumer group.
content:
@@ -3493,8 +3773,10 @@ components:
example:
kind: KafkaConsumerGroupLagSummary
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary
- resource_name: crn:///kafka=cluster-1/consumer-groups=consumer-group-1/lag-summary
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lag-summary
+ resource_name: >-
+ crn:///kafka=cluster-1/consumer-groups=consumer-group-1/lag-summary
cluster_id: cluster-1
consumer_group_id: consumer-group-1
max_lag_consumer_id: consumer-1
@@ -3505,9 +3787,11 @@ components:
max_lag: 100
total_lag: 110
max_lag_consumer:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1
max_lag_partition:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1
ListConsumerLagsResponse:
description: The list of consumer lags.
content:
@@ -3517,13 +3801,16 @@ components:
example:
kind: KafkaConsumerLagList
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags
next: null
data:
- kind: KafkaConsumerLag
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/1
- resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/1
+ resource_name: >-
+ crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=1
cluster_id: cluster-1
consumer_group_id: consumer-group-1
topic_name: topic-1
@@ -3536,8 +3823,10 @@ components:
lag: 100
- kind: KafkaConsumerLag
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/2
- resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=2
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/2
+ resource_name: >-
+ crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=2
cluster_id: cluster-1
consumer_group_id: consumer-group-1
topic_name: topic-1
@@ -3550,8 +3839,10 @@ components:
lag: 10
- kind: KafkaConsumerLag
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/3
- resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=3
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/3
+ resource_name: >-
+ crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=3
cluster_id: cluster-1
consumer_group_id: consumer-group-1
topic_name: topic-1
@@ -3571,8 +3862,10 @@ components:
example:
kind: KafkaConsumerLag
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/1
- resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/lags/topic-1/partitions/1
+ resource_name: >-
+ crn:///kafka=cluster-1/consumer-group=consumer-group-1/lag=topic-1/partition=1
cluster_id: cluster-1
consumer_group_id: consumer-group-1
topic_name: topic-1
@@ -3592,15 +3885,18 @@ components:
example:
kind: KafkaConsumer
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1
- resource_name: crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1
+ resource_name: >-
+ crn:///kafka=cluster-1/consumer-group=consumer-group-1/consumer=consumer-1
cluster_id: cluster-1
consumer_group_id: consumer-group-1
consumer_id: consumer-1
instance_id: consumer-instance-1
client_id: client-1
assignments:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1/assignments
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/consumer-groups/consumer-group-1/consumers/consumer-1/assignments
ListTopicsResponse:
description: The list of topics.
content:
@@ -3610,12 +3906,14 @@ components:
example:
kind: KafkaTopicList
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics
next: null
data:
- kind: KafkaTopic
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1
resource_name: crn:///kafka=cluster-1/topic=topic-1
cluster_id: cluster-1
topic_name: topic-1
@@ -3623,14 +3921,18 @@ components:
replication_factor: 3
partitions_count: 1
partitions:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions
configs:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs
partition_reassignments:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/-/reassignments
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/-/reassignments
- kind: KafkaTopic
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2
resource_name: crn:///kafka=cluster-1/topic=topic-2
cluster_id: cluster-1
topic_name: topic-2
@@ -3638,14 +3940,18 @@ components:
replication_factor: 4
partitions_count: 1
partitions:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/partitions
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/partitions
configs:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/configs
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/configs
partition_reassignments:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/partitions/-/reassignments
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-2/partitions/-/reassignments
- kind: KafkaTopic
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3
resource_name: crn:///kafka=cluster-1/topic=topic-3
cluster_id: cluster-1
topic_name: topic-3
@@ -3653,11 +3959,14 @@ components:
replication_factor: 5
partitions_count: 1
partitions:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/partitions
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/partitions
configs:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/configs
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/configs
partition_reassignments:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/partitions/-/reassignments
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-3/partitions/-/reassignments
CreateTopicResponse:
description: The created topic.
content:
@@ -3667,7 +3976,8 @@ components:
example:
kind: KafkaTopic
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X
resource_name: crn:///kafka=cluster-1/topic=topic-X
cluster_id: cluster-1
topic_name: topic-X
@@ -3675,25 +3985,34 @@ components:
replication_factor: 3
partitions_count: 1
partitions:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X/partitions
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X/partitions
configs:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X/configs
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X/configs
partition_reassignments:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X/partitions/-/reassignments
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-X/partitions/-/reassignments
BadRequestErrorResponse_CreateTopic:
- description: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure.
+ description: >-
+ Indicates a bad request error. It could be caused by an unexpected
+ request body format or other forms of request validation failure.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
create_topic_already_exists:
- description: Thrown when trying to create a topic with a name already used by an existing topic.
+ description: >-
+ Thrown when trying to create a topic with a name already used by
+ an existing topic.
value:
error_code: 40002
message: Topic 'my-topic' already exists.
create_topic_replication_factor_too_large:
- description: Thrown when trying to create a topic with a replication factor larger than the number of brokers.
+ description: >-
+ Thrown when trying to create a topic with a replication factor
+ larger than the number of brokers.
value:
error_code: 40002
message: 'Replication factor: 2 larger than available brokers: 1.'
@@ -3706,7 +4025,8 @@ components:
example:
kind: KafkaTopic
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1
resource_name: crn:///kafka=cluster-1/topic=topic-1
cluster_id: cluster-1
topic_name: topic-1
@@ -3714,13 +4034,19 @@ components:
replication_factor: 3
partitions_count: 1
partitions:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions
configs:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs
partition_reassignments:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/-/reassignments
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/-/reassignments
NotFoundErrorResponse:
- description: Indicates attempted access to an unreachable or non-existing resource like e.g. an unknown topic or partition. GET requests to endpoints not allowed in the accesslists will also result in this response.
+ description: >-
+ Indicates attempted access to an unreachable or non-existing resource
+ like e.g. an unknown topic or partition. GET requests to endpoints not
+ allowed in the accesslists will also result in this response.
content:
application/json:
schema:
@@ -3742,14 +4068,18 @@ components:
error_code: 40403
message: This server does not host this topic-partition.
BadRequestErrorResponse_UpdatePartitionCountTopic:
- description: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure.
+ description: >-
+ Indicates a bad request error. It could be caused by an unexpected
+ request body format or other forms of request validation failure.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
topic_update_partitions_invalid:
- description: Thrown when trying to update the number of partitions incorrectly.
+ description: >-
+ Thrown when trying to update the number of partitions
+ incorrectly.
value:
error_code: 40002
message: Topic already has 1 partitions.
@@ -3762,12 +4092,14 @@ components:
example:
kind: KafkaTopicConfigList
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs
next: null
data:
- kind: KafkaTopicConfig
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/cleanup.policy
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/cleanup.policy
resource_name: crn:///kafka=cluster-1/topic=topic-1/config=cleanup.policy
cluster_id: cluster-1
topic_name: topic-1
@@ -3786,7 +4118,8 @@ components:
source: DEFAULT_CONFIG
- kind: KafkaTopicConfig
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/configs/compression.type
resource_name: crn:///kafka=cluster-1/topic=topic-1/config=compression.type
cluster_id: cluster-1
topic_name: topic-1
@@ -3812,7 +4145,8 @@ components:
example:
kind: KafkaTopicConfig
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/compression.type
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/compression.type
resource_name: crn:///kafka=cluster-1/topic=topic-1/config=compression.type
cluster_id: cluster-1
topic_name: topic-1
@@ -3838,48 +4172,61 @@ components:
example:
kind: KafkaPartitionList
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions
next: null
data:
- kind: KafkaPartition
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1
resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=1
cluster_id: cluster-1
topic_name: topic-1
partition_id: 1
leader:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas/1
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas/1
replicas:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas
reassignment:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/reassignment
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/reassignment
- kind: KafkaPartition
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2
resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=2
cluster_id: cluster-1
topic_name: topic-1
partition_id: 2
leader:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2/replicas/2
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2/replicas/2
replicas:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2/replicas
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2/replicas
reassignment:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2/reassignment
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/2/reassignment
- kind: KafkaPartition
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3
resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=3
cluster_id: cluster-1
topic_name: topic-1
partition_id: 3
leader:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3/replicas/3
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3/replicas/3
replicas:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3/replicas
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3/replicas
reassignment:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3/reassignment
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/3/reassignment
GetPartitionResponse:
description: The partition
content:
@@ -3889,21 +4236,29 @@ components:
example:
kind: KafkaPartition
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1
resource_name: crn:///kafka=cluster-1/topic=topic-1/partition=1
cluster_id: cluster-1
topic_name: topic-1
partition_id: 1
leader:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas/1
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas/1
replicas:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/replicas
reassignment:
- related: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/reassignment
+ related: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/topics/topic-1/partitions/1/reassignment
ProduceResponse:
- description: |-
- The response containing a delivery report for a record produced to a topic. In streaming mode,
- for each record sent, a separate delivery report will be returned, in the same order,
+ description: >-
+ The response containing a delivery report for a record produced to a
+ topic. In streaming mode,
+
+ for each record sent, a separate delivery report will be returned, in
+ the same order,
+
each with its own error_code.
content:
application/json:
@@ -3926,48 +4281,71 @@ components:
type: JSON
size: 15
produce_record_bad_binary_data:
- description: Thrown when sending a BINARY value which is not a base64-encoded string.
+ description: >-
+ Thrown when sending a BINARY value which is not a base64-encoded
+ string.
value:
error_code: 400
message: 'Bad Request: data=1 is not a base64 string.'
BadRequestErrorResponse_ProduceRecords:
- description: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure.
+ description: >-
+ Indicates a bad request error. It could be caused by an unexpected
+ request body format or other forms of request validation failure.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
header_not_base64_encoded:
- description: Thrown when headers in the produce-record are not base64 encoded.
+ description: >-
+ Thrown when headers in the produce-record are not base64
+ encoded.
value:
error_code: 400
- message: 'Cannot deserialize value of type `byte[]` from String "": Unexpected end of base64-encoded String: base64 variant ''MIME-NO-LINEFEEDS'' expects padding (one or more ''='' characters) at the end. This Base64Variant might have been incorrectly configured'
+ message: >-
+ Cannot deserialize value of type `byte[]` from String "":
+ Unexpected end of base64-encoded String: base64 variant
+ 'MIME-NO-LINEFEEDS' expects padding (one or more '='
+ characters) at the end. This Base64Variant might have been
+ incorrectly configured
RequestEntityTooLargeErrorResponse:
- description: This implies the client is sending a request payload that is larger than the maximum message size the server can accept.
+ description: >-
+ This implies the client is sending a request payload that is larger than
+ the maximum message size the server can accept.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
produce_records_expects_json:
- description: Thrown by /records API if payload size exceeds the message max size
+ description: >-
+ Thrown by /records API if payload size exceeds the message max
+ size
value:
error_code: 413
- message: The request included a message larger than the maximum message size the server can accept.
+ message: >-
+ The request included a message larger than the maximum message
+ size the server can accept.
UnsupportedMediaTypeErrorResponse:
- description: This implies the client is sending the request payload format in an unsupported format.
+ description: >-
+ This implies the client is sending the request payload format in an
+ unsupported format.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
produce_records_expects_json:
- description: Thrown by /records API if payload format content-type doesn't match expected application/json
+ description: >-
+ Thrown by /records API if payload format content-type doesn't
+ match expected application/json
value:
error_code: 415
message: HTTP 415 Unsupported Media Type
UnprocessableEntity_ProduceRecord:
- description: Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure.
+ description: >-
+ Indicates a bad request error. It could be caused by an unexpected
+ request body format or other forms of request validation failure.
content:
application/json:
schema:
@@ -3987,12 +4365,14 @@ components:
example:
kind: KafkaLinkDataList
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links
next: null
data:
- kind: KafkaLinkData
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/CIL-69l7S1CwoVNAhoQLug/links/my-new-link-1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/CIL-69l7S1CwoVNAhoQLug/links/my-new-link-1
resource_name: null
source_cluster_id: src-cluster-id
link_name: my-new-link-1
@@ -4004,7 +4384,8 @@ components:
link_state: ACTIVE
- kind: KafkaLinkData
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/CIL-69l7S1CwoVNAhoQLug/links/my-new-link-2
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/CIL-69l7S1CwoVNAhoQLug/links/my-new-link-2
resource_name: null
remote_cluster_id: src-cluster-id
link_name: my-new-link-2
@@ -4018,7 +4399,8 @@ components:
link_error_message: Please check your api key and secret
- kind: KafkaLinkData
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/CIL-69l7S1CwoVNAhoQLug/links/my-new-link-3
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/CIL-69l7S1CwoVNAhoQLug/links/my-new-link-3
resource_name: null
destination_cluster_id: dest-cluster-id
link_name: my-new-link-3
@@ -4040,7 +4422,8 @@ components:
value:
kind: KafkaLinkData
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/my-new-link-1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/my-new-link-1
resource_name: null
source_cluster_id: src-cluster-id
link_name: my-new-link-1
@@ -4054,7 +4437,8 @@ components:
value:
kind: KafkaLinkData
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/my-new-link-1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/my-new-link-1
resource_name: null
destination_cluster_id: dst-cluster-id
link_name: my-new-link-1
@@ -4070,12 +4454,14 @@ components:
example:
kind: KafkaLinkConfigDataList
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/v-0Ce-CkTyKQol9v46LaCQ/links/link-nb-1/configs
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/v-0Ce-CkTyKQol9v46LaCQ/links/link-nb-1/configs
next: null
data:
- kind: KafkaLinkConfigData
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/1Rh_4htxSuen7RYGvGmgNw/links/my-new-link-1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/1Rh_4htxSuen7RYGvGmgNw/links/my-new-link-1
resource_name: null
cluster_id: 1Rh_4htxSuen7RYGvGmgNw
name: consumer.offset.sync.ms
@@ -4089,7 +4475,8 @@ components:
link_name: link-db-1
- kind: KafkaLinkConfigData
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/1Rh_4htxSuen7RYGvGmgNw/links/my-new-link-1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/1Rh_4htxSuen7RYGvGmgNw/links/my-new-link-1
resource_name: null
cluster_id: 1Rh_4htxSuen7RYGvGmgNw
name: acl.sync.ms
@@ -4110,7 +4497,8 @@ components:
example:
kind: KafkaLinkConfigData
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/1Rh_4htxSuen7RYGvGmgNw/links/my-new-link-1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/1Rh_4htxSuen7RYGvGmgNw/links/my-new-link-1
resource_name: null
cluster_id: 1Rh_4htxSuen7RYGvGmgNw
name: consumer.offset.sync.ms
@@ -4131,13 +4519,15 @@ components:
example:
kind: KafkaMirrorDataList
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/link/link-1/mirrors
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/link/link-1/mirrors
resource_name: crn:///kafka=cluster-1
next: null
data:
- kind: KafkaMirrorData
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/link-1/mirrors/topic-1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/link-1/mirrors/topic-1
resource_name: crn:///kafka=cluster-1
link_name: link-sb-1
resource_name: crn:///kafka=cluster-1
@@ -4158,7 +4548,8 @@ components:
state_time_ms: 1612550939300
- kind: KafkaMirrorData
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/link-1/mirrors/topic-2
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/Fds7TcT9TTqEXsoRLEKMcQ/links/link-1/mirrors/topic-2
resource_name: crn:///kafka=cluster-1
link_name: link-sb-2
resource_name: crn:///kafka=cluster-1
@@ -4186,7 +4577,8 @@ components:
example:
kind: KafkaMirrorData
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/link/link-1/mirrors/topic-1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/link/link-1/mirrors/topic-1
resource_name: crn:///kafka=cluster-1
link_name: link-sb-1
mirror_topic_name: topic-1
@@ -4213,12 +4605,14 @@ components:
example:
kind: KafkaPromoteMirror
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-1/mirrors
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/link-1/mirrors
resource_name: crn:///kafka=cluster-1
data:
- kind: AlterMirrorsData
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/my-new-link-1/mirrors/topic-1
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/my-new-link-1/mirrors/topic-1
resource: crn:///kafka=cluster-1
mirror_topic_name: topic-sb
error_code: null
@@ -4246,11 +4640,14 @@ components:
messages_truncated: 20000
- kind: AlterMirrorsData
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/my-new-link-1/mirrors/topic-2
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/links/my-new-link-1/mirrors/topic-2
resource: crn:///kafka=cluster-1
mirror_topic_name: topic-2
error_code: 400
- error_message: Topic 'topic-2' has already stopped its mirror from 'my-new-link-1'
+ error_message: >-
+ Topic 'topic-2' has already stopped its mirror from
+ 'my-new-link-1'
mirror_lags:
- partition: 0
lag: 0
@@ -4281,13 +4678,16 @@ components:
example:
kind: KafkaGroupConfigDataList
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs
next: null
data:
- kind: KafkaGroupConfigData
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs/share.session.timeout.ms
- resource_name: crn:///kafka=cluster-1/group=group-1/config=share.session.timeout.ms
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs/share.session.timeout.ms
+ resource_name: >-
+ crn:///kafka=cluster-1/group=group-1/config=share.session.timeout.ms
cluster_id: cluster-1
group_id: group-1
name: share.session.timeout.ms
@@ -4305,8 +4705,10 @@ components:
source: DEFAULT_CONFIG
- kind: KafkaGroupConfigData
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs/share.heartbeat.interval.ms
- resource_name: crn:///kafka=cluster-1/group=group-1/config=share.heartbeat.interval.ms
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs/share.heartbeat.interval.ms
+ resource_name: >-
+ crn:///kafka=cluster-1/group=group-1/config=share.heartbeat.interval.ms
cluster_id: cluster-1
group_id: group-1
name: share.heartbeat.interval.ms
@@ -4328,8 +4730,10 @@ components:
example:
kind: KafkaGroupConfigData
metadata:
- self: https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs/share.session.timeout.ms
- resource_name: crn:///kafka=cluster-1/group=group-1/config=share.session.timeout.ms
+ self: >-
+ https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/cluster-1/groups/group-1/configs/share.session.timeout.ms
+ resource_name: >-
+ crn:///kafka=cluster-1/group=group-1/config=share.session.timeout.ms
cluster_id: cluster-1
group_id: group-1
name: share.session.timeout.ms
@@ -4492,7 +4896,9 @@ components:
example: link-sb1
ValidateOnly:
name: validate_only
- description: 'To validate the action can be performed successfully or not. Default: false'
+ description: >-
+ To validate the action can be performed successfully or not. Default:
+ false
in: query
required: false
schema:
@@ -4500,7 +4906,10 @@ components:
example: false
ValidateLink:
name: validate_link
- description: 'To synchronously validate that the source cluster ID is expected and the dest cluster has the permission to read topics in the source cluster. Default: true'
+ description: >-
+ To synchronously validate that the source cluster ID is expected and the
+ dest cluster has the permission to read topics in the source cluster.
+ Default: true
in: query
required: false
schema:
@@ -4540,7 +4949,9 @@ components:
example: consumer.offset.sync.enable
MirrorTopicStatus:
name: mirror_status
- description: The status of the mirror topic. If not specified, all mirror topics will be returned.
+ description: >-
+ The status of the mirror topic. If not specified, all mirror topics will
+ be returned.
in: query
required: false
schema:
@@ -4556,7 +4967,9 @@ components:
example: topic-1
IncludeStateTransitionErrors:
name: include_state_transition_errors
- description: 'Whether to include mirror state transition errors in the response. Default: false'
+ description: >-
+ Whether to include mirror state transition errors in the response.
+ Default: false
in: query
required: false
schema:
@@ -4564,7 +4977,9 @@ components:
example: false
IncludePartitionLevelTruncationData:
name: include_partition_level_truncation_data
- description: 'Whether to include partition level truncation information when truncating and restoring a topic in the response. Default: false'
+ description: >-
+ Whether to include partition level truncation information when
+ truncating and restoring a topic in the response. Default: false
in: query
required: false
schema:
@@ -4636,7 +5051,12 @@ components:
example:
value: gzip
CreateTopicRequest:
- description: The topic creation request. Note that Confluent Cloud allows only specific replication factor values. Because of that the replication factor field should either be omitted or it should use one of the allowed values (see https://docs.confluent.io/cloud/current/client-apps/optimizing/durability.html).
+ description: >-
+ The topic creation request. Note that Confluent Cloud allows only
+ specific replication factor values. Because of that the replication
+ factor field should either be omitted or it should use one of the
+ allowed values (see
+ https://docs.confluent.io/cloud/current/client-apps/optimizing/durability.html).
content:
application/json:
schema:
@@ -4689,7 +5109,10 @@ components:
example:
value: gzip
ProduceRequest:
- description: A single record to be produced to Kafka. To produce multiple records in the same request, simply concatenate the records. The delivery reports are concatenated in the same order as the records are sent.
+ description: >-
+ A single record to be produced to Kafka. To produce multiple records in
+ the same request, simply concatenate the records. The delivery reports
+ are concatenated in the same order as the records are sent.
content:
application/json:
schema:
@@ -4746,7 +5169,10 @@ components:
- name: security.protocol
value: SASL_SSL
- name: sasl.jaas.config
- value: sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required username='' password='';
+ value: >-
+ sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule
+ required username='' password='';
source_initiated_link_at_source_cluster:
description: Create a source initiated cluster link at source cluster
value:
@@ -4761,13 +5187,19 @@ components:
- name: security.protocol
value: SASL_SSL
- name: sasl.jaas.config
- value: sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required username='' password='';
+ value: >-
+ sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule
+ required username=''
+ password='';
- name: local.sasl.mechanism
value: PLAIN
- name: local.security.protocol
value: SASL_SSL
- name: local.sasl.jaas.config
- value: sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required username='' password='';
+ value: >-
+ sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule
+ required username='' password='';
source_initiated_link_at_destination_cluster:
description: Create a source initiated cluster link at destination cluster
value:
@@ -4795,7 +5227,10 @@ components:
- name: security.protocol
value: SASL_SSL
- name: sasl.jaas.config
- value: sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required username='' password='';
+ value: >-
+ sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule
+ required username='' password='';
bidirectional_link_west:
description: Create a bidirectional cluster link in west
value:
@@ -4813,7 +5248,10 @@ components:
- name: security.protocol
value: SASL_SSL
- name: sasl.jaas.config
- value: sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required username='' password='';
+ value: >-
+ sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule
+ required username='' password='';
UpdateLinkConfigRequest:
content:
application/json:
@@ -4834,7 +5272,12 @@ components:
schema:
$ref: '#/components/schemas/AlterConfigBatchRequestData'
CreateMirrorTopicRequest:
- description: Name and configs of the topics mirroring from and mirroring to. Note that Confluent Cloud allows only specific replication factor values. Because of that the replication factor field should either be omitted or it should use one of the allowed values (see https://docs.confluent.io/cloud/current/client-apps/optimizing/durability.html).
+ description: >-
+ Name and configs of the topics mirroring from and mirroring to. Note
+ that Confluent Cloud allows only specific replication factor values.
+ Because of that the replication factor field should either be omitted or
+ it should use one of the allowed values (see
+ https://docs.confluent.io/cloud/current/client-apps/optimizing/durability.html).
content:
application/json:
schema:
@@ -4895,7 +5338,7 @@ components:
$ref: '#/components/schemas/AlterConfigBatchRequestData'
x-stackQL-resources:
clusters:
- id: confluent.kafka.clusters
+ id: kafka.kafka.clusters
name: clusters
title: Clusters
methods:
@@ -4907,13 +5350,14 @@ components:
openAPIDocKey: '200'
sqlVerbs:
select:
- - $ref: '#/components/x-stackQL-resources/clusters/methods/get_kafka_cluster'
+ - $ref: >-
+ #/components/x-stackQL-resources/clusters/methods/get_kafka_cluster
insert: []
update: []
delete: []
replace: []
acls:
- id: confluent.kafka.acls
+ id: kafka.kafka.acls
name: acls
title: Acls
methods:
@@ -4957,7 +5401,7 @@ components:
- $ref: '#/components/x-stackQL-resources/acls/methods/delete_kafka_acls'
replace: []
cluster_configs:
- id: confluent.kafka.cluster_configs
+ id: kafka.kafka.cluster_configs
name: cluster_configs
title: Cluster Configs
methods:
@@ -4973,13 +5417,15 @@ components:
requestBodyTranslate:
algorithm: naive
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1broker-configs:alter/post'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1broker-configs:alter/post
response:
mediaType: application/json
openAPIDocKey: '204'
get_kafka_cluster_config:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1broker-configs~1{name}/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1broker-configs~1{name}/get
response:
mediaType: application/json
openAPIDocKey: '200'
@@ -4988,29 +5434,36 @@ components:
requestBodyTranslate:
algorithm: naive
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1broker-configs~1{name}/put'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1broker-configs~1{name}/put
response:
mediaType: application/json
openAPIDocKey: '204'
delete_kafka_cluster_config:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1broker-configs~1{name}/delete'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1broker-configs~1{name}/delete
response:
mediaType: application/json
openAPIDocKey: '204'
sqlVerbs:
select:
- - $ref: '#/components/x-stackQL-resources/cluster_configs/methods/get_kafka_cluster_config'
- - $ref: '#/components/x-stackQL-resources/cluster_configs/methods/list_kafka_cluster_configs'
+ - $ref: >-
+ #/components/x-stackQL-resources/cluster_configs/methods/get_kafka_cluster_config
+ - $ref: >-
+ #/components/x-stackQL-resources/cluster_configs/methods/list_kafka_cluster_configs
insert: []
update: []
delete:
- - $ref: '#/components/x-stackQL-resources/cluster_configs/methods/delete_kafka_cluster_config'
+ - $ref: >-
+ #/components/x-stackQL-resources/cluster_configs/methods/delete_kafka_cluster_config
replace:
- - $ref: '#/components/x-stackQL-resources/cluster_configs/methods/update_kafka_cluster_config'
- - $ref: '#/components/x-stackQL-resources/cluster_configs/methods/update_kafka_cluster_configs'
+ - $ref: >-
+ #/components/x-stackQL-resources/cluster_configs/methods/update_kafka_cluster_config
+ - $ref: >-
+ #/components/x-stackQL-resources/cluster_configs/methods/update_kafka_cluster_configs
consumer_groups:
- id: confluent.kafka.consumer_groups
+ id: kafka.kafka.consumer_groups
name: consumer_groups
title: Consumer Groups
methods:
@@ -5023,90 +5476,103 @@ components:
objectKey: $.data
get_kafka_consumer_group:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups~1{consumer_group_id}/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups~1{consumer_group_id}/get
response:
mediaType: application/json
openAPIDocKey: '200'
sqlVerbs:
select:
- - $ref: '#/components/x-stackQL-resources/consumer_groups/methods/get_kafka_consumer_group'
- - $ref: '#/components/x-stackQL-resources/consumer_groups/methods/list_kafka_consumer_groups'
+ - $ref: >-
+ #/components/x-stackQL-resources/consumer_groups/methods/get_kafka_consumer_group
+ - $ref: >-
+ #/components/x-stackQL-resources/consumer_groups/methods/list_kafka_consumer_groups
insert: []
update: []
delete: []
replace: []
consumers:
- id: confluent.kafka.consumers
+ id: kafka.kafka.consumers
name: consumers
title: Consumers
methods:
list_kafka_consumers:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups~1{consumer_group_id}~1consumers/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups~1{consumer_group_id}~1consumers/get
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.data
get_kafka_consumer:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups~1{consumer_group_id}~1consumers~1{consumer_id}/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups~1{consumer_group_id}~1consumers~1{consumer_id}/get
response:
mediaType: application/json
openAPIDocKey: '200'
sqlVerbs:
select:
- - $ref: '#/components/x-stackQL-resources/consumers/methods/get_kafka_consumer'
- - $ref: '#/components/x-stackQL-resources/consumers/methods/list_kafka_consumers'
+ - $ref: >-
+ #/components/x-stackQL-resources/consumers/methods/get_kafka_consumer
+ - $ref: >-
+ #/components/x-stackQL-resources/consumers/methods/list_kafka_consumers
insert: []
update: []
delete: []
replace: []
consumers_lag_summary:
- id: confluent.kafka.consumers_lag_summary
+ id: kafka.kafka.consumers_lag_summary
name: consumers_lag_summary
title: Consumers Lag Summary
methods:
get_kafka_consumer_group_lag_summary:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups~1{consumer_group_id}~1lag-summary/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups~1{consumer_group_id}~1lag-summary/get
response:
mediaType: application/json
openAPIDocKey: '200'
sqlVerbs:
select:
- - $ref: '#/components/x-stackQL-resources/consumers_lag_summary/methods/get_kafka_consumer_group_lag_summary'
+ - $ref: >-
+ #/components/x-stackQL-resources/consumers_lag_summary/methods/get_kafka_consumer_group_lag_summary
insert: []
update: []
delete: []
replace: []
consumers_lags:
- id: confluent.kafka.consumers_lags
+ id: kafka.kafka.consumers_lags
name: consumers_lags
title: Consumers Lags
methods:
list_kafka_consumer_lags:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups~1{consumer_group_id}~1lags/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups~1{consumer_group_id}~1lags/get
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.data
get_kafka_consumer_lag:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups~1{consumer_group_id}~1lags~1{topic_name}~1partitions~1{partition_id}/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1consumer-groups~1{consumer_group_id}~1lags~1{topic_name}~1partitions~1{partition_id}/get
response:
mediaType: application/json
openAPIDocKey: '200'
sqlVerbs:
select:
- - $ref: '#/components/x-stackQL-resources/consumers_lags/methods/get_kafka_consumer_lag'
- - $ref: '#/components/x-stackQL-resources/consumers_lags/methods/list_kafka_consumer_lags'
+ - $ref: >-
+ #/components/x-stackQL-resources/consumers_lags/methods/get_kafka_consumer_lag
+ - $ref: >-
+ #/components/x-stackQL-resources/consumers_lags/methods/list_kafka_consumer_lags
insert: []
update: []
delete: []
replace: []
topics:
- id: confluent.kafka.topics
+ id: kafka.kafka.topics
name: topics
title: Topics
methods:
@@ -5128,7 +5594,8 @@ components:
openAPIDocKey: '200'
get_kafka_topic:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}/get
response:
mediaType: application/json
openAPIDocKey: '200'
@@ -5137,13 +5604,15 @@ components:
requestBodyTranslate:
algorithm: naive
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}/patch'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}/patch
response:
mediaType: application/json
openAPIDocKey: '200'
delete_kafka_topic:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}/delete'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}/delete
response:
mediaType: application/json
openAPIDocKey: '204'
@@ -5154,18 +5623,20 @@ components:
insert:
- $ref: '#/components/x-stackQL-resources/topics/methods/create_kafka_topic'
update:
- - $ref: '#/components/x-stackQL-resources/topics/methods/update_partition_count_kafka_topic'
+ - $ref: >-
+ #/components/x-stackQL-resources/topics/methods/update_partition_count_kafka_topic
delete:
- $ref: '#/components/x-stackQL-resources/topics/methods/delete_kafka_topic'
replace: []
topic_configs:
- id: confluent.kafka.topic_configs
+ id: kafka.kafka.topic_configs
name: topic_configs
title: Topic Configs
methods:
list_kafka_topic_configs:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1configs/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1configs/get
response:
mediaType: application/json
openAPIDocKey: '200'
@@ -5175,13 +5646,15 @@ components:
requestBodyTranslate:
algorithm: naive
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1configs:alter/post'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1configs:alter/post
response:
mediaType: application/json
openAPIDocKey: '204'
get_kafka_topic_config:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1configs~1{name}/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1configs~1{name}/get
response:
mediaType: application/json
openAPIDocKey: '200'
@@ -5190,63 +5663,76 @@ components:
requestBodyTranslate:
algorithm: naive
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1configs~1{name}/put'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1configs~1{name}/put
response:
mediaType: application/json
openAPIDocKey: '204'
delete_kafka_topic_config:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1configs~1{name}/delete'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1configs~1{name}/delete
response:
mediaType: application/json
openAPIDocKey: '204'
list_kafka_all_topic_configs:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1-~1configs/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1-~1configs/get
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.data
sqlVerbs:
select:
- - $ref: '#/components/x-stackQL-resources/topic_configs/methods/get_kafka_topic_config'
- - $ref: '#/components/x-stackQL-resources/topic_configs/methods/list_kafka_topic_configs'
- - $ref: '#/components/x-stackQL-resources/topic_configs/methods/list_kafka_all_topic_configs'
+ - $ref: >-
+ #/components/x-stackQL-resources/topic_configs/methods/get_kafka_topic_config
+ - $ref: >-
+ #/components/x-stackQL-resources/topic_configs/methods/list_kafka_topic_configs
+ - $ref: >-
+ #/components/x-stackQL-resources/topic_configs/methods/list_kafka_all_topic_configs
insert: []
update: []
delete:
- - $ref: '#/components/x-stackQL-resources/topic_configs/methods/delete_kafka_topic_config'
+ - $ref: >-
+ #/components/x-stackQL-resources/topic_configs/methods/delete_kafka_topic_config
replace:
- - $ref: '#/components/x-stackQL-resources/topic_configs/methods/update_kafka_topic_config'
- - $ref: '#/components/x-stackQL-resources/topic_configs/methods/update_kafka_topic_config_batch'
+ - $ref: >-
+ #/components/x-stackQL-resources/topic_configs/methods/update_kafka_topic_config
+ - $ref: >-
+ #/components/x-stackQL-resources/topic_configs/methods/update_kafka_topic_config_batch
topic_partitions:
- id: confluent.kafka.topic_partitions
+ id: kafka.kafka.topic_partitions
name: topic_partitions
title: Topic Partitions
methods:
list_kafka_partitions:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1partitions/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1partitions/get
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.data
get_kafka_partition:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1partitions~1{partition_id}/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1partitions~1{partition_id}/get
response:
mediaType: application/json
openAPIDocKey: '200'
sqlVerbs:
select:
- - $ref: '#/components/x-stackQL-resources/topic_partitions/methods/get_kafka_partition'
- - $ref: '#/components/x-stackQL-resources/topic_partitions/methods/list_kafka_partitions'
+ - $ref: >-
+ #/components/x-stackQL-resources/topic_partitions/methods/get_kafka_partition
+ - $ref: >-
+ #/components/x-stackQL-resources/topic_partitions/methods/list_kafka_partitions
insert: []
update: []
delete: []
replace: []
records:
- id: confluent.kafka.records
+ id: kafka.kafka.records
name: records
title: Records
methods:
@@ -5255,7 +5741,8 @@ components:
requestBodyTranslate:
algorithm: naive
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1records/post'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1records/post
response:
mediaType: application/json
openAPIDocKey: '200'
@@ -5267,7 +5754,7 @@ components:
delete: []
replace: []
cluster_links:
- id: confluent.kafka.cluster_links
+ id: kafka.kafka.cluster_links
name: cluster_links
title: Cluster Links
methods:
@@ -5289,60 +5776,70 @@ components:
openAPIDocKey: '204'
get_kafka_link:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}/get
response:
mediaType: application/json
openAPIDocKey: '200'
delete_kafka_link:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}/delete'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}/delete
response:
mediaType: application/json
openAPIDocKey: '200'
sqlVerbs:
select:
- - $ref: '#/components/x-stackQL-resources/cluster_links/methods/get_kafka_link'
- - $ref: '#/components/x-stackQL-resources/cluster_links/methods/list_kafka_links'
+ - $ref: >-
+ #/components/x-stackQL-resources/cluster_links/methods/get_kafka_link
+ - $ref: >-
+ #/components/x-stackQL-resources/cluster_links/methods/list_kafka_links
insert:
- - $ref: '#/components/x-stackQL-resources/cluster_links/methods/create_kafka_link'
+ - $ref: >-
+ #/components/x-stackQL-resources/cluster_links/methods/create_kafka_link
update: []
delete:
- - $ref: '#/components/x-stackQL-resources/cluster_links/methods/delete_kafka_link'
+ - $ref: >-
+ #/components/x-stackQL-resources/cluster_links/methods/delete_kafka_link
replace: []
default_topic_configs:
- id: confluent.kafka.default_topic_configs
+ id: kafka.kafka.default_topic_configs
name: default_topic_configs
title: Default Topic Configs
methods:
list_kafka_default_topic_configs:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1default-configs/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1topics~1{topic_name}~1default-configs/get
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.data
sqlVerbs:
select:
- - $ref: '#/components/x-stackQL-resources/default_topic_configs/methods/list_kafka_default_topic_configs'
+ - $ref: >-
+ #/components/x-stackQL-resources/default_topic_configs/methods/list_kafka_default_topic_configs
insert: []
update: []
delete: []
replace: []
cluster_link_configs:
- id: confluent.kafka.cluster_link_configs
+ id: kafka.kafka.cluster_link_configs
name: cluster_link_configs
title: Cluster Link Configs
methods:
list_kafka_link_configs:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1configs/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1configs/get
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.data
get_kafka_link_configs:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1configs~1{config_name}/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1configs~1{config_name}/get
response:
mediaType: application/json
openAPIDocKey: '200'
@@ -5351,13 +5848,15 @@ components:
requestBodyTranslate:
algorithm: naive
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1configs~1{config_name}/put'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1configs~1{config_name}/put
response:
mediaType: application/json
openAPIDocKey: '204'
delete_kafka_link_config:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1configs~1{config_name}/delete'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1configs~1{config_name}/delete
response:
mediaType: application/json
openAPIDocKey: '204'
@@ -5366,23 +5865,29 @@ components:
requestBodyTranslate:
algorithm: naive
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1configs:alter/put'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1configs:alter/put
response:
mediaType: application/json
openAPIDocKey: '204'
sqlVerbs:
select:
- - $ref: '#/components/x-stackQL-resources/cluster_link_configs/methods/get_kafka_link_configs'
- - $ref: '#/components/x-stackQL-resources/cluster_link_configs/methods/list_kafka_link_configs'
+ - $ref: >-
+ #/components/x-stackQL-resources/cluster_link_configs/methods/get_kafka_link_configs
+ - $ref: >-
+ #/components/x-stackQL-resources/cluster_link_configs/methods/list_kafka_link_configs
insert: []
update: []
delete:
- - $ref: '#/components/x-stackQL-resources/cluster_link_configs/methods/delete_kafka_link_config'
+ - $ref: >-
+ #/components/x-stackQL-resources/cluster_link_configs/methods/delete_kafka_link_config
replace:
- - $ref: '#/components/x-stackQL-resources/cluster_link_configs/methods/update_kafka_link_config'
- - $ref: '#/components/x-stackQL-resources/cluster_link_configs/methods/update_kafka_link_config_batch'
+ - $ref: >-
+ #/components/x-stackQL-resources/cluster_link_configs/methods/update_kafka_link_config
+ - $ref: >-
+ #/components/x-stackQL-resources/cluster_link_configs/methods/update_kafka_link_config_batch
mirror_topics:
- id: confluent.kafka.mirror_topics
+ id: kafka.kafka.mirror_topics
name: mirror_topics
title: Mirror Topics
methods:
@@ -5391,13 +5896,15 @@ components:
requestBodyTranslate:
algorithm: naive
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors/post'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors/post
response:
mediaType: application/json
openAPIDocKey: '204'
list_kafka_mirror_topics_under_link:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors/get
response:
mediaType: application/json
openAPIDocKey: '200'
@@ -5411,7 +5918,8 @@ components:
objectKey: $.data
read_kafka_mirror_topic:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors~1{mirror_topic_name}/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors~1{mirror_topic_name}/get
response:
mediaType: application/json
openAPIDocKey: '200'
@@ -5420,7 +5928,8 @@ components:
requestBodyTranslate:
algorithm: naive
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:promote/post'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:promote/post
response:
mediaType: application/json
openAPIDocKey: '200'
@@ -5429,7 +5938,8 @@ components:
requestBodyTranslate:
algorithm: naive
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:failover/post'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:failover/post
response:
mediaType: application/json
openAPIDocKey: '200'
@@ -5438,7 +5948,8 @@ components:
requestBodyTranslate:
algorithm: naive
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:pause/post'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:pause/post
response:
mediaType: application/json
openAPIDocKey: '200'
@@ -5447,7 +5958,8 @@ components:
requestBodyTranslate:
algorithm: naive
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:resume/post'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:resume/post
response:
mediaType: application/json
openAPIDocKey: '200'
@@ -5456,7 +5968,8 @@ components:
requestBodyTranslate:
algorithm: naive
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:reverse-and-start-mirror/post'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:reverse-and-start-mirror/post
response:
mediaType: application/json
openAPIDocKey: '200'
@@ -5465,7 +5978,8 @@ components:
requestBodyTranslate:
algorithm: naive
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:reverse-and-pause-mirror/post'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:reverse-and-pause-mirror/post
response:
mediaType: application/json
openAPIDocKey: '200'
@@ -5474,35 +5988,42 @@ components:
requestBodyTranslate:
algorithm: naive
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:truncate-and-restore/post'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1links~1{link_name}~1mirrors:truncate-and-restore/post
response:
mediaType: application/json
openAPIDocKey: '200'
sqlVerbs:
select:
- - $ref: '#/components/x-stackQL-resources/mirror_topics/methods/read_kafka_mirror_topic'
- - $ref: '#/components/x-stackQL-resources/mirror_topics/methods/list_kafka_mirror_topics_under_link'
- - $ref: '#/components/x-stackQL-resources/mirror_topics/methods/list_kafka_mirror_topics'
+ - $ref: >-
+ #/components/x-stackQL-resources/mirror_topics/methods/read_kafka_mirror_topic
+ - $ref: >-
+ #/components/x-stackQL-resources/mirror_topics/methods/list_kafka_mirror_topics_under_link
+ - $ref: >-
+ #/components/x-stackQL-resources/mirror_topics/methods/list_kafka_mirror_topics
insert:
- - $ref: '#/components/x-stackQL-resources/mirror_topics/methods/create_kafka_mirror_topic'
+ - $ref: >-
+ #/components/x-stackQL-resources/mirror_topics/methods/create_kafka_mirror_topic
update: []
delete: []
replace: []
group_configs:
- id: confluent.kafka.group_configs
+ id: kafka.kafka.group_configs
name: group_configs
title: Group Configs
methods:
list_kafka_group_configs:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1groups~1{group_id}~1configs/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1groups~1{group_id}~1configs/get
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.data
get_kafka_group_config:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1groups~1{group_id}~1configs~1{name}/get'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1groups~1{group_id}~1configs~1{name}/get
response:
mediaType: application/json
openAPIDocKey: '200'
@@ -5511,13 +6032,15 @@ components:
requestBodyTranslate:
algorithm: naive
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1groups~1{group_id}~1configs~1{name}/put'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1groups~1{group_id}~1configs~1{name}/put
response:
mediaType: application/json
openAPIDocKey: '204'
delete_kafka_group_config:
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1groups~1{group_id}~1configs~1{name}/delete'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1groups~1{group_id}~1configs~1{name}/delete
response:
mediaType: application/json
openAPIDocKey: '204'
@@ -5526,29 +6049,41 @@ components:
requestBodyTranslate:
algorithm: naive
operation:
- $ref: '#/paths/~1kafka~1v3~1clusters~1{cluster_id}~1groups~1{group_id}~1configs:alter/post'
+ $ref: >-
+ #/paths/~1kafka~1v3~1clusters~1{cluster_id}~1groups~1{group_id}~1configs:alter/post
response:
mediaType: application/json
openAPIDocKey: '204'
sqlVerbs:
select:
- - $ref: '#/components/x-stackQL-resources/group_configs/methods/get_kafka_group_config'
- - $ref: '#/components/x-stackQL-resources/group_configs/methods/list_kafka_group_configs'
+ - $ref: >-
+ #/components/x-stackQL-resources/group_configs/methods/get_kafka_group_config
+ - $ref: >-
+ #/components/x-stackQL-resources/group_configs/methods/list_kafka_group_configs
insert: []
update: []
delete:
- - $ref: '#/components/x-stackQL-resources/group_configs/methods/delete_kafka_group_config'
+ - $ref: >-
+ #/components/x-stackQL-resources/group_configs/methods/delete_kafka_group_config
replace:
- - $ref: '#/components/x-stackQL-resources/group_configs/methods/update_kafka_group_config'
+ - $ref: >-
+ #/components/x-stackQL-resources/group_configs/methods/update_kafka_group_config
servers:
- url: https://{kafka_endpoint_id}.{region}.{cloud_provider}.confluent.cloud
variables:
kafka_endpoint_id:
default: pkc-00000
- description: Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint).
+ description: >-
+ Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the
+ Confluent UI Cluster -> Overview -> REST endpoint, or extract from
+ confluent.managed_kafka_clusters.clusters spec.http_endpoint).
region:
default: region
- description: Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region).
+ description: >-
+ Cloud region the cluster runs in, e.g. ap-southeast-2 (from the
+ cluster spec.region).
cloud_provider:
default: cloud
- description: 'Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud).'
+ description: >-
+ Cloud provider, lowercase: aws, gcp, or azure (from the cluster
+ spec.cloud).
diff --git a/providers/src/confluent/v00.00.00000/services/share_group.yaml b/providers/src/kafka/v00.00.00000/services/share_group.yaml
similarity index 97%
rename from providers/src/confluent/v00.00.00000/services/share_group.yaml
rename to providers/src/kafka/v00.00.00000/services/share_group.yaml
index 9a8ea1e5..96f08f81 100644
--- a/providers/src/confluent/v00.00.00000/services/share_group.yaml
+++ b/providers/src/kafka/v00.00.00000/services/share_group.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: share_group API
- description: confluent share_group API
+ description: kafka share_group API
version: 1.0.0
paths:
/kafka/v3/clusters/{cluster_id}/share-groups:
@@ -854,7 +854,7 @@ components:
example: consumer-1
x-stackQL-resources:
share_groups:
- id: confluent.share_group.share_groups
+ id: kafka.share_group.share_groups
name: share_groups
title: Share Groups
methods:
@@ -892,7 +892,7 @@ components:
#/components/x-stackQL-resources/share_groups/methods/delete_kafka_share_group
replace: []
consumers:
- id: confluent.share_group.consumers
+ id: kafka.share_group.consumers
name: consumers
title: Consumers
methods:
@@ -922,7 +922,7 @@ components:
delete: []
replace: []
consumer_assignments:
- id: confluent.share_group.consumer_assignments
+ id: kafka.share_group.consumer_assignments
name: consumer_assignments
title: Consumer Assignments
methods:
@@ -943,4 +943,21 @@ components:
delete: []
replace: []
servers:
- - url: https://api.confluent.cloud
+ - url: https://{kafka_endpoint_id}.{region}.{cloud_provider}.confluent.cloud
+ variables:
+ kafka_endpoint_id:
+ default: pkc-00000
+ description: >-
+ Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the
+ Confluent UI Cluster -> Overview -> REST endpoint, or extract from
+ confluent.managed_kafka_clusters.clusters spec.http_endpoint).
+ region:
+ default: region
+ description: >-
+ Cloud region the cluster runs in, e.g. ap-southeast-2 (from the
+ cluster spec.region).
+ cloud_provider:
+ default: cloud
+ description: >-
+ Cloud provider, lowercase: aws, gcp, or azure (from the cluster
+ spec.cloud).
diff --git a/providers/src/confluent/v00.00.00000/services/streams_group.yaml b/providers/src/kafka/v00.00.00000/services/streams_group.yaml
similarity index 97%
rename from providers/src/confluent/v00.00.00000/services/streams_group.yaml
rename to providers/src/kafka/v00.00.00000/services/streams_group.yaml
index 4e64006f..5045edf6 100644
--- a/providers/src/confluent/v00.00.00000/services/streams_group.yaml
+++ b/providers/src/kafka/v00.00.00000/services/streams_group.yaml
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: streams_group API
- description: confluent streams_group API
+ description: kafka streams_group API
version: 1.0.0
paths:
/kafka/v3/clusters/{cluster_id}/streams-groups:
@@ -1127,7 +1127,7 @@ components:
example: active
x-stackQL-resources:
streams_groups:
- id: confluent.streams_group.streams_groups
+ id: kafka.streams_group.streams_groups
name: streams_groups
title: Streams Groups
methods:
@@ -1156,7 +1156,7 @@ components:
delete: []
replace: []
subtopologies:
- id: confluent.streams_group.subtopologies
+ id: kafka.streams_group.subtopologies
name: subtopologies
title: Subtopologies
methods:
@@ -1186,7 +1186,7 @@ components:
delete: []
replace: []
members:
- id: confluent.streams_group.members
+ id: kafka.streams_group.members
name: members
title: Members
methods:
@@ -1216,7 +1216,7 @@ components:
delete: []
replace: []
member_assignments:
- id: confluent.streams_group.member_assignments
+ id: kafka.streams_group.member_assignments
name: member_assignments
title: Member Assignments
methods:
@@ -1236,7 +1236,7 @@ components:
delete: []
replace: []
member_target_assignments:
- id: confluent.streams_group.member_target_assignments
+ id: kafka.streams_group.member_target_assignments
name: member_target_assignments
title: Member Target Assignments
methods:
@@ -1256,7 +1256,7 @@ components:
delete: []
replace: []
member_assignment_tasks:
- id: confluent.streams_group.member_assignment_tasks
+ id: kafka.streams_group.member_assignment_tasks
name: member_assignment_tasks
title: Member Assignment Tasks
methods:
@@ -1277,7 +1277,7 @@ components:
delete: []
replace: []
member_target_assignment_tasks:
- id: confluent.streams_group.member_target_assignment_tasks
+ id: kafka.streams_group.member_target_assignment_tasks
name: member_target_assignment_tasks
title: Member Target Assignment Tasks
methods:
@@ -1298,7 +1298,7 @@ components:
delete: []
replace: []
member_assignment_task_partitions:
- id: confluent.streams_group.member_assignment_task_partitions
+ id: kafka.streams_group.member_assignment_task_partitions
name: member_assignment_task_partitions
title: Member Assignment Task Partitions
methods:
@@ -1318,7 +1318,7 @@ components:
delete: []
replace: []
member_target_assignment_task_partitions:
- id: confluent.streams_group.member_target_assignment_task_partitions
+ id: kafka.streams_group.member_target_assignment_task_partitions
name: member_target_assignment_task_partitions
title: Member Target Assignment Task Partitions
methods:
@@ -1338,4 +1338,21 @@ components:
delete: []
replace: []
servers:
- - url: https://api.confluent.cloud
+ - url: https://{kafka_endpoint_id}.{region}.{cloud_provider}.confluent.cloud
+ variables:
+ kafka_endpoint_id:
+ default: pkc-00000
+ description: >-
+ Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the
+ Confluent UI Cluster -> Overview -> REST endpoint, or extract from
+ confluent.managed_kafka_clusters.clusters spec.http_endpoint).
+ region:
+ default: region
+ description: >-
+ Cloud region the cluster runs in, e.g. ap-southeast-2 (from the
+ cluster spec.region).
+ cloud_provider:
+ default: cloud
+ description: >-
+ Cloud provider, lowercase: aws, gcp, or azure (from the cluster
+ spec.cloud).