diff --git a/README.md b/README.md index b188943..2ccacf1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # `confluent` provider for [`stackql`](https://github.com/stackql/stackql) -This repository is used to generate and document the `confluent` provider for StackQL, allowing you to query and manage Confluent Cloud resources using SQL-like syntax. The provider is built using the [`@stackql/provider-utils`](https://www.npmjs.com/package/@stackql/provider-utils) package (v0.6.4+), which provides tools for converting OpenAPI specifications into StackQL-compatible provider schemas. +This repository is used to generate and document the `confluent` provider for StackQL, allowing you to query and manage Confluent Cloud resources using SQL-like syntax. The provider is built using the [`@stackql/provider-utils`](https://www.npmjs.com/package/@stackql/provider-utils) package (v0.7.0+), which provides tools for converting OpenAPI specifications into StackQL-compatible provider schemas. ## Prerequisites @@ -99,7 +99,12 @@ npm run split -- \ ## 4. Normalize the split specs -This pass clobbers polymorphism (`oneOf` / `allOf` flattening) and patches missing `type: object` declarations so the StackQL schema is well-formed: +This pass does several mechanical fixups to make the source well-formed for the analyze and generate passes that follow: + +- Clobbers polymorphism (`oneOf` / `allOf` flattening) and patches missing `type: object` declarations. +- Lifts path-item-level `parameters` into each operation's `parameters` array (so path templates like `{environment_id}` actually substitute when StackQL builds the request URL). +- Strips non-root `servers:` overrides at the path-item and operation level (they're often placeholder hosts that fail DNS). +- Wraps bare top-level array responses (e.g. `["a","b"]`) into a synthesised object envelope so StackQL's row projection has an `objectKey` to latch onto. The wrapper key is derived from the operationId; pass `--bare-array-overrides FILE.json` to override the naming on a per-op basis if the heuristic picks a poor name. ```bash npm run normalize -- \ @@ -136,6 +141,47 @@ npm run generate-provider -- \ The auth block matches the existing `provider.yaml` (`CONFLUENT_CLOUD_API_KEY` / `CONFLUENT_CLOUD_API_SECRET`). +### Convenience views + +Convenience views live under `views//views.yaml` and define flattened, parameterised SELECT shapes over the API-derived resources (e.g. `confluent.managed_kafka_clusters.vw_clusters` flattens the cluster envelope so users don't have to write `JSON_EXTRACT`). Each `views.yaml` is a YAML fragment whose top-level keys are view names, indented as if it already lived under `components.x-stackQL-resources` (4-space indent at the resource-key level). + +`generate-provider` auto-discovers the `views/` directory in the project root and splices each top-level view entry into the matching service spec under `components.x-stackQL-resources`, as a sibling of the API resources. Pass `--views-dir DIR` to point at a different location. Existing API-derived resources always win on key collisions. + +### Kafka REST v3 per-cluster server template + +Confluent's Kafka REST v3 surface (`/kafka/v3/...`) is a per-cluster dataplane — each cluster lives at its own host (`https://...confluent.cloud`), not at `api.confluent.cloud`. The OpenAPI spec ships a placeholder host (`pkc-00000.region.provider.confluent.cloud`) that is not a real DNS name; queries against it fail DNS. + +After `generate-provider`, run: + +```bash +npm run replace-kafka-servers +``` + +The script swaps `kafka.yaml`'s root `servers:` block for a three-variable templated URL: + +```yaml +servers: + - url: https://{kafka_endpoint_id}.{region}.{cloud_provider}.confluent.cloud + variables: + kafka_endpoint_id: { default: pkc-00000, ... } + region: { default: region, ... } + cloud_provider: { default: cloud, ... } +``` + +StackQL binds these variables from the `WHERE` clause at query time, so users supply the cluster coordinates per query: + +```sql +SELECT cluster_id, topic_name FROM confluent.kafka.topics +WHERE cluster_id = 'lkc-50r5wn' + AND kafka_endpoint_id = 'pkc-ldvj1' + AND region = 'ap-southeast-2' + AND cloud_provider = 'aws'; +``` + +Idempotent: re-runs after the first apply report `already in sync` and exit clean. Confluent-specific exception — do not generalise upstream. + +> Note: the per-cluster Kafka REST v3 endpoints require a **cluster-scoped Resource API key** (generated in the Confluent UI under `Cluster -> API Keys`), not the org-level Cloud API key used for control-plane resources. Auth wiring for this is a separate concern — the `replace-kafka-servers` step only fixes URL routing. + ## 7. Test the provider @@ -193,27 +239,45 @@ SELECT FROM confluent.managed_kafka_clusters.clusters WHERE environment = 'env-216dqo'; --- List topics in a Kafka cluster +-- Use view SELECT - topic_name, - partitions_count, - replication_factor -FROM confluent.kafka.topic -WHERE cluster_id = 'lkc-abcdef'; + id, + display_name, + cloud, + region, + availability, + config_kind, + phase, + kafka_bootstrap_endpoint +FROM confluent.managed_kafka_clusters.vw_clusters +WHERE environment = 'env-216dqo'; --- List Schema Registry clusters SELECT - id, - spec -FROM confluent.schema_registry_clusters.clusters -WHERE environment = 'env-abc123'; +* +FROM confluent.connect.connectors +WHERE environment_id = 'env-216dqo' +AND +kafka_cluster_id = 'lkc-50r5wn'; --- List service accounts +-- List topics in a Kafka cluster (change creds) SELECT - id, - display_name, - description -FROM confluent.iam.service_accounts; +cluster_id, +topic_name, +authorized_operations, +configs, +is_internal, +kind, +metadata, +partition_reassignments, +partitions, +partitions_count, +replication_factor +FROM confluent.kafka.topics +WHERE cluster_id = 'lkc-50r5wn' +AND cloud_provider = 'aws' +AND region = 'ap-southeast-2' +AND kafka_endpoint_id = 'pkc-ldvj1' +; ``` ## 8. Publish the provider diff --git a/package-lock.json b/package-lock.json index aeb631e..c13dfba 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "0.1.0", "dependencies": { "@stackql/pgwire-lite": "^1.0.1", - "@stackql/provider-utils": "^0.6.5" + "@stackql/provider-utils": "^0.7.4" }, "engines": { "node": ">=14.16.0" @@ -110,9 +110,9 @@ } }, "node_modules/@stackql/provider-utils": { - "version": "0.6.5", - "resolved": "https://registry.npmjs.org/@stackql/provider-utils/-/provider-utils-0.6.5.tgz", - "integrity": "sha512-Bh6anOyOA0qo0PbbjNmvOY2iEW323hY8rdJotBEyCz9gRdEFlBHp1wq78R0dj0cOY5MxmW4k5Wn78TqLZSNTLg==", + "version": "0.7.4", + "resolved": "https://registry.npmjs.org/@stackql/provider-utils/-/provider-utils-0.7.4.tgz", + "integrity": "sha512-tpL2w6fCNLNfsYXmD+35OWxyXBr/dLe7+Y/yPX/baEm+Z/pKC7Zd81FUZGV2vwHZjM/Jb8JCxGIz//emso0X6g==", "license": "MIT", "dependencies": { "@apidevtools/swagger-parser": "^10.1.1", diff --git a/package.json b/package.json index e12fdf7..bf52c59 100644 --- a/package.json +++ b/package.json @@ -9,6 +9,7 @@ "normalize": "node node_modules/@stackql/provider-utils/bin/provider-dev-utils.mjs normalize", "generate-mappings": "node node_modules/@stackql/provider-utils/bin/provider-dev-utils.mjs analyze", "generate-provider": "node node_modules/@stackql/provider-utils/bin/provider-dev-utils.mjs generate", + "replace-kafka-servers": "node provider-dev/scripts/replace_kafka_servers.mjs", "start-server": "bash ./bin/start-server.sh", "stop-server": "bash ./bin/stop-server.sh", "server-status": "bash ./bin/server-status.sh", @@ -16,7 +17,7 @@ }, "dependencies": { "@stackql/pgwire-lite": "^1.0.1", - "@stackql/provider-utils": "^0.6.5" + "@stackql/provider-utils": "^0.7.4" }, "keywords": [ "stackql", diff --git a/provider-dev/config/svc_name_overrides.json b/provider-dev/config/svc_name_overrides.json new file mode 100644 index 0000000..c3bcf46 --- /dev/null +++ b/provider-dev/config/svc_name_overrides.json @@ -0,0 +1,33 @@ +{ + "acl": "kafka", + "artifact": "flink_artifacts", + "byok": "encryption_keys", + "cdx": "stream_sharing", + "cluster": "kafka", + "cluster_linking": "kafka", + "cmk": "managed_kafka_clusters", + "compatibility": "schema_registry", + "config": "schema_registry", + "configs": "kafka", + "consumer_group": "kafka", + "contexts": "schema_registry", + "data_encryption_keys": "encryption_keys", + "endpoint": "endpoints", + "entity": "catalog", + "exporters": "schema_registry", + "fcpm": "flink_compute_pools", + "kafka_quotas": "quotas", + "key_encryption_keys": "encryption_keys", + "ksqldbcm": "ksqldb_clusters", + "modes": "schema_registry", + "partition": "kafka", + "pim": "provider_integrations", + "records": "kafka", + "schemas": "schema_registry", + "search": "catalog", + "service_quota": "quotas", + "srcm": "schema_registry_clusters", + "subjects": "schema_registry", + "topic": "kafka", + "types": "catalog" +} diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/catalog.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/catalog.yaml index 503e3fa..ba9d661 100644 --- a/provider-dev/openapi/src/confluent/v00.00.00000/services/catalog.yaml +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/catalog.yaml @@ -30,9 +30,7 @@ paths: content: application/json: schema: - items: - $ref: '#/components/schemas/BusinessMetadataDefResponse' - type: array + $ref: '#/components/schemas/GetAllBusinessMetadataDefsResponse' description: The business metadata definitions '400': description: Bad Request @@ -64,9 +62,7 @@ paths: content: application/json: schema: - items: - $ref: '#/components/schemas/BusinessMetadataDefResponse' - type: array + $ref: '#/components/schemas/CreateBusinessMetadataDefsResponse' description: >- The business metadata definitions. Errored business metadata definitions will have an additional error property. @@ -100,9 +96,7 @@ paths: content: application/json: schema: - items: - $ref: '#/components/schemas/BusinessMetadataDefResponse' - type: array + $ref: '#/components/schemas/UpdateBusinessMetadataDefsResponse' description: >- The business metadata definitions. Errored business metadata definitions will have an additional error property. @@ -112,11 +106,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: >- - Confluent Cloud Schema Registry Endpoint. For example - https://psrc-00000.region.provider.confluent.cloud /catalog/v1/types/businessmetadatadefs/{bmName}: delete: summary: Delete Business Metadata Definition @@ -182,11 +171,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: >- - Confluent Cloud Schema Registry Endpoint. For example - https://psrc-00000.region.provider.confluent.cloud /catalog/v1/entity/businessmetadata: post: summary: Bulk Create Business Metadata @@ -212,9 +196,7 @@ paths: content: application/json: schema: - items: - $ref: '#/components/schemas/BusinessMetadataResponse' - type: array + $ref: '#/components/schemas/CreateBusinessMetadataResponse' description: >- The business metadata. Errored business metadata will have an additional error property. @@ -248,9 +230,7 @@ paths: content: application/json: schema: - items: - $ref: '#/components/schemas/BusinessMetadataResponse' - type: array + $ref: '#/components/schemas/UpdateBusinessMetadataResponse' description: >- The business metadata. Errored business metadata will have an additional error property. @@ -260,11 +240,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: >- - Confluent Cloud Schema Registry Endpoint. For example - https://psrc-00000.region.provider.confluent.cloud /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata: get: summary: Read Business Metadata for an Entity @@ -301,9 +276,7 @@ paths: content: application/json: schema: - items: - $ref: '#/components/schemas/BusinessMetadataResponse' - type: array + $ref: '#/components/schemas/GetBusinessMetadataResponse' description: The business metadata '400': description: Bad Request @@ -313,11 +286,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: >- - Confluent Cloud Schema Registry Endpoint. For example - https://psrc-00000.region.provider.confluent.cloud /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata/{bmName}: delete: summary: Delete a Business Metadata for an Entity @@ -364,11 +332,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: >- - Confluent Cloud Schema Registry Endpoint. For example - https://psrc-00000.region.provider.confluent.cloud /catalog/v1/entity/tags: put: summary: Bulk Update Tags @@ -395,9 +358,7 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/TagResponse' + $ref: '#/components/schemas/UpdateTagsResponse' '400': description: Bad Request '429': @@ -429,20 +390,13 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/TagResponse' + $ref: '#/components/schemas/CreateTagsResponse' '400': description: Bad Request '429': description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: >- - Confluent Cloud Schema Registry Endpoint. For example - https://psrc-00000.region.provider.confluent.cloud /catalog/v1/entity/type/{typeName}/name/{qualifiedName}: get: summary: Read an Entity @@ -496,11 +450,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: >- - Confluent Cloud Schema Registry Endpoint. For example - https://psrc-00000.region.provider.confluent.cloud /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags: get: summary: Read Tags for an Entity @@ -533,9 +482,7 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/TagResponse' + $ref: '#/components/schemas/GetTagsResponse' '400': description: Bad Request '404': @@ -544,11 +491,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: >- - Confluent Cloud Schema Registry Endpoint. For example - https://psrc-00000.region.provider.confluent.cloud /catalog/v1/entity: put: summary: Update an Entity Attribute @@ -582,11 +524,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: >- - Confluent Cloud Schema Registry Endpoint. For example - https://psrc-00000.region.provider.confluent.cloud /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags/{tagName}: delete: summary: Delete a Tag for an Entity @@ -627,11 +564,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: >- - Confluent Cloud Schema Registry Endpoint. For example - https://psrc-00000.region.provider.confluent.cloud /catalog/v1/search/attribute: get: summary: Search by Attribute @@ -731,11 +663,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: >- - Confluent Cloud Schema Registry Endpoint. For example - https://psrc-00000.region.provider.confluent.cloud /catalog/v1/search/basic: get: summary: Search by Fulltext Query @@ -822,11 +749,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: >- - Confluent Cloud Schema Registry Endpoint. For example - https://psrc-00000.region.provider.confluent.cloud /catalog/v1/types/tagdefs: get: summary: Bulk Read Tag Definitions @@ -851,9 +773,7 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/TagDefResponse' + $ref: '#/components/schemas/GetAllTagDefsResponse' '400': description: Bad Request '429': @@ -887,9 +807,7 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/TagDefResponse' + $ref: '#/components/schemas/UpdateTagDefsResponse' '400': description: Bad Request '429': @@ -923,20 +841,13 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/TagDefResponse' + $ref: '#/components/schemas/CreateTagDefsResponse' '400': description: Bad Request '429': description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: >- - Confluent Cloud Schema Registry Endpoint. For example - https://psrc-00000.region.provider.confluent.cloud /catalog/v1/types/tagdefs/{tagName}: get: summary: Read Tag Definition @@ -998,11 +909,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: >- - Confluent Cloud Schema Registry Endpoint. For example - https://psrc-00000.region.provider.confluent.cloud components: schemas: BusinessMetadataDefResponse: @@ -1817,6 +1723,90 @@ components: removePropagationsOnEntityDelete: type: boolean description: Whether to remove propagations on entity delete + GetAllBusinessMetadataDefsResponse: + type: object + properties: + business_metadata_defs: + type: array + items: + $ref: '#/components/schemas/BusinessMetadataDefResponse' + CreateBusinessMetadataDefsResponse: + type: object + properties: + create_business_metadata_defs: + type: array + items: + $ref: '#/components/schemas/BusinessMetadataDefResponse' + UpdateBusinessMetadataDefsResponse: + type: object + properties: + update_business_metadata_defs: + type: array + items: + $ref: '#/components/schemas/BusinessMetadataDefResponse' + CreateBusinessMetadataResponse: + type: object + properties: + create_business_metadata: + type: array + items: + $ref: '#/components/schemas/BusinessMetadataResponse' + UpdateBusinessMetadataResponse: + type: object + properties: + update_business_metadata: + type: array + items: + $ref: '#/components/schemas/BusinessMetadataResponse' + GetBusinessMetadataResponse: + type: object + properties: + business_metadata: + type: array + items: + $ref: '#/components/schemas/BusinessMetadataResponse' + UpdateTagsResponse: + type: object + properties: + update_tags: + type: array + items: + $ref: '#/components/schemas/TagResponse' + CreateTagsResponse: + type: object + properties: + create_tags: + type: array + items: + $ref: '#/components/schemas/TagResponse' + GetTagsResponse: + type: object + properties: + tags: + type: array + items: + $ref: '#/components/schemas/TagResponse' + GetAllTagDefsResponse: + type: object + properties: + tag_defs: + type: array + items: + $ref: '#/components/schemas/TagDefResponse' + UpdateTagDefsResponse: + type: object + properties: + update_tag_defs: + type: array + items: + $ref: '#/components/schemas/TagDefResponse' + CreateTagDefsResponse: + type: object + properties: + create_tag_defs: + type: array + items: + $ref: '#/components/schemas/TagDefResponse' x-stackQL-resources: business_metadata_defs: id: confluent.catalog.business_metadata_defs @@ -1829,7 +1819,15 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $ + objectKey: $.business_metadata_defs + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/GetAllBusinessMetadataDefsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"business_metadata_defs\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 create_business_metadata_defs: config: requestBodyTranslate: @@ -1839,6 +1837,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.create_business_metadata_defs + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/CreateBusinessMetadataDefsResponse' + transform: + body: >- + {{- $wrapped := printf "{\"create_business_metadata_defs\":%s}" + . -}} + + {{- $wrapped -}} + type: golang_template_text_v0.3.0 update_business_metadata_defs: config: requestBodyTranslate: @@ -1848,6 +1857,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.update_business_metadata_defs + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/UpdateBusinessMetadataDefsResponse' + transform: + body: >- + {{- $wrapped := printf "{\"update_business_metadata_defs\":%s}" + . -}} + + {{- $wrapped -}} + type: golang_template_text_v0.3.0 delete_business_metadata_def: operation: $ref: >- @@ -1891,6 +1911,15 @@ components: response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.create_business_metadata + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/CreateBusinessMetadataResponse' + transform: + body: |- + {{- $wrapped := printf "{\"create_business_metadata\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 update_business_metadata: config: requestBodyTranslate: @@ -1900,6 +1929,15 @@ components: response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.update_business_metadata + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/UpdateBusinessMetadataResponse' + transform: + body: |- + {{- $wrapped := printf "{\"update_business_metadata\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 get_business_metadata: operation: $ref: >- @@ -1907,7 +1945,15 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $ + objectKey: $.business_metadata + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/GetBusinessMetadataResponse' + transform: + body: |- + {{- $wrapped := printf "{\"business_metadata\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 delete_business_metadata: operation: $ref: >- @@ -1943,6 +1989,15 @@ components: response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.update_tags + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/UpdateTagsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"update_tags\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 create_tags: config: requestBodyTranslate: @@ -1952,6 +2007,15 @@ components: response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.create_tags + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/CreateTagsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"create_tags\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 get_tags: operation: $ref: >- @@ -1959,7 +2023,15 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $ + objectKey: $.tags + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/GetTagsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"tags\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 delete_tag: operation: $ref: >- @@ -2031,7 +2103,15 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $ + objectKey: $.tag_defs + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/GetAllTagDefsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"tag_defs\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 update_tag_defs: config: requestBodyTranslate: @@ -2041,6 +2121,15 @@ components: response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.update_tag_defs + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/UpdateTagDefsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"update_tag_defs\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 create_tag_defs: config: requestBodyTranslate: @@ -2050,6 +2139,15 @@ components: response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.create_tag_defs + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/CreateTagDefsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"create_tag_defs\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 get_tag_def_by_name: operation: $ref: '#/paths/~1catalog~1v1~1types~1tagdefs~1{tagName}/get' diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/connect.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/connect.yaml index cd0fb15..2d8f299 100644 --- a/provider-dev/openapi/src/confluent/v00.00.00000/services/connect.yaml +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/connect.yaml @@ -22,18 +22,26 @@ paths: security: - cloud-api-key: [] - confluent-sts-access-token: [] - parameters: [] + parameters: + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. responses: '200': description: Connector. content: application/json: schema: - type: array - description: List of connector names - items: - type: string - description: Connector name + $ref: '#/components/schemas/ListConnectv1ConnectorsResponse' example: - MyGcsLogsBucketConnector - MyS3BucketConnector @@ -272,20 +280,20 @@ paths: pos: 154 ts_sec: 1712907333 description: '' + parameters: + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors?expand=info,status,id: get: x-lifecycle-stage: General Availability @@ -548,6 +556,25 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. put: x-lifecycle-stage: General Availability operationId: createOrUpdateConnectv1ConnectorConfig @@ -713,26 +740,26 @@ paths: message: >- Failed to find any class that implements Connector and which name matches io.confluent.connect.... + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}: get: x-lifecycle-stage: General Availability @@ -786,6 +813,25 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. delete: x-lifecycle-stage: General Availability operationId: deleteConnectv1Connector @@ -813,26 +859,26 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/pause: put: x-lifecycle-stage: General Availability @@ -862,26 +908,26 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/resume: put: x-lifecycle-stage: General Availability @@ -911,26 +957,26 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/restart: post: x-lifecycle-stage: Preview @@ -960,26 +1006,26 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: Preview - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status: get: x-lifecycle-stage: General Availability @@ -1076,26 +1122,26 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks: get: x-lifecycle-stage: General Availability @@ -1118,7 +1164,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/connect.v1.Connectors' + $ref: '#/components/schemas/ListConnectv1ConnectorTasksResponse' example: - id: connector: MyGcsLogsBucketConnector @@ -1147,26 +1193,26 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins: get: x-lifecycle-stage: General Availability @@ -1190,25 +1236,7 @@ paths: content: application/json: schema: - type: array - items: - type: object - properties: - class: - type: string - description: The connector class name. E.g. BigQuerySink. - type: - type: string - description: Type of connector, sink or source. - enum: - - sink - - source - version: - type: string - description: The version string for the connector available. - required: - - class - - type + $ref: '#/components/schemas/ListConnectv1ConnectorPluginsResponse' example: - class: BigQuerySink type: sink @@ -1231,21 +1259,20 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' - parameters: [] + parameters: + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/validate: put: x-lifecycle-stage: General Availability @@ -1692,26 +1719,26 @@ paths: description: >- Configuration parameters for the connector. All values should be strings. + parameters: + - name: plugin_name + in: path + schema: + type: string + required: true + description: The unique name of the connector plugin. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: plugin_name - in: path - schema: - type: string - required: true - description: The unique name of the connector plugin. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/translate?mask_sensitive=true: put: x-lifecycle-stage: General Availability @@ -1855,33 +1882,33 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: plugin_name + in: path + schema: + type: string + required: true + description: The unique name of the connector plugin. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + - name: mask_sensitive + in: query + required: false + schema: + type: string + maxLength: 255 + description: Indicates whether to redact sensitive config values in response. x-lifecycle-stage: General Availability - parameters: - - name: plugin_name - in: path - schema: - type: string - required: true - description: The unique name of the connector plugin. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. - - name: mask_sensitive - in: query - required: false - schema: - type: string - maxLength: 255 - description: Indicates whether to redact sensitive config values in response. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets: get: x-lifecycle-stage: General Availability @@ -1953,26 +1980,26 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request: post: x-lifecycle-stage: General Availability @@ -2063,26 +2090,26 @@ paths: delete: value: type: DELETE + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status: get: x-lifecycle-stage: General Availability @@ -2191,26 +2218,26 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/custom-connector-plugins: get: x-lifecycle-stage: General Availability @@ -6142,6 +6169,129 @@ components: type: string nullable: true additionalProperties: false + ListConnectv1ConnectorsResponse: + type: object + properties: + connectv1_connectors: + type: array + items: + type: object + properties: + connectv1_connector: + type: string + ListConnectv1ConnectorTasksResponse: + type: object + properties: + connectv1_connector_tasks: + type: array + items: + type: object + properties: + id: + type: object + description: The ID of task. + properties: + connector: + type: string + description: The name of the connector the task belongs to. + task: + type: integer + description: Task ID within the connector. + config: + type: object + description: >- + Configuration parameters for the connector. These + configurations + + are the minimum set of key-value pairs (KVP) which can be used + to + + define how the connector connects Kafka to the external + system. + + Some of these KVPs are common to all the connectors, such as + + connection parameters to Kafka, connector metadata, etc. The + list + + of common connector configurations is as follows + + - cloud.environment + - cloud.provider + - connector.class + - kafka.api.key + - kafka.api.secret + - kafka.endpoint + - kafka.region + - name + + A specific connector such as `GcsSink` would have additional + + parameters such as `gcs.bucket.name`, `flush.size`, etc. + required: + - cloud.environment + - cloud.provider + - connector.class + - name + - kafka.endpoint + - kafka.region + - kafka.api.key + - kafka.api.secret + properties: + cloud.environment: + type: string + description: The cloud environment type. + cloud.provider: + type: string + description: The cloud service provider, e.g. aws, azure, etc. + x-extensible-enum: + - aws + - azure + - gcp + connector.class: + type: string + description: The connector class name. E.g. BigQuerySink, GcsSink, etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + kafka.endpoint: + type: string + description: The kafka cluster endpoint. + kafka.region: + type: string + description: The kafka cluster region. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + additionalProperties: + type: string + ListConnectv1ConnectorPluginsResponse: + type: object + properties: + connectv1_connector_plugins: + type: array + items: + type: object + properties: + class: + type: string + description: The connector class name. E.g. BigQuerySink. + type: + type: string + description: Type of connector, sink or source. + enum: + - sink + - source + version: + type: string + description: The version string for the connector available. + required: + - class + - type responses: connect.v1.UnauthenticatedError: description: Unauthorized @@ -6729,7 +6879,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $ + objectKey: $.connectv1_connectors + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListConnectv1ConnectorsResponse' + transform: + body: >- + {{- $wrapped := printf "{\"items\":%s}" . -}} + + {{- $parsed := jsonMapFromString $wrapped -}} + + {{- $items := index $parsed "items" -}} + + {"connectv1_connectors":[{{- range $i, $v := $items -}}{{- if $i + -}},{{- end -}}{"connectv1_connector":"{{- $v -}}"}{{- end -}}]} + type: golang_template_text_v0.3.0 create_connectv1_connector: config: requestBodyTranslate: @@ -6860,7 +7024,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $ + objectKey: $.connectv1_connector_tasks + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListConnectv1ConnectorTasksResponse' + transform: + body: >- + {{- $wrapped := printf "{\"connectv1_connector_tasks\":%s}" . + -}} + + {{- $wrapped -}} + type: golang_template_text_v0.3.0 sqlVerbs: select: - $ref: >- @@ -6881,7 +7055,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - objectKey: $ + objectKey: $.connectv1_connector_plugins + overrideMediaType: application/json + schema_override: + $ref: '#/components/schemas/ListConnectv1ConnectorPluginsResponse' + transform: + body: >- + {{- $wrapped := printf "{\"connectv1_connector_plugins\":%s}" . + -}} + + {{- $wrapped -}} + type: golang_template_text_v0.3.0 validate_connectv1_connector_plugin: config: requestBodyTranslate: diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/encryption_keys.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/encryption_keys.yaml index 9d46a5d..5afbba1 100644 --- a/provider-dev/openapi/src/confluent/v00.00.00000/services/encryption_keys.yaml +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/encryption_keys.yaml @@ -23,10 +23,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - items: - example: mykek - type: string - type: array + $ref: '#/components/schemas/GetKekNamesResponse' application/vnd.schemaregistry+json; qs=0.9: schema: items: @@ -97,9 +94,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /dek-registry/v1/keks/{name}: delete: tags: @@ -240,9 +234,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /dek-registry/v1/keks/{name}/undelete: post: tags: @@ -270,9 +261,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /dek-registry/v1/keks/{name}/test: post: tags: @@ -308,9 +296,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /dek-registry/v1/keks/{name}/deks: get: tags: @@ -356,10 +341,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - items: - example: User - type: string - type: array + $ref: '#/components/schemas/GetDekSubjectsResponse' application/vnd.schemaregistry+json; qs=0.9: schema: items: @@ -435,9 +417,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /dek-registry/v1/keks/{name}/deks/{subject}: delete: tags: @@ -557,9 +536,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}: delete: tags: @@ -699,9 +675,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /dek-registry/v1/keks/{name}/deks/{subject}/versions: get: tags: @@ -767,11 +740,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - items: - example: 1 - format: int32 - type: integer - type: array + $ref: '#/components/schemas/GetDekVersionsResponse' application/vnd.schemaregistry+json; qs=0.9: schema: items: @@ -795,9 +764,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}/undelete: post: tags: @@ -855,9 +821,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /dek-registry/v1/keks/{name}/deks/{subject}/undelete: post: tags: @@ -905,9 +868,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /byok/v1/keys: get: x-lifecycle-stage: General Availability @@ -4022,6 +3982,36 @@ components: type: string nullable: true additionalProperties: false + GetKekNamesResponse: + type: object + properties: + kek_names: + type: array + items: + type: object + properties: + kek_name: + type: string + GetDekSubjectsResponse: + type: object + properties: + dek_subjects: + type: array + items: + type: object + properties: + dek_subject: + type: string + GetDekVersionsResponse: + type: object + properties: + dek_versions: + type: array + items: + type: object + properties: + dek_version: + type: integer responses: BadRequestError: description: Bad Request @@ -4556,7 +4546,21 @@ components: response: mediaType: application/vnd.schemaregistry.v1+json openAPIDocKey: '200' - objectKey: $ + objectKey: $.kek_names + overrideMediaType: application/vnd.schemaregistry.v1+json + schema_override: + $ref: '#/components/schemas/GetKekNamesResponse' + transform: + body: >- + {{- $wrapped := printf "{\"items\":%s}" . -}} + + {{- $parsed := jsonMapFromString $wrapped -}} + + {{- $items := index $parsed "items" -}} + + {"kek_names":[{{- range $i, $v := $items -}}{{- if $i -}},{{- + end -}}{"kek_name":"{{- $v -}}"}{{- end -}}]} + type: golang_template_text_v0.3.0 create_kek: config: requestBodyTranslate: @@ -4626,7 +4630,21 @@ components: response: mediaType: application/vnd.schemaregistry.v1+json openAPIDocKey: '200' - objectKey: $ + objectKey: $.dek_subjects + overrideMediaType: application/vnd.schemaregistry.v1+json + schema_override: + $ref: '#/components/schemas/GetDekSubjectsResponse' + transform: + body: >- + {{- $wrapped := printf "{\"items\":%s}" . -}} + + {{- $parsed := jsonMapFromString $wrapped -}} + + {{- $items := index $parsed "items" -}} + + {"dek_subjects":[{{- range $i, $v := $items -}}{{- if $i -}},{{- + end -}}{"dek_subject":"{{- $v -}}"}{{- end -}}]} + type: golang_template_text_v0.3.0 create_dek: config: requestBodyTranslate: @@ -4695,7 +4713,21 @@ components: response: mediaType: application/vnd.schemaregistry.v1+json openAPIDocKey: '200' - objectKey: $ + objectKey: $.dek_versions + overrideMediaType: application/vnd.schemaregistry.v1+json + schema_override: + $ref: '#/components/schemas/GetDekVersionsResponse' + transform: + body: >- + {{- $wrapped := printf "{\"items\":%s}" . -}} + + {{- $parsed := jsonMapFromString $wrapped -}} + + {{- $items := index $parsed "items" -}} + + {"dek_versions":[{{- range $i, $v := $items -}}{{- if $i -}},{{- + end -}}{"dek_version":"{{- $v -}}"}{{- end -}}]} + type: golang_template_text_v0.3.0 undelete_dek_version: operation: $ref: >- diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/kafka.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/kafka.yaml index 2057a1b..4b0c18f 100644 --- a/provider-dev/openapi/src/confluent/v00.00.00000/services/kafka.yaml +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/kafka.yaml @@ -8,10 +8,8 @@ paths: get: summary: Get Cluster operationId: getKafkaCluster - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the Kafka cluster with the specified ``cluster_id``. tags: @@ -32,22 +30,14 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' + parameters: + - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/acls:batch: post: summary: Batch Create ACLs operationId: batchCreateKafkaAcls - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Create ACLs. tags: @@ -70,22 +60,14 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' + parameters: + - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/acls: get: summary: List ACLs operationId: getKafkaAcls - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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 @@ -106,6 +88,7 @@ paths: - $ref: '#/components/parameters/AclHost' - $ref: '#/components/parameters/AclOperation' - $ref: '#/components/parameters/AclPermission' + - $ref: '#/components/parameters/ClusterId' responses: '200': $ref: '#/components/responses/SearchAclsResponse' @@ -122,10 +105,8 @@ paths: post: summary: Create an ACL operationId: createKafkaAcls - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Create an ACL. tags: @@ -148,13 +129,13 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' delete: summary: Delete ACLs operationId: deleteKafkaAcls - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Delete the ACLs that match the search criteria. tags: @@ -170,6 +151,7 @@ paths: - $ref: '#/components/parameters/AclHost' - $ref: '#/components/parameters/AclOperationRequired' - $ref: '#/components/parameters/AclPermissionRequired' + - $ref: '#/components/parameters/ClusterId' responses: '200': $ref: '#/components/responses/DeleteAclsResponse' @@ -183,28 +165,15 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/broker-configs: get: summary: List Dynamic Broker Configs operationId: listKafkaClusterConfigs - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - - - Return a list of dynamic cluster-wide broker configuration parameters - for the specified Kafka + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - 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: @@ -223,25 +192,16 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' + parameters: + - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/broker-configs:alter: post: summary: Batch Alter Dynamic Broker Configs operationId: updateKafkaClusterConfigs - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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: @@ -262,25 +222,16 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' + parameters: + - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/broker-configs/{name}: get: summary: Get Dynamic Broker Config operationId: getKafkaClusterConfig - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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: @@ -299,16 +250,16 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConfigName' put: summary: Update Dynamic Broker Config operationId: updateKafkaClusterConfig - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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: @@ -329,16 +280,16 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConfigName' delete: summary: Reset Dynamic Broker Config operationId: deleteKafkaClusterConfig - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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) @@ -358,26 +309,17 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/ConfigName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConfigName' /kafka/v3/clusters/{cluster_id}/consumer-groups: get: summary: List Consumer Groups operationId: listKafkaConsumerGroups - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the list of consumer groups that belong to the specified - Kafka cluster. tags: - Consumer Group (v3) @@ -397,22 +339,14 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' + parameters: + - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}: get: summary: Get Consumer Group operationId: getKafkaConsumerGroup - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the consumer group specified by the ``consumer_group_id``. tags: @@ -433,26 +367,17 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/ConsumerGroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers: get: summary: List Consumers operationId: listKafkaConsumers - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return a list of consumers that belong to the specified consumer - group. tags: - Consumer Group (v3) @@ -472,28 +397,17 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/ConsumerGroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lag-summary: get: summary: Get Consumer Group Lag Summary operationId: getKafkaConsumerGroupLagSummary - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - [![Available in dedicated clusters - only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Available in dedicated clusters only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](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) @@ -513,28 +427,17 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/ConsumerGroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags: get: summary: List Consumer Lags operationId: listKafkaConsumerLags - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - [![Available in dedicated clusters - only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Available in dedicated clusters only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](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) @@ -554,25 +457,15 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/ConsumerGroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags/{topic_name}/partitions/{partition_id}: get: summary: Get Consumer Lag operationId: getKafkaConsumerLag - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - [![Available in dedicated clusters - only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#dedicated-cluster) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Available in dedicated clusters only](https://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540)](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: @@ -593,25 +486,17 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/ConsumerGroupId' - - $ref: '#/components/parameters/TopicName' - - $ref: '#/components/parameters/PartitionId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/PartitionId' /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_id}: get: summary: Get Consumer operationId: getKafkaConsumer - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the consumer specified by the ``consumer_id``. tags: @@ -632,24 +517,16 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/ConsumerGroupId' - - $ref: '#/components/parameters/ConsumerId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + - $ref: '#/components/parameters/ConsumerId' /kafka/v3/clusters/{cluster_id}/topics: get: summary: List Topics operationId: listKafkaTopics - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the list of topics that belong to the specified Kafka cluster. tags: @@ -670,24 +547,18 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' post: summary: Create Topic operationId: createKafkaTopic - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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: @@ -710,22 +581,14 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' + parameters: + - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/topics/{topic_name}: get: summary: Get Topic operationId: getKafkaTopic - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the topic with the given `topic_name`. tags: @@ -735,6 +598,8 @@ paths: - external-access-token: [] parameters: - $ref: '#/components/parameters/IncludeAuthorizedOperations' + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' responses: '200': $ref: '#/components/responses/GetTopicResponse' @@ -753,15 +618,11 @@ paths: patch: summary: Update Partition Count operationId: updatePartitionCountKafkaTopic - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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: @@ -776,8 +637,7 @@ paths: '200': $ref: '#/components/responses/GetTopicResponse' '400': - $ref: >- - #/components/responses/BadRequestErrorResponse_UpdatePartitionCountTopic + $ref: '#/components/responses/BadRequestErrorResponse_UpdatePartitionCountTopic' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': @@ -786,13 +646,14 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' delete: summary: Delete Topic operationId: deleteKafkaTopic - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Delete the topic with the given `topic_name`. tags: @@ -815,26 +676,17 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/TopicName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs: get: summary: List Topic Configs operationId: listKafkaTopicConfigs - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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: @@ -855,31 +707,19 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/TopicName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs:alter: post: summary: Batch Alter Topic Configs operationId: updateKafkaTopicConfigBatch - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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: @@ -902,23 +742,15 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/TopicName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name}: get: summary: Get Topic Config operationId: getKafkaTopicConfig - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the configuration parameter with the given `name`. tags: @@ -941,18 +773,18 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/ConfigName' put: summary: Update Topic Config operationId: updateKafkaTopicConfig - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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) @@ -976,16 +808,17 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/ConfigName' delete: summary: Reset Topic Config operationId: deleteKafkaTopicConfig - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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: @@ -1006,24 +839,16 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/TopicName' - - $ref: '#/components/parameters/ConfigName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/ConfigName' /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions: get: summary: List Partitions operationId: listKafkaPartitions - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the list of partitions that belong to the specified topic. tags: @@ -1046,23 +871,15 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/TopicName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}: get: summary: Get Partition operationId: getKafkaPartition - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Return the partition with the given `partition_id`. tags: @@ -1085,28 +902,18 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/TopicName' - - $ref: '#/components/parameters/PartitionId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/PartitionId' /kafka/v3/clusters/{cluster_id}/topics/-/configs: get: summary: List All Topic Configs operationId: listKafkaAllTopicConfigs - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - - - Return the list of configuration parameters for all topics hosted by the - specified + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + Return the list of configuration parameters for all topics hosted by the specified cluster. tags: - Configs (v3) @@ -1126,52 +933,30 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' + parameters: + - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/records: post: summary: Produce Records operationId: produceRecord - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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) @@ -1201,26 +986,17 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/TopicName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' /kafka/v3/clusters/{cluster_id}/links: get: summary: List all cluster links in the dest cluster operationId: listKafkaLinks - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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: @@ -1237,16 +1013,15 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' post: summary: Create a cluster link operationId: createKafkaLink - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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) @@ -1257,6 +1032,7 @@ paths: - $ref: '#/components/parameters/QueryParamLinkName' - $ref: '#/components/parameters/ValidateOnly' - $ref: '#/components/parameters/ValidateLink' + - $ref: '#/components/parameters/ClusterId' requestBody: $ref: '#/components/requestBodies/CreateLinkRequest' responses: @@ -1270,29 +1046,20 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/links/{link_name}: get: summary: Describe the cluster link operationId: getKafkaLink - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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: - $ref: '#/components/parameters/IncludeTasks' + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' security: - resource-api-key: [] - external-access-token: [] @@ -1310,9 +1077,7 @@ paths: delete: summary: Delete the cluster link operationId: deleteKafkaLink - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' tags: - Cluster Linking (v3) security: @@ -1321,6 +1086,8 @@ paths: parameters: - $ref: '#/components/parameters/Force' - $ref: '#/components/parameters/ValidateOnly' + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' responses: '200': $ref: '#/components/responses/NoContentResponse' @@ -1332,26 +1099,14 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/default-configs: get: summary: List New Topic Default Configs operationId: listKafkaDefaultTopicConfigs - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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: @@ -1370,22 +1125,14 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/TopicName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs: get: summary: List all configs of the cluster link operationId: listKafkaLinkConfigs - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' tags: - Cluster Linking (v3) security: @@ -1402,22 +1149,14 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name}: get: summary: Describe the config under the cluster link operationId: getKafkaLinkConfigs - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' tags: - Cluster Linking (v3) security: @@ -1434,12 +1173,14 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/LinkConfigName' put: summary: Alter the config under the cluster link operationId: updateKafkaLinkConfig - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' tags: - Cluster Linking (v3) security: @@ -1458,12 +1199,14 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/LinkConfigName' delete: summary: Reset the given config to default value operationId: deleteKafkaLinkConfig - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' tags: - Cluster Linking (v3) security: @@ -1480,22 +1223,14 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' - - $ref: '#/components/parameters/LinkConfigName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/LinkConfigName' /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs:alter: put: - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Batch Alter Cluster Link Configs operationId: updateKafkaLinkConfigBatch @@ -1506,6 +1241,8 @@ paths: - external-access-token: [] parameters: - $ref: '#/components/parameters/ValidateOnly' + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' requestBody: $ref: '#/components/requestBodies/AlterLinkConfigBatchRequest' responses: @@ -1520,26 +1257,14 @@ paths: 5XX: $ref: '#/components/responses/ServerErrorResponse' summary: Batch Alter Cluster Link Configs - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors: post: summary: Create a mirror topic operationId: createKafkaMirrorTopic - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Create a topic in the destination cluster mirroring a topic in - the source cluster tags: - Cluster Linking (v3) @@ -1559,13 +1284,14 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' get: summary: List mirror topics operationId: listKafkaMirrorTopicsUnderLink - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) List all mirror topics under the link tags: @@ -1575,6 +1301,8 @@ paths: - external-access-token: [] parameters: - $ref: '#/components/parameters/MirrorTopicStatus' + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' responses: '200': $ref: '#/components/responses/ListMirrorTopicsResponse' @@ -1586,23 +1314,12 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' /kafka/v3/clusters/{cluster_id}/links/-/mirrors: get: summary: List mirror topics operationId: listKafkaMirrorTopics - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) List all mirror topics in the cluster tags: @@ -1612,6 +1329,7 @@ paths: - external-access-token: [] parameters: - $ref: '#/components/parameters/MirrorTopicStatus' + - $ref: '#/components/parameters/ClusterId' responses: '200': $ref: '#/components/responses/ListMirrorTopicsResponse' @@ -1623,25 +1341,18 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors/{mirror_topic_name}: get: summary: Describe the mirror topic operationId: readKafkaMirrorTopic - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' tags: - Cluster Linking (v3) parameters: - $ref: '#/components/parameters/IncludeStateTransitionErrors' + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/MirrorTopicName' security: - resource-api-key: [] - external-access-token: [] @@ -1656,23 +1367,11 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' - - $ref: '#/components/parameters/MirrorTopicName' /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:promote: post: summary: Promote the mirror topics operationId: updateKafkaMirrorTopicsPromote - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' tags: - Cluster Linking (v3) security: @@ -1691,23 +1390,15 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' - - $ref: '#/components/parameters/ValidateOnly' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:failover: post: summary: Failover the mirror topics operationId: updateKafkaMirrorTopicsFailover - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' tags: - Cluster Linking (v3) security: @@ -1726,23 +1417,15 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' - - $ref: '#/components/parameters/ValidateOnly' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:pause: post: summary: Pause the mirror topics operationId: updateKafkaMirrorTopicsPause - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' tags: - Cluster Linking (v3) security: @@ -1761,23 +1444,15 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' - - $ref: '#/components/parameters/ValidateOnly' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:resume: post: summary: Resume the mirror topics operationId: updateKafkaMirrorTopicsResume - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' tags: - Cluster Linking (v3) security: @@ -1796,23 +1471,15 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' - - $ref: '#/components/parameters/ValidateOnly' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-start-mirror: post: summary: Reverse the local mirror topic and start the remote mirror topic operationId: updateKafkaMirrorTopicsReverseAndStartMirror - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' tags: - Cluster Linking (v3) security: @@ -1831,23 +1498,15 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' - - $ref: '#/components/parameters/ValidateOnly' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-pause-mirror: post: summary: Reverse the local mirror topic and Pause the remote mirror topic operationId: updateKafkaMirrorTopicsReverseAndPauseMirror - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' tags: - Cluster Linking (v3) security: @@ -1866,26 +1525,15 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' - - $ref: '#/components/parameters/ValidateOnly' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $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: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) + description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)' tags: - Cluster Linking (v3) security: @@ -1904,28 +1552,19 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' - - $ref: '#/components/parameters/IncludePartitionLevelTruncationData' - - $ref: '#/components/parameters/ValidateOnly' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/IncludePartitionLevelTruncationData' + - $ref: '#/components/parameters/ValidateOnly' /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs: get: summary: List all configs of the group operationId: listKafkaGroupConfigs - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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: @@ -1944,26 +1583,17 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name}: get: summary: Get group config operationId: getKafkaGroupConfig - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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: @@ -1982,17 +1612,17 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConfigName' put: summary: Update group config operationId: updateKafkaGroupConfig - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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: @@ -2013,18 +1643,17 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConfigName' delete: summary: Delete group config operationId: deleteKafkaGroupConfig - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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: @@ -2043,27 +1672,18 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/ConfigName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConfigName' /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs:alter: post: summary: Batch Alter Group Configs operationId: updateKafkaGroupConfigBatch - description: >- - [![Generally - Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) - + description: |- + [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#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: @@ -2071,6 +1691,8 @@ paths: - external-access-token: [] parameters: - $ref: '#/components/parameters/ValidateOnly' + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' requestBody: $ref: '#/components/requestBodies/AlterGroupConfigBatchRequest' responses: @@ -2086,15 +1708,6 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' components: schemas: UpdatePartitionCountRequestData: @@ -2147,36 +1760,23 @@ 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. @@ -2842,11 +2442,7 @@ 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: @@ -3507,114 +3103,75 @@ 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: @@ -3626,18 +3183,14 @@ 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" @@ -3650,13 +3203,11 @@ 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- @@ -3667,8 +3218,7 @@ 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 @@ -3694,8 +3244,7 @@ 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- @@ -3706,8 +3255,7 @@ 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 @@ -3717,18 +3265,14 @@ 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 @@ -3741,14 +3285,12 @@ 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 @@ -3767,8 +3309,7 @@ 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 @@ -3794,8 +3335,7 @@ 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 @@ -3821,14 +3361,12 @@ 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 @@ -3838,18 +3376,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 - 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 @@ -3859,18 +3393,14 @@ 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 @@ -3880,14 +3410,11 @@ 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: @@ -3897,8 +3424,7 @@ 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 @@ -3908,14 +3434,11 @@ 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: @@ -3925,52 +3448,42 @@ 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: @@ -3980,10 +3493,8 @@ 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 @@ -3994,11 +3505,9 @@ 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: @@ -4008,16 +3517,13 @@ 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 @@ -4030,10 +3536,8 @@ 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 @@ -4046,10 +3550,8 @@ 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 @@ -4069,10 +3571,8 @@ 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 @@ -4092,18 +3592,15 @@ 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: @@ -4113,14 +3610,12 @@ 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 @@ -4128,18 +3623,14 @@ 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 @@ -4147,18 +3638,14 @@ 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 @@ -4166,14 +3653,11 @@ 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: @@ -4183,8 +3667,7 @@ 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 @@ -4192,34 +3675,25 @@ 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.' @@ -4232,8 +3706,7 @@ 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 @@ -4241,19 +3714,13 @@ 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: @@ -4275,18 +3742,14 @@ 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. @@ -4299,14 +3762,12 @@ 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 @@ -4325,8 +3786,7 @@ 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 @@ -4352,8 +3812,7 @@ 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 @@ -4379,61 +3838,48 @@ 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: @@ -4443,29 +3889,21 @@ 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: @@ -4488,71 +3926,48 @@ 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: @@ -4572,14 +3987,12 @@ 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 @@ -4591,8 +4004,7 @@ 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 @@ -4606,8 +4018,7 @@ 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 @@ -4629,8 +4040,7 @@ 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 @@ -4644,8 +4054,7 @@ 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 @@ -4661,14 +4070,12 @@ 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 @@ -4682,8 +4089,7 @@ 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 @@ -4704,8 +4110,7 @@ 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 @@ -4726,15 +4131,13 @@ 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 @@ -4755,8 +4158,7 @@ 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 @@ -4784,8 +4186,7 @@ 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 @@ -4812,14 +4213,12 @@ 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 @@ -4847,14 +4246,11 @@ 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 @@ -4885,16 +4281,13 @@ 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 @@ -4912,10 +4305,8 @@ 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 @@ -4937,10 +4328,8 @@ 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 @@ -5103,9 +4492,7 @@ 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: @@ -5113,10 +4500,7 @@ 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: @@ -5156,9 +4540,7 @@ 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: @@ -5174,9 +4556,7 @@ 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: @@ -5184,9 +4564,7 @@ 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: @@ -5258,12 +4636,7 @@ 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: @@ -5316,10 +4689,7 @@ 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: @@ -5376,10 +4746,7 @@ 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: @@ -5394,19 +4761,13 @@ 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: @@ -5434,10 +4795,7 @@ 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: @@ -5455,10 +4813,7 @@ 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: @@ -5479,12 +4834,7 @@ 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: @@ -5557,8 +4907,7 @@ 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: [] @@ -5624,15 +4973,13 @@ 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' @@ -5641,34 +4988,27 @@ 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 name: consumer_groups @@ -5683,17 +5023,14 @@ 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: [] @@ -5705,25 +5042,21 @@ components: 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: [] @@ -5735,15 +5068,13 @@ components: 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: [] @@ -5755,25 +5086,21 @@ components: 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: [] @@ -5801,8 +5128,7 @@ 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' @@ -5811,15 +5137,13 @@ 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' @@ -5830,8 +5154,7 @@ 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: [] @@ -5842,8 +5165,7 @@ components: 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' @@ -5853,15 +5175,13 @@ 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' @@ -5870,44 +5190,35 @@ 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 name: topic_partitions @@ -5915,25 +5226,21 @@ components: 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: [] @@ -5948,8 +5255,7 @@ 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' @@ -5983,31 +5289,25 @@ 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 @@ -6016,16 +5316,14 @@ components: 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: [] @@ -6037,16 +5335,14 @@ components: 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' @@ -6055,15 +5351,13 @@ 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' @@ -6072,27 +5366,21 @@ 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 name: mirror_topics @@ -6103,15 +5391,13 @@ 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' @@ -6125,8 +5411,7 @@ 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' @@ -6135,8 +5420,7 @@ 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' @@ -6145,8 +5429,7 @@ 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' @@ -6155,8 +5438,7 @@ 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' @@ -6165,8 +5447,7 @@ 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' @@ -6175,8 +5456,7 @@ 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' @@ -6185,8 +5465,7 @@ 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' @@ -6195,22 +5474,17 @@ 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: [] @@ -6221,16 +5495,14 @@ components: 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' @@ -6239,15 +5511,13 @@ 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' @@ -6256,24 +5526,29 @@ 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://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/provider-dev/openapi/src/confluent/v00.00.00000/services/managed_kafka_clusters.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/managed_kafka_clusters.yaml index 8dd67ab..059dc61 100644 --- a/provider-dev/openapi/src/confluent/v00.00.00000/services/managed_kafka_clusters.yaml +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/managed_kafka_clusters.yaml @@ -2978,5 +2978,132 @@ components: - $ref: >- #/components/x-stackQL-resources/clusters/methods/delete_cmk_v2_cluster replace: [] + vw_clusters: + name: vw_clusters + id: confluent.managed_kafka_clusters.vw_clusters + config: + docs: + fields: + - name: environment + type: string + description: >- + Environment ID used to scope the cluster list (required `WHERE` + parameter; echoed back as a column). + - name: id + type: string + description: Cluster ID (e.g. lkc-50r5wn). + - name: kind + type: string + description: Object kind (always `Cluster`). + - name: api_version + type: string + description: Confluent API version (e.g. `cmk/v2`). + - name: display_name + type: string + description: Human-readable cluster name. + - name: availability + type: string + description: Cluster availability tier (e.g. LOW, HIGH). + - name: cloud + type: string + description: Cloud provider (AWS, GCP, AZURE). + - name: region + type: string + description: Cloud region the cluster runs in. + - name: config_kind + type: string + description: >- + Cluster sizing kind (Basic, Standard, Enterprise, Dedicated, + Freight). + - name: max_ecku + type: integer + description: Maximum eCKU count for elastic clusters. + - name: api_endpoint + type: string + description: Cluster REST API endpoint URL. + - name: http_endpoint + type: string + description: Cluster HTTP endpoint URL. + - name: kafka_bootstrap_endpoint + type: string + description: Kafka bootstrap endpoint URL (SASL_SSL://...). + - name: environment_id + type: string + description: ID of the environment that owns this cluster. + - name: environment_resource_name + type: string + description: Confluent Resource Name (CRN) of the owning environment. + - name: phase + type: string + description: Cluster lifecycle phase (e.g. PROVISIONED). + - name: created_at + type: string + description: Timestamp when the cluster was created (ISO 8601). + - name: updated_at + type: string + description: Timestamp when the cluster was last updated (ISO 8601). + - name: resource_name + type: string + description: Confluent Resource Name (CRN) for this cluster. + - name: self + type: string + description: Self-link URL for this cluster. + requiredParams: + - name: environment + type: string + description: Environment ID used to scope the cluster list. + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + id, + kind, + api_version, + environment, + JSON_EXTRACT(spec, '$.display_name') AS display_name, + JSON_EXTRACT(spec, '$.availability') AS availability, + JSON_EXTRACT(spec, '$.cloud') AS cloud, + JSON_EXTRACT(spec, '$.region') AS region, + JSON_EXTRACT(spec, '$.config.kind') AS config_kind, + JSON_EXTRACT(spec, '$.config.max_ecku') AS max_ecku, + JSON_EXTRACT(spec, '$.api_endpoint') AS api_endpoint, + JSON_EXTRACT(spec, '$.http_endpoint') AS http_endpoint, + JSON_EXTRACT(spec, '$.kafka_bootstrap_endpoint') AS kafka_bootstrap_endpoint, + JSON_EXTRACT(spec, '$.environment.id') AS environment_id, + JSON_EXTRACT(spec, '$.environment.resource_name') AS environment_resource_name, + JSON_EXTRACT(status, '$.phase') AS phase, + JSON_EXTRACT(metadata, '$.created_at') AS created_at, + JSON_EXTRACT(metadata, '$.updated_at') AS updated_at, + JSON_EXTRACT(metadata, '$.resource_name') AS resource_name, + JSON_EXTRACT(metadata, '$.self') AS self + FROM confluent.managed_kafka_clusters.clusters + WHERE environment = '{{ environment }}' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + id, + kind, + api_version, + environment, + spec->>'display_name' AS display_name, + spec->>'availability' AS availability, + spec->>'cloud' AS cloud, + spec->>'region' AS region, + spec->'config'->>'kind' AS config_kind, + (spec->'config'->>'max_ecku')::integer AS max_ecku, + spec->>'api_endpoint' AS api_endpoint, + spec->>'http_endpoint' AS http_endpoint, + spec->>'kafka_bootstrap_endpoint' AS kafka_bootstrap_endpoint, + spec->'environment'->>'id' AS environment_id, + spec->'environment'->>'resource_name' AS environment_resource_name, + status->>'phase' AS phase, + metadata->>'created_at' AS created_at, + metadata->>'updated_at' AS updated_at, + metadata->>'resource_name' AS resource_name, + metadata->>'self' AS self + FROM confluent.managed_kafka_clusters.clusters + WHERE environment = '{{ environment }}' servers: - url: https://api.confluent.cloud diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/schema_registry.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/schema_registry.yaml index 56ea0cb..4c1c110 100644 --- a/provider-dev/openapi/src/confluent/v00.00.00000/services/schema_registry.yaml +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/schema_registry.yaml @@ -37,9 +37,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /compatibility/subjects/{subject}/versions/{version}: post: tags: @@ -164,9 +161,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /compatibility/subjects/{subject}/versions: post: tags: @@ -263,9 +257,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /config/{subject}: get: tags: @@ -516,9 +507,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /config: get: tags: @@ -720,9 +708,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /exporters: get: tags: @@ -736,10 +721,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - type: string - example: '["exporter1", "exporter2"]' + $ref: '#/components/schemas/ListExportersResponse' '400': $ref: '#/components/responses/schemaregistry.v1.BadRequestError' '401': @@ -810,9 +792,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /exporters/{name}: get: tags: @@ -946,9 +925,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /exporters/{name}/status: get: tags: @@ -989,9 +965,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /exporters/{name}/config: get: tags: @@ -1092,9 +1065,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /exporters/{name}/pause: put: tags: @@ -1143,9 +1113,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /exporters/{name}/reset: put: tags: @@ -1192,9 +1159,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /exporters/{name}/resume: put: tags: @@ -1241,9 +1205,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /contexts: get: tags: @@ -1272,10 +1233,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - type: string - example: . + $ref: '#/components/schemas/ListContextsResponse' application/vnd.schemaregistry+json; qs=0.9: schema: type: array @@ -1313,9 +1271,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /mode/{subject}: get: tags: @@ -1542,9 +1497,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /mode: get: tags: @@ -1664,9 +1616,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /schemas/ids/{id}: get: tags: @@ -1747,9 +1696,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /schemas/ids/{id}/schema: get: tags: @@ -1833,9 +1779,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /schemas/types: get: tags: @@ -1849,10 +1792,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - type: string - example: AVRO + $ref: '#/components/schemas/GetSchemaTypesResponse' application/vnd.schemaregistry+json; qs=0.9: schema: type: array @@ -1890,9 +1830,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /schemas: get: tags: @@ -1953,9 +1890,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - $ref: '#/components/schemas/Schema' + $ref: '#/components/schemas/GetSchemasResponse' application/vnd.schemaregistry+json; qs=0.9: schema: type: array @@ -1991,9 +1926,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /schemas/ids/{id}/subjects: get: tags: @@ -2049,10 +1981,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - type: string - example: User + $ref: '#/components/schemas/GetSubjectsResponse' application/vnd.schemaregistry+json; qs=0.9: schema: type: array @@ -2102,9 +2031,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /schemas/ids/{id}/versions: get: tags: @@ -2150,9 +2076,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - $ref: '#/components/schemas/SubjectVersion' + $ref: '#/components/schemas/GetVersionsResponse' application/vnd.schemaregistry+json; qs=0.9: schema: type: array @@ -2200,9 +2124,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /subjects/{subject}/versions/{version}: get: tags: @@ -2415,9 +2336,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /subjects/{subject}/versions/{version}/referencedby: get: tags: @@ -2463,11 +2381,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - type: integer - format: int32 - example: 100001 + $ref: '#/components/schemas/GetReferencedByResponse' application/vnd.schemaregistry+json; qs=0.9: schema: type: array @@ -2533,9 +2447,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /subjects/{subject}/versions/{version}/schema: get: tags: @@ -2635,9 +2546,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /subjects/{subject}/versions: get: tags: @@ -2682,11 +2590,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - type: integer - format: int32 - example: 1 + $ref: '#/components/schemas/ListVersionsResponse' application/vnd.schemaregistry+json; qs=0.9: schema: type: array @@ -2868,9 +2772,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /subjects/{subject}: post: tags: @@ -3001,11 +2902,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - type: integer - format: int32 - example: 1 + $ref: '#/components/schemas/DeleteSubjectResponse' application/vnd.schemaregistry+json; qs=0.9: schema: type: array @@ -3057,9 +2954,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /subjects: get: tags: @@ -3104,10 +2998,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - type: string - example: User + $ref: '#/components/schemas/ListResponse' application/vnd.schemaregistry+json; qs=0.9: schema: type: array @@ -3145,9 +3036,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /subjects/{subject}/metadata: get: tags: @@ -3217,9 +3105,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. components: schemas: ClusterConfig: @@ -3832,6 +3717,100 @@ components: enum: - sr_record - sr_field + ListExportersResponse: + type: object + properties: + exporters: + type: array + items: + type: object + properties: + exporter: + type: string + ListContextsResponse: + type: object + properties: + contexts: + type: array + items: + type: object + properties: + context: + type: string + GetSchemaTypesResponse: + type: object + properties: + schema_types: + type: array + items: + type: object + properties: + schema_type: + type: string + GetSchemasResponse: + type: object + properties: + schemas: + type: array + items: + $ref: '#/components/schemas/Schema' + GetSubjectsResponse: + type: object + properties: + subjects: + type: array + items: + type: object + properties: + subject: + type: string + GetVersionsResponse: + type: object + properties: + versions: + type: array + items: + $ref: '#/components/schemas/SubjectVersion' + GetReferencedByResponse: + type: object + properties: + referenced_by: + type: array + items: + type: object + properties: + referenced_by: + type: integer + ListVersionsResponse: + type: object + properties: + versions: + type: array + items: + type: object + properties: + version: + type: integer + DeleteSubjectResponse: + type: object + properties: + delete_subject: + type: array + items: + type: object + properties: + delete_subject: + type: integer + ListResponse: + type: object + properties: + items: + type: array + items: + type: object + properties: + item: + type: string responses: schemaregistry.v1.BadRequestError: description: Bad Request @@ -4048,7 +4027,21 @@ components: response: mediaType: application/vnd.schemaregistry.v1+json openAPIDocKey: '200' - objectKey: $ + objectKey: $.exporters + overrideMediaType: application/vnd.schemaregistry.v1+json + schema_override: + $ref: '#/components/schemas/ListExportersResponse' + transform: + body: >- + {{- $wrapped := printf "{\"items\":%s}" . -}} + + {{- $parsed := jsonMapFromString $wrapped -}} + + {{- $items := index $parsed "items" -}} + + {"exporters":[{{- range $i, $v := $items -}}{{- if $i -}},{{- + end -}}{"exporter":"{{- $v -}}"}{{- end -}}]} + type: golang_template_text_v0.3.0 register_exporter: config: requestBodyTranslate: @@ -4171,7 +4164,21 @@ components: response: mediaType: application/vnd.schemaregistry.v1+json openAPIDocKey: '200' - objectKey: $ + objectKey: $.contexts + overrideMediaType: application/vnd.schemaregistry.v1+json + schema_override: + $ref: '#/components/schemas/ListContextsResponse' + transform: + body: >- + {{- $wrapped := printf "{\"items\":%s}" . -}} + + {{- $parsed := jsonMapFromString $wrapped -}} + + {{- $items := index $parsed "items" -}} + + {"contexts":[{{- range $i, $v := $items -}}{{- if $i -}},{{- end + -}}{"context":"{{- $v -}}"}{{- end -}}]} + type: golang_template_text_v0.3.0 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/contexts/methods/list_contexts' @@ -4255,7 +4262,15 @@ components: response: mediaType: application/vnd.schemaregistry.v1+json openAPIDocKey: '200' - objectKey: $ + objectKey: $.schemas + overrideMediaType: application/vnd.schemaregistry.v1+json + schema_override: + $ref: '#/components/schemas/GetSchemasResponse' + transform: + body: |- + {{- $wrapped := printf "{\"schemas\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 get_schema_only_1: operation: $ref: '#/paths/~1subjects~1{subject}~1versions~1{version}~1schema/get' @@ -4281,7 +4296,21 @@ components: response: mediaType: application/vnd.schemaregistry.v1+json openAPIDocKey: '200' - objectKey: $ + objectKey: $.schema_types + overrideMediaType: application/vnd.schemaregistry.v1+json + schema_override: + $ref: '#/components/schemas/GetSchemaTypesResponse' + transform: + body: >- + {{- $wrapped := printf "{\"items\":%s}" . -}} + + {{- $parsed := jsonMapFromString $wrapped -}} + + {{- $items := index $parsed "items" -}} + + {"schema_types":[{{- range $i, $v := $items -}}{{- if $i -}},{{- + end -}}{"schema_type":"{{- $v -}}"}{{- end -}}]} + type: golang_template_text_v0.3.0 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/types/methods/get_schema_types' @@ -4300,7 +4329,21 @@ components: response: mediaType: application/vnd.schemaregistry.v1+json openAPIDocKey: '200' - objectKey: $ + objectKey: $.subjects + overrideMediaType: application/vnd.schemaregistry.v1+json + schema_override: + $ref: '#/components/schemas/GetSubjectsResponse' + transform: + body: >- + {{- $wrapped := printf "{\"items\":%s}" . -}} + + {{- $parsed := jsonMapFromString $wrapped -}} + + {{- $items := index $parsed "items" -}} + + {"subjects":[{{- range $i, $v := $items -}}{{- if $i -}},{{- end + -}}{"subject":"{{- $v -}}"}{{- end -}}]} + type: golang_template_text_v0.3.0 look_up_schema_under_subject: config: requestBodyTranslate: @@ -4316,13 +4359,42 @@ components: response: mediaType: application/vnd.schemaregistry.v1+json openAPIDocKey: '200' + objectKey: $.delete_subject + overrideMediaType: application/vnd.schemaregistry.v1+json + schema_override: + $ref: '#/components/schemas/DeleteSubjectResponse' + transform: + body: >- + {{- $wrapped := printf "{\"items\":%s}" . -}} + + {{- $parsed := jsonMapFromString $wrapped -}} + + {{- $items := index $parsed "items" -}} + + {"delete_subject":[{{- range $i, $v := $items -}}{{- if $i + -}},{{- end -}}{"delete_subject":"{{- $v -}}"}{{- end -}}]} + type: golang_template_text_v0.3.0 list: operation: $ref: '#/paths/~1subjects/get' response: mediaType: application/vnd.schemaregistry.v1+json openAPIDocKey: '200' - objectKey: $ + objectKey: $.items + overrideMediaType: application/vnd.schemaregistry.v1+json + schema_override: + $ref: '#/components/schemas/ListResponse' + transform: + body: >- + {{- $wrapped := printf "{\"items\":%s}" . -}} + + {{- $parsed := jsonMapFromString $wrapped -}} + + {{- $items := index $parsed "items" -}} + + {"items":[{{- range $i, $v := $items -}}{{- if $i -}},{{- end + -}}{"item":"{{- $v -}}"}{{- end -}}]} + type: golang_template_text_v0.3.0 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/subjects/methods/get_subjects' @@ -4343,7 +4415,15 @@ components: response: mediaType: application/vnd.schemaregistry.v1+json openAPIDocKey: '200' - objectKey: $ + objectKey: $.versions + overrideMediaType: application/vnd.schemaregistry.v1+json + schema_override: + $ref: '#/components/schemas/GetVersionsResponse' + transform: + body: |- + {{- $wrapped := printf "{\"versions\":%s}" . -}} + {{- $wrapped -}} + type: golang_template_text_v0.3.0 get_schema_by_version: operation: $ref: '#/paths/~1subjects~1{subject}~1versions~1{version}/get' @@ -4362,7 +4442,21 @@ components: response: mediaType: application/vnd.schemaregistry.v1+json openAPIDocKey: '200' - objectKey: $ + objectKey: $.versions + overrideMediaType: application/vnd.schemaregistry.v1+json + schema_override: + $ref: '#/components/schemas/ListVersionsResponse' + transform: + body: >- + {{- $wrapped := printf "{\"items\":%s}" . -}} + + {{- $parsed := jsonMapFromString $wrapped -}} + + {{- $items := index $parsed "items" -}} + + {"versions":[{{- range $i, $v := $items -}}{{- if $i -}},{{- end + -}}{"version":"{{- $v -}}"}{{- end -}}]} + type: golang_template_text_v0.3.0 register: config: requestBodyTranslate: @@ -4397,7 +4491,21 @@ components: response: mediaType: application/vnd.schemaregistry.v1+json openAPIDocKey: '200' - objectKey: $ + objectKey: $.referenced_by + overrideMediaType: application/vnd.schemaregistry.v1+json + schema_override: + $ref: '#/components/schemas/GetReferencedByResponse' + transform: + body: >- + {{- $wrapped := printf "{\"items\":%s}" . -}} + + {{- $parsed := jsonMapFromString $wrapped -}} + + {{- $items := index $parsed "items" -}} + + {"referenced_by":[{{- range $i, $v := $items -}}{{- if $i + -}},{{- end -}}{"referenced_by":"{{- $v -}}"}{{- end -}}]} + type: golang_template_text_v0.3.0 sqlVerbs: select: - $ref: >- diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/share_group.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/share_group.yaml index cbc4bec..9a8ea1e 100644 --- a/provider-dev/openapi/src/confluent/v00.00.00000/services/share_group.yaml +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/share_group.yaml @@ -33,14 +33,8 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' + parameters: + - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}: get: summary: Get Share Group @@ -68,6 +62,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' delete: summary: Delete Share Group operationId: deleteKafkaShareGroup @@ -97,15 +94,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers: get: summary: List Share Group Consumers @@ -135,15 +126,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}: get: summary: Get Share Group Consumer @@ -171,16 +156,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/ConsumerId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConsumerId' /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}/assignments: get: summary: List Share Group Consumer Assignments @@ -208,16 +187,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/ConsumerId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConsumerId' components: schemas: ShareGroupDataList: diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/sql.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/sql.yaml index 78dba70..eb680fc 100644 --- a/provider-dev/openapi/src/confluent/v00.00.00000/services/sql.yaml +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/sql.yaml @@ -391,9 +391,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint x-lifecycle-stage: Preview x-self-access: true x-request-access-name: SQL API v1 @@ -802,9 +799,6 @@ paths: - spec - name - metadata - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint x-lifecycle-stage: Preview x-self-access: true x-request-access-name: SQL API v1 @@ -1004,9 +998,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint x-lifecycle-stage: General Availability x-self-access: true x-request-access-name: SQL API v1 @@ -1396,9 +1387,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint x-lifecycle-stage: General Availability x-self-access: true x-request-access-name: SQL API v1 @@ -1996,9 +1984,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint x-lifecycle-stage: General Availability x-self-access: true x-request-access-name: SQL API v1 @@ -2064,9 +2049,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint x-lifecycle-stage: General Availability x-self-access: true x-request-access-name: SQL API v1 @@ -2142,9 +2124,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables: post: x-lifecycle-stage: General Availability @@ -2564,9 +2543,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}: get: x-lifecycle-stage: General Availability @@ -2942,9 +2918,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}/versions: get: x-lifecycle-stage: General Availability @@ -3030,9 +3003,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}/versions/{version}: get: x-lifecycle-stage: General Availability @@ -3109,9 +3079,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint /sql/v1/organizations/{organization_id}/environments/{environment_id}/agents: get: x-lifecycle-stage: Preview @@ -3183,9 +3150,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents: post: x-lifecycle-stage: Preview @@ -3514,9 +3478,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents/{agent_name}: get: x-lifecycle-stage: Preview @@ -3845,9 +3806,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools: post: x-lifecycle-stage: Preview @@ -4202,9 +4160,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint x-lifecycle-stage: Preview x-self-access: true x-request-access-name: SQL API v1 @@ -4441,9 +4396,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint x-lifecycle-stage: Preview x-self-access: true x-request-access-name: SQL API v1 diff --git a/provider-dev/openapi/src/confluent/v00.00.00000/services/streams_group.yaml b/provider-dev/openapi/src/confluent/v00.00.00000/services/streams_group.yaml index fee4f30..4e64006 100644 --- a/provider-dev/openapi/src/confluent/v00.00.00000/services/streams_group.yaml +++ b/provider-dev/openapi/src/confluent/v00.00.00000/services/streams_group.yaml @@ -32,14 +32,8 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' + parameters: + - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}: get: summary: Get Streams Group @@ -67,15 +61,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/subtopologies: get: summary: List Streams Group Subtopologies @@ -104,15 +92,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/subtopologies/{subtopology_id}: get: summary: Get Streams Group Subtopology @@ -140,16 +122,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/SubtopologyId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/SubtopologyId' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members: get: summary: List Streams Group Members @@ -177,15 +153,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}: get: summary: Get Streams Group Member @@ -213,16 +183,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/MemberId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments: get: summary: Get Streams Group Member Assignments @@ -250,16 +214,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/MemberId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments: get: summary: Get Streams Group Member Target Assignments @@ -288,16 +246,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/MemberId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments/{assignments_type}: get: summary: List Streams Group Assignments of a Specific Type @@ -326,17 +278,11 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/MemberId' - - $ref: '#/components/parameters/AssignmentsType' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments/{assignments_type}: get: summary: List Streams Group Target Assignments of a Specific Type @@ -365,17 +311,11 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/MemberId' - - $ref: '#/components/parameters/AssignmentsType' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments/{assignments_type}/subtopologies/{subtopology_id}: get: summary: >- @@ -406,18 +346,12 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/MemberId' - - $ref: '#/components/parameters/AssignmentsType' - - $ref: '#/components/parameters/SubtopologyId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' + - $ref: '#/components/parameters/SubtopologyId' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments/{assignments_type}/subtopologies/{subtopology_id}: get: summary: >- @@ -448,18 +382,12 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: >- - Confluent Cloud REST Endpoint. For example - https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/MemberId' - - $ref: '#/components/parameters/AssignmentsType' - - $ref: '#/components/parameters/SubtopologyId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' + - $ref: '#/components/parameters/SubtopologyId' components: schemas: StreamsGroupDataList: diff --git a/provider-dev/scripts/confluent-svc.mjs b/provider-dev/scripts/confluent-svc.mjs new file mode 100644 index 0000000..75f06a2 --- /dev/null +++ b/provider-dev/scripts/confluent-svc.mjs @@ -0,0 +1,15 @@ +// confluent-svc.mjs +export default function confluentSvc(path, operationId, tags) { + const tag = tags && tags[0]; + if (!tag) return null; + + // "API Keys (iam/v2)" -> "iam" + // "Schemas (v1)" -> "schemas" + const m = tag.match(/\(([^)]+)\)\s*$/); + if (m) { + const inside = m[1]; + const slash = inside.indexOf('/'); + return slash >= 0 ? inside.slice(0, slash) : tag.replace(/\s*\([^)]*\)\s*$/, ''); + } + return tag; +} \ No newline at end of file diff --git a/provider-dev/scripts/replace_kafka_servers.mjs b/provider-dev/scripts/replace_kafka_servers.mjs new file mode 100644 index 0000000..1e28ecd --- /dev/null +++ b/provider-dev/scripts/replace_kafka_servers.mjs @@ -0,0 +1,92 @@ +#!/usr/bin/env node +// Replace the root `servers:` block in the generated kafka service spec with a +// templated URL that resolves per-cluster from values supplied in WHERE clauses. +// +// Why this exists: Confluent's Kafka REST v3 surface (`/kafka/v3/...`) is a +// per-cluster dataplane. Each Kafka cluster lives at its own host +// (`https://...confluent.cloud`) — there's +// no single static base URL. The OpenAPI spec ships a placeholder +// `pkc-00000.region.provider.confluent.cloud` that is not a real host, so +// requests fail DNS as soon as the user runs a query. +// +// StackQL supports OpenAPI 3 server variables and binds them from the WHERE +// clause when: +// 1. the server URL has a static scheme prefix (so the full URL is +// parseable before substitution — `{rest_endpoint}` alone fails the +// path mux's "must start with /" check), AND +// 2. each variable is declared with a `default` and `description` under +// `servers[0].variables`. +// +// We use three variables so users can paste each piece directly out of the +// Confluent UI (or pull them from confluent.managed_kafka_clusters.clusters): +// kafka_endpoint_id (the pkc-* prefix in the cluster's REST endpoint) +// region (cluster spec.region, e.g. ap-southeast-2) +// cloud_provider (cluster spec.cloud lower-cased: aws|gcp|azure) +// +// Run AFTER `npm run generate-provider`, BEFORE the test step. Idempotent — +// re-runs are no-ops once the templated servers are in place. +// +// Note: this is a Confluent-specific exception. Do NOT generalise into +// stackql-provider-utils — Confluent's per-cluster dataplane shape is +// unusual; most providers have a single base URL. +// +// Usage: +// node provider-dev/scripts/replace_kafka_servers.mjs +// node provider-dev/scripts/replace_kafka_servers.mjs --dry-run + +import fs from 'node:fs'; +import yaml from 'js-yaml'; + +const args = process.argv.slice(2); +const DRY = args.includes('--dry-run'); +const TARGET = (() => { const i = args.indexOf('--target'); return i !== -1 ? args[i + 1] : 'provider-dev/openapi/src/confluent/v00.00.00000/services/kafka.yaml'; })(); + +const TEMPLATED_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).', + }, + 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).', + }, + }, + }, +]; + +if (!fs.existsSync(TARGET)) { + console.error(`[replace-kafka-servers] target not found: ${TARGET}`); + console.error('Run `npm run generate-provider` first.'); + process.exit(1); +} + +const before = fs.readFileSync(TARGET, 'utf8'); +const doc = yaml.load(before); + +// Idempotency: if doc.servers already matches the templated shape (deep-equal +// after canonical YAML serialisation), exit clean. +const expected = yaml.dump(TEMPLATED_SERVERS, { sortKeys: true }); +const actual = yaml.dump(doc.servers, { sortKeys: true }); +if (actual === expected) { + console.log(`[replace-kafka-servers] already in sync: ${TARGET}`); + process.exit(0); +} + +doc.servers = TEMPLATED_SERVERS; +const after = yaml.dump(doc, { noRefs: true, sortKeys: false, lineWidth: -1 }); + +if (DRY) { + console.log(`[dry] would replace servers in ${TARGET}`); + console.log('new servers:'); + console.log(yaml.dump(TEMPLATED_SERVERS)); +} else { + fs.writeFileSync(TARGET, after); + console.log(`replaced servers in ${TARGET}`); +} diff --git a/provider-dev/source/catalog.yaml b/provider-dev/source/catalog.yaml index e2fda0c..bbb06ee 100644 --- a/provider-dev/source/catalog.yaml +++ b/provider-dev/source/catalog.yaml @@ -28,9 +28,7 @@ paths: content: application/json: schema: - items: - $ref: '#/components/schemas/BusinessMetadataDefResponse' - type: array + $ref: '#/components/schemas/GetAllBusinessMetadataDefsResponse' description: The business metadata definitions '400': description: Bad Request @@ -38,6 +36,11 @@ paths: description: Rate Limit Error '500': description: Internal Server Error + x-stackql-bare-array-wrap: + wrapperKey: business_metadata_defs + wrapperName: GetAllBusinessMetadataDefsResponse + mediaType: application/json + scalar: false post: summary: Bulk Create Business Metadata Definitions description: |- @@ -60,9 +63,7 @@ paths: content: application/json: schema: - items: - $ref: '#/components/schemas/BusinessMetadataDefResponse' - type: array + $ref: '#/components/schemas/CreateBusinessMetadataDefsResponse' description: The business metadata definitions. Errored business metadata definitions will have an additional error property. '400': description: Bad Request @@ -70,6 +71,11 @@ paths: description: Rate Limit Error '500': description: Internal Server Error + x-stackql-bare-array-wrap: + wrapperKey: create_business_metadata_defs + wrapperName: CreateBusinessMetadataDefsResponse + mediaType: application/json + scalar: false put: summary: Bulk Update Business Metadata Definitions description: |- @@ -92,9 +98,7 @@ paths: content: application/json: schema: - items: - $ref: '#/components/schemas/BusinessMetadataDefResponse' - type: array + $ref: '#/components/schemas/UpdateBusinessMetadataDefsResponse' description: The business metadata definitions. Errored business metadata definitions will have an additional error property. '400': description: Bad Request @@ -102,9 +106,11 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + x-stackql-bare-array-wrap: + wrapperKey: update_business_metadata_defs + wrapperName: UpdateBusinessMetadataDefsResponse + mediaType: application/json + scalar: false /catalog/v1/types/businessmetadatadefs/{bmName}: delete: summary: Delete Business Metadata Definition @@ -166,9 +172,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud /catalog/v1/entity/businessmetadata: post: summary: Bulk Create Business Metadata @@ -192,9 +195,7 @@ paths: content: application/json: schema: - items: - $ref: '#/components/schemas/BusinessMetadataResponse' - type: array + $ref: '#/components/schemas/CreateBusinessMetadataResponse' description: The business metadata. Errored business metadata will have an additional error property. '400': description: Bad Request @@ -202,6 +203,11 @@ paths: description: Rate Limit Error '500': description: Internal Server Error + x-stackql-bare-array-wrap: + wrapperKey: create_business_metadata + wrapperName: CreateBusinessMetadataResponse + mediaType: application/json + scalar: false put: summary: Bulk Update Business Metadata description: |- @@ -224,9 +230,7 @@ paths: content: application/json: schema: - items: - $ref: '#/components/schemas/BusinessMetadataResponse' - type: array + $ref: '#/components/schemas/UpdateBusinessMetadataResponse' description: The business metadata. Errored business metadata will have an additional error property. '400': description: Bad Request @@ -234,9 +238,11 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + x-stackql-bare-array-wrap: + wrapperKey: update_business_metadata + wrapperName: UpdateBusinessMetadataResponse + mediaType: application/json + scalar: false /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata: get: summary: Read Business Metadata for an Entity @@ -270,9 +276,7 @@ paths: content: application/json: schema: - items: - $ref: '#/components/schemas/BusinessMetadataResponse' - type: array + $ref: '#/components/schemas/GetBusinessMetadataResponse' description: The business metadata '400': description: Bad Request @@ -282,9 +286,11 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + x-stackql-bare-array-wrap: + wrapperKey: business_metadata + wrapperName: GetBusinessMetadataResponse + mediaType: application/json + scalar: false /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata/{bmName}: delete: summary: Delete a Business Metadata for an Entity @@ -329,9 +335,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud /catalog/v1/entity/tags: put: summary: Bulk Update Tags @@ -356,15 +359,18 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/TagResponse' + $ref: '#/components/schemas/UpdateTagsResponse' '400': description: Bad Request '429': description: Rate Limit Error '500': description: Internal Server Error + x-stackql-bare-array-wrap: + wrapperKey: update_tags + wrapperName: UpdateTagsResponse + mediaType: application/json + scalar: false post: summary: Bulk Create Tags description: |- @@ -388,18 +394,18 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/TagResponse' + $ref: '#/components/schemas/CreateTagsResponse' '400': description: Bad Request '429': description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + x-stackql-bare-array-wrap: + wrapperKey: create_tags + wrapperName: CreateTagsResponse + mediaType: application/json + scalar: false /catalog/v1/entity/type/{typeName}/name/{qualifiedName}: get: summary: Read an Entity @@ -450,9 +456,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags: get: summary: Read Tags for an Entity @@ -482,9 +485,7 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/TagResponse' + $ref: '#/components/schemas/GetTagsResponse' '400': description: Bad Request '404': @@ -493,9 +494,11 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + x-stackql-bare-array-wrap: + wrapperKey: tags + wrapperName: GetTagsResponse + mediaType: application/json + scalar: false /catalog/v1/entity: put: summary: Update an Entity Attribute @@ -527,9 +530,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud /catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags/{tagName}: delete: summary: Delete a Tag for an Entity @@ -568,9 +568,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud /catalog/v1/search/attribute: get: summary: Search by Attribute @@ -666,9 +663,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud /catalog/v1/search/basic: get: summary: Search by Fulltext Query @@ -751,9 +745,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud /catalog/v1/types/tagdefs: get: summary: Bulk Read Tag Definitions @@ -776,15 +767,18 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/TagDefResponse' + $ref: '#/components/schemas/GetAllTagDefsResponse' '400': description: Bad Request '429': description: Rate Limit Error '500': description: Internal Server Error + x-stackql-bare-array-wrap: + wrapperKey: tag_defs + wrapperName: GetAllTagDefsResponse + mediaType: application/json + scalar: false put: summary: Bulk Update Tag Definitions description: |- @@ -808,15 +802,18 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/TagDefResponse' + $ref: '#/components/schemas/UpdateTagDefsResponse' '400': description: Bad Request '429': description: Rate Limit Error '500': description: Internal Server Error + x-stackql-bare-array-wrap: + wrapperKey: update_tag_defs + wrapperName: UpdateTagDefsResponse + mediaType: application/json + scalar: false post: summary: Bulk Create Tag Definitions description: |- @@ -840,18 +837,18 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/TagDefResponse' + $ref: '#/components/schemas/CreateTagDefsResponse' '400': description: Bad Request '429': description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud + x-stackql-bare-array-wrap: + wrapperKey: create_tag_defs + wrapperName: CreateTagDefsResponse + mediaType: application/json + scalar: false /catalog/v1/types/tagdefs/{tagName}: get: summary: Read Tag Definition @@ -909,9 +906,6 @@ paths: description: Rate Limit Error '500': description: Internal Server Error - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud components: schemas: BusinessMetadataDefResponse: @@ -1726,6 +1720,90 @@ components: removePropagationsOnEntityDelete: type: boolean description: Whether to remove propagations on entity delete + GetAllBusinessMetadataDefsResponse: + type: object + properties: + business_metadata_defs: + type: array + items: + $ref: '#/components/schemas/BusinessMetadataDefResponse' + CreateBusinessMetadataDefsResponse: + type: object + properties: + create_business_metadata_defs: + type: array + items: + $ref: '#/components/schemas/BusinessMetadataDefResponse' + UpdateBusinessMetadataDefsResponse: + type: object + properties: + update_business_metadata_defs: + type: array + items: + $ref: '#/components/schemas/BusinessMetadataDefResponse' + CreateBusinessMetadataResponse: + type: object + properties: + create_business_metadata: + type: array + items: + $ref: '#/components/schemas/BusinessMetadataResponse' + UpdateBusinessMetadataResponse: + type: object + properties: + update_business_metadata: + type: array + items: + $ref: '#/components/schemas/BusinessMetadataResponse' + GetBusinessMetadataResponse: + type: object + properties: + business_metadata: + type: array + items: + $ref: '#/components/schemas/BusinessMetadataResponse' + UpdateTagsResponse: + type: object + properties: + update_tags: + type: array + items: + $ref: '#/components/schemas/TagResponse' + CreateTagsResponse: + type: object + properties: + create_tags: + type: array + items: + $ref: '#/components/schemas/TagResponse' + GetTagsResponse: + type: object + properties: + tags: + type: array + items: + $ref: '#/components/schemas/TagResponse' + GetAllTagDefsResponse: + type: object + properties: + tag_defs: + type: array + items: + $ref: '#/components/schemas/TagDefResponse' + UpdateTagDefsResponse: + type: object + properties: + update_tag_defs: + type: array + items: + $ref: '#/components/schemas/TagDefResponse' + CreateTagDefsResponse: + type: object + properties: + create_tag_defs: + type: array + items: + $ref: '#/components/schemas/TagDefResponse' servers: - url: https://api.confluent.cloud description: Confluent Cloud API diff --git a/provider-dev/source/connect.yaml b/provider-dev/source/connect.yaml index 316eabc..7ecb906 100644 --- a/provider-dev/source/connect.yaml +++ b/provider-dev/source/connect.yaml @@ -18,18 +18,26 @@ paths: security: - cloud-api-key: [] - confluent-sts-access-token: [] - parameters: [] + parameters: + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. responses: '200': description: Connector. content: application/json: schema: - type: array - description: List of connector names - items: - type: string - description: Connector name + $ref: '#/components/schemas/ListConnectv1ConnectorsResponse' example: - MyGcsLogsBucketConnector - MyS3BucketConnector @@ -42,6 +50,12 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + x-stackql-bare-array-wrap: + wrapperKey: connectv1_connectors + wrapperName: ListConnectv1ConnectorsResponse + mediaType: application/json + scalar: true + columnName: connectv1_connector post: x-lifecycle-stage: General Availability operationId: createConnectv1Connector @@ -245,20 +259,20 @@ paths: pos: 154 ts_sec: 1712907333 description: '' + parameters: + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors?expand=info,status,id: get: x-lifecycle-stage: General Availability @@ -504,6 +518,25 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. put: x-lifecycle-stage: General Availability operationId: createOrUpdateConnectv1ConnectorConfig @@ -645,26 +678,26 @@ paths: example: error_code: 500 message: Failed to find any class that implements Connector and which name matches io.confluent.connect.... + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}: get: x-lifecycle-stage: General Availability @@ -716,6 +749,25 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. delete: x-lifecycle-stage: General Availability operationId: deleteConnectv1Connector @@ -740,26 +792,26 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/pause: put: x-lifecycle-stage: General Availability @@ -785,26 +837,26 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/resume: put: x-lifecycle-stage: General Availability @@ -830,26 +882,26 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/restart: post: x-lifecycle-stage: Preview @@ -876,26 +928,26 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: Preview - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status: get: x-lifecycle-stage: General Availability @@ -989,26 +1041,26 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks: get: x-lifecycle-stage: General Availability @@ -1029,7 +1081,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/connect.v1.Connectors' + $ref: '#/components/schemas/ListConnectv1ConnectorTasksResponse' example: - id: connector: MyGcsLogsBucketConnector @@ -1058,26 +1110,31 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + x-stackql-bare-array-wrap: + wrapperKey: connectv1_connector_tasks + wrapperName: ListConnectv1ConnectorTasksResponse + mediaType: application/json + scalar: false x-lifecycle-stage: General Availability - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins: get: x-lifecycle-stage: General Availability @@ -1098,25 +1155,7 @@ paths: content: application/json: schema: - type: array - items: - type: object - properties: - class: - type: string - description: The connector class name. E.g. BigQuerySink. - type: - type: string - description: Type of connector, sink or source. - enum: - - sink - - source - version: - type: string - description: The version string for the connector available. - required: - - class - - type + $ref: '#/components/schemas/ListConnectv1ConnectorPluginsResponse' example: - class: BigQuerySink type: sink @@ -1139,21 +1178,25 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' - parameters: [] + parameters: + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + x-stackql-bare-array-wrap: + wrapperKey: connectv1_connector_plugins + wrapperName: ListConnectv1ConnectorPluginsResponse + mediaType: application/json + scalar: false x-lifecycle-stage: General Availability - parameters: - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/validate: put: x-lifecycle-stage: General Availability @@ -1557,26 +1600,26 @@ paths: time.interval: DAILY topics: APILogsTopic description: Configuration parameters for the connector. All values should be strings. + parameters: + - name: plugin_name + in: path + schema: + type: string + required: true + description: The unique name of the connector plugin. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: plugin_name - in: path - schema: - type: string - required: true - description: The unique name of the connector plugin. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/translate?mask_sensitive=true: put: x-lifecycle-stage: General Availability @@ -1704,33 +1747,33 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: plugin_name + in: path + schema: + type: string + required: true + description: The unique name of the connector plugin. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. + - name: mask_sensitive + in: query + required: false + schema: + type: string + maxLength: 255 + description: Indicates whether to redact sensitive config values in response. x-lifecycle-stage: General Availability - parameters: - - name: plugin_name - in: path - schema: - type: string - required: true - description: The unique name of the connector plugin. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. - - name: mask_sensitive - in: query - required: false - schema: - type: string - maxLength: 255 - description: Indicates whether to redact sensitive config values in response. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets: get: x-lifecycle-stage: General Availability @@ -1797,26 +1840,26 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request: post: x-lifecycle-stage: General Availability @@ -1901,26 +1944,26 @@ paths: delete: value: type: DELETE + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status: get: x-lifecycle-stage: General Availability @@ -2018,26 +2061,26 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/connect.v1.DefaultSystemError' + parameters: + - name: connector_name + in: path + schema: + type: string + required: true + description: The unique name of the connector. + - name: environment_id + in: path + schema: + type: string + required: true + description: The unique identifier of the environment this resource belongs to. + - name: kafka_cluster_id + in: path + schema: + type: string + required: true + description: The unique identifier for the Kafka cluster. x-lifecycle-stage: General Availability - parameters: - - name: connector_name - in: path - schema: - type: string - required: true - description: The unique name of the connector. - - name: environment_id - in: path - schema: - type: string - required: true - description: The unique identifier of the environment this resource belongs to. - - name: kafka_cluster_id - in: path - schema: - type: string - required: true - description: The unique identifier for the Kafka cluster. /connect/v1/custom-connector-plugins: get: x-lifecycle-stage: General Availability @@ -5129,6 +5172,119 @@ components: type: string nullable: true additionalProperties: false + ListConnectv1ConnectorsResponse: + type: object + properties: + connectv1_connectors: + type: array + items: + type: object + properties: + connectv1_connector: + type: string + ListConnectv1ConnectorTasksResponse: + type: object + properties: + connectv1_connector_tasks: + type: array + items: + type: object + properties: + id: + type: object + description: The ID of task. + properties: + connector: + type: string + description: The name of the connector the task belongs to. + task: + type: integer + description: Task ID within the connector. + config: + type: object + description: |- + Configuration parameters for the connector. These configurations + are the minimum set of key-value pairs (KVP) which can be used to + define how the connector connects Kafka to the external system. + Some of these KVPs are common to all the connectors, such as + connection parameters to Kafka, connector metadata, etc. The list + of common connector configurations is as follows + + - cloud.environment + - cloud.provider + - connector.class + - kafka.api.key + - kafka.api.secret + - kafka.endpoint + - kafka.region + - name + + A specific connector such as `GcsSink` would have additional + parameters such as `gcs.bucket.name`, `flush.size`, etc. + required: + - cloud.environment + - cloud.provider + - connector.class + - name + - kafka.endpoint + - kafka.region + - kafka.api.key + - kafka.api.secret + properties: + cloud.environment: + type: string + description: The cloud environment type. + cloud.provider: + type: string + description: The cloud service provider, e.g. aws, azure, etc. + x-extensible-enum: + - aws + - azure + - gcp + connector.class: + type: string + description: The connector class name. E.g. BigQuerySink, GcsSink, etc. + name: + type: string + description: Name or alias of the class (plugin) for this connector. + kafka.endpoint: + type: string + description: The kafka cluster endpoint. + kafka.region: + type: string + description: The kafka cluster region. + kafka.api.key: + type: string + description: The kafka cluster api key. + kafka.api.secret: + type: string + description: The kafka cluster api secret key. + x-redact: true + additionalProperties: + type: string + ListConnectv1ConnectorPluginsResponse: + type: object + properties: + connectv1_connector_plugins: + type: array + items: + type: object + properties: + class: + type: string + description: The connector class name. E.g. BigQuerySink. + type: + type: string + description: Type of connector, sink or source. + enum: + - sink + - source + version: + type: string + description: The version string for the connector available. + required: + - class + - type responses: connect.v1.UnauthenticatedError: description: Unauthorized diff --git a/provider-dev/source/encryption_keys.yaml b/provider-dev/source/encryption_keys.yaml index 2c0e2bb..9583c1b 100644 --- a/provider-dev/source/encryption_keys.yaml +++ b/provider-dev/source/encryption_keys.yaml @@ -23,10 +23,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - items: - example: mykek - type: string - type: array + $ref: '#/components/schemas/GetKekNamesResponse' application/vnd.schemaregistry+json; qs=0.9: schema: items: @@ -44,6 +41,12 @@ paths: security: - resource-api-key: [] - external-access-token: [] + x-stackql-bare-array-wrap: + wrapperKey: kek_names + wrapperName: GetKekNamesResponse + mediaType: application/vnd.schemaregistry.v1+json + scalar: true + columnName: kek_name post: tags: - Key Encryption Keys (v1) @@ -95,9 +98,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /dek-registry/v1/keks/{name}: delete: tags: @@ -234,9 +234,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /dek-registry/v1/keks/{name}/undelete: post: tags: @@ -262,9 +259,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /dek-registry/v1/keks/{name}/test: post: tags: @@ -300,9 +294,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /dek-registry/v1/keks/{name}/deks: get: tags: @@ -348,10 +339,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - items: - example: User - type: string - type: array + $ref: '#/components/schemas/GetDekSubjectsResponse' application/vnd.schemaregistry+json; qs=0.9: schema: items: @@ -373,6 +361,12 @@ paths: security: - resource-api-key: [] - external-access-token: [] + x-stackql-bare-array-wrap: + wrapperKey: dek_subjects + wrapperName: GetDekSubjectsResponse + mediaType: application/vnd.schemaregistry.v1+json + scalar: true + columnName: dek_subject post: tags: - Data Encryption Keys (v1) @@ -425,9 +419,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /dek-registry/v1/keks/{name}/deks/{subject}: delete: tags: @@ -545,9 +536,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}: delete: tags: @@ -681,9 +669,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /dek-registry/v1/keks/{name}/deks/{subject}/versions: get: tags: @@ -749,11 +734,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - items: - example: 1 - format: int32 - type: integer - type: array + $ref: '#/components/schemas/GetDekVersionsResponse' application/vnd.schemaregistry+json; qs=0.9: schema: items: @@ -777,9 +758,12 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. + x-stackql-bare-array-wrap: + wrapperKey: dek_versions + wrapperName: GetDekVersionsResponse + mediaType: application/vnd.schemaregistry.v1+json + scalar: true + columnName: dek_version /dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}/undelete: post: tags: @@ -833,9 +817,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /dek-registry/v1/keks/{name}/deks/{subject}/undelete: post: tags: @@ -881,9 +862,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /byok/v1/keys: get: x-lifecycle-stage: General Availability @@ -3422,6 +3400,36 @@ components: type: string nullable: true additionalProperties: false + GetKekNamesResponse: + type: object + properties: + kek_names: + type: array + items: + type: object + properties: + kek_name: + type: string + GetDekSubjectsResponse: + type: object + properties: + dek_subjects: + type: array + items: + type: object + properties: + dek_subject: + type: string + GetDekVersionsResponse: + type: object + properties: + dek_versions: + type: array + items: + type: object + properties: + dek_version: + type: integer responses: BadRequestError: description: Bad Request diff --git a/provider-dev/source/kafka.yaml b/provider-dev/source/kafka.yaml index a0b4e61..aa372f6 100644 --- a/provider-dev/source/kafka.yaml +++ b/provider-dev/source/kafka.yaml @@ -30,12 +30,8 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' + parameters: + - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/acls:batch: post: summary: Batch Create ACLs @@ -64,12 +60,8 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' + parameters: + - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/acls: get: summary: List ACLs @@ -96,6 +88,7 @@ paths: - $ref: '#/components/parameters/AclHost' - $ref: '#/components/parameters/AclOperation' - $ref: '#/components/parameters/AclPermission' + - $ref: '#/components/parameters/ClusterId' responses: '200': $ref: '#/components/responses/SearchAclsResponse' @@ -136,6 +129,8 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' delete: summary: Delete ACLs operationId: deleteKafkaAcls @@ -156,6 +151,7 @@ paths: - $ref: '#/components/parameters/AclHost' - $ref: '#/components/parameters/AclOperationRequired' - $ref: '#/components/parameters/AclPermissionRequired' + - $ref: '#/components/parameters/ClusterId' responses: '200': $ref: '#/components/responses/DeleteAclsResponse' @@ -169,12 +165,6 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/broker-configs: get: summary: List Dynamic Broker Configs @@ -202,12 +192,8 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' + parameters: + - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/broker-configs:alter: post: summary: Batch Alter Dynamic Broker Configs @@ -236,12 +222,8 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' + parameters: + - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/broker-configs/{name}: get: summary: Get Dynamic Broker Config @@ -268,6 +250,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConfigName' put: summary: Update Dynamic Broker Config operationId: updateKafkaClusterConfig @@ -295,6 +280,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConfigName' delete: summary: Reset Dynamic Broker Config operationId: deleteKafkaClusterConfig @@ -321,13 +309,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/ConfigName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConfigName' /kafka/v3/clusters/{cluster_id}/consumer-groups: get: summary: List Consumer Groups @@ -355,12 +339,8 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' + parameters: + - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}: get: summary: Get Consumer Group @@ -387,13 +367,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/ConsumerGroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers: get: summary: List Consumers @@ -421,13 +397,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/ConsumerGroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lag-summary: get: summary: Get Consumer Group Lag Summary @@ -455,13 +427,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/ConsumerGroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags: get: summary: List Consumer Lags @@ -489,13 +457,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/ConsumerGroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags/{topic_name}/partitions/{partition_id}: get: summary: Get Consumer Lag @@ -522,15 +486,11 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/ConsumerGroupId' - - $ref: '#/components/parameters/TopicName' - - $ref: '#/components/parameters/PartitionId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/PartitionId' /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_id}: get: summary: Get Consumer @@ -557,14 +517,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/ConsumerGroupId' - - $ref: '#/components/parameters/ConsumerId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/ConsumerGroupId' + - $ref: '#/components/parameters/ConsumerId' /kafka/v3/clusters/{cluster_id}/topics: get: summary: List Topics @@ -591,6 +547,8 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' post: summary: Create Topic operationId: createKafkaTopic @@ -623,12 +581,8 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' + parameters: + - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/topics/{topic_name}: get: summary: Get Topic @@ -644,6 +598,8 @@ paths: - external-access-token: [] parameters: - $ref: '#/components/parameters/IncludeAuthorizedOperations' + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' responses: '200': $ref: '#/components/responses/GetTopicResponse' @@ -690,6 +646,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' delete: summary: Delete Topic operationId: deleteKafkaTopic @@ -717,13 +676,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/TopicName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs: get: summary: List Topic Configs @@ -752,13 +707,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/TopicName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs:alter: post: summary: Batch Alter Topic Configs @@ -791,13 +742,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/TopicName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name}: get: summary: Get Topic Config @@ -826,6 +773,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/ConfigName' put: summary: Update Topic Config operationId: updateKafkaTopicConfig @@ -857,6 +808,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/ConfigName' delete: summary: Reset Topic Config operationId: deleteKafkaTopicConfig @@ -884,14 +839,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/TopicName' - - $ref: '#/components/parameters/ConfigName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/ConfigName' /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions: get: summary: List Partitions @@ -920,13 +871,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/TopicName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}: get: summary: Get Partition @@ -955,14 +902,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/TopicName' - - $ref: '#/components/parameters/PartitionId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' + - $ref: '#/components/parameters/PartitionId' /kafka/v3/clusters/{cluster_id}/topics/-/configs: get: summary: List All Topic Configs @@ -990,12 +933,8 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' + parameters: + - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/records: post: summary: Produce Records @@ -1047,13 +986,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/TopicName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' /kafka/v3/clusters/{cluster_id}/links: get: summary: List all cluster links in the dest cluster @@ -1078,6 +1013,8 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' post: summary: Create a cluster link operationId: createKafkaLink @@ -1095,6 +1032,7 @@ paths: - $ref: '#/components/parameters/QueryParamLinkName' - $ref: '#/components/parameters/ValidateOnly' - $ref: '#/components/parameters/ValidateLink' + - $ref: '#/components/parameters/ClusterId' requestBody: $ref: '#/components/requestBodies/CreateLinkRequest' responses: @@ -1108,12 +1046,6 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/links/{link_name}: get: summary: Describe the cluster link @@ -1126,6 +1058,8 @@ paths: - Cluster Linking (v3) parameters: - $ref: '#/components/parameters/IncludeTasks' + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' security: - resource-api-key: [] - external-access-token: [] @@ -1152,6 +1086,8 @@ paths: parameters: - $ref: '#/components/parameters/Force' - $ref: '#/components/parameters/ValidateOnly' + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' responses: '200': $ref: '#/components/responses/NoContentResponse' @@ -1163,13 +1099,6 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/default-configs: get: summary: List New Topic Default Configs @@ -1196,13 +1125,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/TopicName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/TopicName' /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs: get: summary: List all configs of the cluster link @@ -1224,13 +1149,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name}: get: summary: Describe the config under the cluster link @@ -1252,6 +1173,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/LinkConfigName' put: summary: Alter the config under the cluster link operationId: updateKafkaLinkConfig @@ -1274,6 +1199,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/LinkConfigName' delete: summary: Reset the given config to default value operationId: deleteKafkaLinkConfig @@ -1294,14 +1223,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' - - $ref: '#/components/parameters/LinkConfigName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/LinkConfigName' /kafka/v3/clusters/{cluster_id}/links/{link_name}/configs:alter: put: description: |- @@ -1316,6 +1241,8 @@ paths: - external-access-token: [] parameters: - $ref: '#/components/parameters/ValidateOnly' + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' requestBody: $ref: '#/components/requestBodies/AlterLinkConfigBatchRequest' responses: @@ -1330,13 +1257,6 @@ paths: 5XX: $ref: '#/components/responses/ServerErrorResponse' summary: Batch Alter Cluster Link Configs - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors: post: summary: Create a mirror topic @@ -1364,6 +1284,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' get: summary: List mirror topics operationId: listKafkaMirrorTopicsUnderLink @@ -1378,6 +1301,8 @@ paths: - external-access-token: [] parameters: - $ref: '#/components/parameters/MirrorTopicStatus' + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' responses: '200': $ref: '#/components/responses/ListMirrorTopicsResponse' @@ -1389,13 +1314,6 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' /kafka/v3/clusters/{cluster_id}/links/-/mirrors: get: summary: List mirror topics @@ -1411,6 +1329,7 @@ paths: - external-access-token: [] parameters: - $ref: '#/components/parameters/MirrorTopicStatus' + - $ref: '#/components/parameters/ClusterId' responses: '200': $ref: '#/components/responses/ListMirrorTopicsResponse' @@ -1422,12 +1341,6 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors/{mirror_topic_name}: get: summary: Describe the mirror topic @@ -1437,6 +1350,9 @@ paths: - Cluster Linking (v3) parameters: - $ref: '#/components/parameters/IncludeStateTransitionErrors' + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/MirrorTopicName' security: - resource-api-key: [] - external-access-token: [] @@ -1451,14 +1367,6 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' - - $ref: '#/components/parameters/MirrorTopicName' /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:promote: post: summary: Promote the mirror topics @@ -1482,14 +1390,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' - - $ref: '#/components/parameters/ValidateOnly' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:failover: post: summary: Failover the mirror topics @@ -1513,14 +1417,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' - - $ref: '#/components/parameters/ValidateOnly' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:pause: post: summary: Pause the mirror topics @@ -1544,14 +1444,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' - - $ref: '#/components/parameters/ValidateOnly' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:resume: post: summary: Resume the mirror topics @@ -1575,14 +1471,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' - - $ref: '#/components/parameters/ValidateOnly' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-start-mirror: post: summary: Reverse the local mirror topic and start the remote mirror topic @@ -1606,14 +1498,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' - - $ref: '#/components/parameters/ValidateOnly' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/ValidateOnly' /kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-pause-mirror: post: summary: Reverse the local mirror topic and Pause the remote mirror topic @@ -1637,14 +1525,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' - - $ref: '#/components/parameters/ValidateOnly' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $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 @@ -1668,15 +1552,11 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/LinkName' - - $ref: '#/components/parameters/IncludePartitionLevelTruncationData' - - $ref: '#/components/parameters/ValidateOnly' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/LinkName' + - $ref: '#/components/parameters/IncludePartitionLevelTruncationData' + - $ref: '#/components/parameters/ValidateOnly' /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs: get: summary: List all configs of the group @@ -1703,13 +1583,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name}: get: summary: Get group config @@ -1736,6 +1612,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConfigName' put: summary: Update group config operationId: updateKafkaGroupConfig @@ -1763,6 +1643,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConfigName' delete: summary: Delete group config operationId: deleteKafkaGroupConfig @@ -1788,14 +1672,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/ConfigName' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConfigName' /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs:alter: post: summary: Batch Alter Group Configs @@ -1811,6 +1691,8 @@ paths: - external-access-token: [] parameters: - $ref: '#/components/parameters/ValidateOnly' + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' requestBody: $ref: '#/components/requestBodies/AlterGroupConfigBatchRequest' responses: @@ -1826,13 +1708,6 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' components: schemas: UpdatePartitionCountRequestData: diff --git a/provider-dev/source/schema_registry.yaml b/provider-dev/source/schema_registry.yaml index b3f3b85..48e6200 100644 --- a/provider-dev/source/schema_registry.yaml +++ b/provider-dev/source/schema_registry.yaml @@ -37,9 +37,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /compatibility/subjects/{subject}/versions/{version}: post: tags: @@ -146,9 +143,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /compatibility/subjects/{subject}/versions: post: tags: @@ -232,9 +226,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /config/{subject}: get: tags: @@ -472,9 +463,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /config: get: tags: @@ -662,9 +650,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /exporters: get: tags: @@ -678,10 +663,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - type: string - example: '["exporter1", "exporter2"]' + $ref: '#/components/schemas/ListExportersResponse' '400': $ref: '#/components/responses/schemaregistry.v1.BadRequestError' '401': @@ -695,6 +677,12 @@ paths: security: - resource-api-key: [] - external-access-token: [] + x-stackql-bare-array-wrap: + wrapperKey: exporters + wrapperName: ListExportersResponse + mediaType: application/vnd.schemaregistry.v1+json + scalar: true + columnName: exporter post: tags: - Exporters (v1) @@ -746,9 +734,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /exporters/{name}: get: tags: @@ -878,9 +863,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /exporters/{name}/status: get: tags: @@ -921,9 +903,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /exporters/{name}/config: get: tags: @@ -1022,9 +1001,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /exporters/{name}/pause: put: tags: @@ -1071,9 +1047,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /exporters/{name}/reset: put: tags: @@ -1120,9 +1093,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /exporters/{name}/resume: put: tags: @@ -1169,9 +1139,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /contexts: get: tags: @@ -1200,10 +1167,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - type: string - example: . + $ref: '#/components/schemas/ListContextsResponse' application/vnd.schemaregistry+json; qs=0.9: schema: type: array @@ -1239,9 +1203,12 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. + x-stackql-bare-array-wrap: + wrapperKey: contexts + wrapperName: ListContextsResponse + mediaType: application/vnd.schemaregistry.v1+json + scalar: true + columnName: context /mode/{subject}: get: tags: @@ -1452,9 +1419,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /mode: get: tags: @@ -1564,9 +1528,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /schemas/ids/{id}: get: tags: @@ -1641,9 +1602,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /schemas/ids/{id}/schema: get: tags: @@ -1721,9 +1679,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /schemas/types: get: tags: @@ -1737,10 +1692,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - type: string - example: AVRO + $ref: '#/components/schemas/GetSchemaTypesResponse' application/vnd.schemaregistry+json; qs=0.9: schema: type: array @@ -1776,9 +1728,12 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. + x-stackql-bare-array-wrap: + wrapperKey: schema_types + wrapperName: GetSchemaTypesResponse + mediaType: application/vnd.schemaregistry.v1+json + scalar: true + columnName: schema_type /schemas: get: tags: @@ -1837,9 +1792,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - $ref: '#/components/schemas/Schema' + $ref: '#/components/schemas/GetSchemasResponse' application/vnd.schemaregistry+json; qs=0.9: schema: type: array @@ -1873,9 +1826,11 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. + x-stackql-bare-array-wrap: + wrapperKey: schemas + wrapperName: GetSchemasResponse + mediaType: application/vnd.schemaregistry.v1+json + scalar: false /schemas/ids/{id}/subjects: get: tags: @@ -1927,10 +1882,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - type: string - example: User + $ref: '#/components/schemas/GetSubjectsResponse' application/vnd.schemaregistry+json; qs=0.9: schema: type: array @@ -1978,9 +1930,12 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. + x-stackql-bare-array-wrap: + wrapperKey: subjects + wrapperName: GetSubjectsResponse + mediaType: application/vnd.schemaregistry.v1+json + scalar: true + columnName: subject /schemas/ids/{id}/versions: get: tags: @@ -2026,9 +1981,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - $ref: '#/components/schemas/SubjectVersion' + $ref: '#/components/schemas/GetVersionsResponse' application/vnd.schemaregistry+json; qs=0.9: schema: type: array @@ -2074,9 +2027,11 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. + x-stackql-bare-array-wrap: + wrapperKey: versions + wrapperName: GetVersionsResponse + mediaType: application/vnd.schemaregistry.v1+json + scalar: false /subjects/{subject}/versions/{version}: get: tags: @@ -2258,9 +2213,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /subjects/{subject}/versions/{version}/referencedby: get: tags: @@ -2301,11 +2253,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - type: integer - format: int32 - example: 100001 + $ref: '#/components/schemas/GetReferencedByResponse' application/vnd.schemaregistry+json; qs=0.9: schema: type: array @@ -2367,9 +2315,12 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. + x-stackql-bare-array-wrap: + wrapperKey: referenced_by + wrapperName: GetReferencedByResponse + mediaType: application/vnd.schemaregistry.v1+json + scalar: true + columnName: referenced_by /subjects/{subject}/versions/{version}/schema: get: tags: @@ -2458,9 +2409,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /subjects/{subject}/versions: get: tags: @@ -2505,11 +2453,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - type: integer - format: int32 - example: 1 + $ref: '#/components/schemas/ListVersionsResponse' application/vnd.schemaregistry+json; qs=0.9: schema: type: array @@ -2559,6 +2503,12 @@ paths: security: - resource-api-key: [] - external-access-token: [] + x-stackql-bare-array-wrap: + wrapperKey: versions + wrapperName: ListVersionsResponse + mediaType: application/vnd.schemaregistry.v1+json + scalar: true + columnName: version post: tags: - Subjects (v1) @@ -2662,9 +2612,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. /subjects/{subject}: post: tags: @@ -2783,11 +2730,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - type: integer - format: int32 - example: 1 + $ref: '#/components/schemas/DeleteSubjectResponse' application/vnd.schemaregistry+json; qs=0.9: schema: type: array @@ -2837,9 +2780,12 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. + x-stackql-bare-array-wrap: + wrapperKey: delete_subject + wrapperName: DeleteSubjectResponse + mediaType: application/vnd.schemaregistry.v1+json + scalar: true + columnName: delete_subject /subjects: get: tags: @@ -2884,10 +2830,7 @@ paths: content: application/vnd.schemaregistry.v1+json: schema: - type: array - items: - type: string - example: User + $ref: '#/components/schemas/ListResponse' application/vnd.schemaregistry+json; qs=0.9: schema: type: array @@ -2923,9 +2866,12 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. + x-stackql-bare-array-wrap: + wrapperKey: items + wrapperName: ListResponse + mediaType: application/vnd.schemaregistry.v1+json + scalar: true + columnName: item /subjects/{subject}/metadata: get: tags: @@ -2983,9 +2929,6 @@ paths: security: - resource-api-key: [] - external-access-token: [] - servers: - - url: https://psrc-00000.region.provider.confluent.cloud - description: Confluent Cloud Schema Registry Endpoint. components: schemas: ClusterConfig: @@ -3559,6 +3502,100 @@ components: enum: - sr_record - sr_field + ListExportersResponse: + type: object + properties: + exporters: + type: array + items: + type: object + properties: + exporter: + type: string + ListContextsResponse: + type: object + properties: + contexts: + type: array + items: + type: object + properties: + context: + type: string + GetSchemaTypesResponse: + type: object + properties: + schema_types: + type: array + items: + type: object + properties: + schema_type: + type: string + GetSchemasResponse: + type: object + properties: + schemas: + type: array + items: + $ref: '#/components/schemas/Schema' + GetSubjectsResponse: + type: object + properties: + subjects: + type: array + items: + type: object + properties: + subject: + type: string + GetVersionsResponse: + type: object + properties: + versions: + type: array + items: + $ref: '#/components/schemas/SubjectVersion' + GetReferencedByResponse: + type: object + properties: + referenced_by: + type: array + items: + type: object + properties: + referenced_by: + type: integer + ListVersionsResponse: + type: object + properties: + versions: + type: array + items: + type: object + properties: + version: + type: integer + DeleteSubjectResponse: + type: object + properties: + delete_subject: + type: array + items: + type: object + properties: + delete_subject: + type: integer + ListResponse: + type: object + properties: + items: + type: array + items: + type: object + properties: + item: + type: string responses: schemaregistry.v1.BadRequestError: description: Bad Request diff --git a/provider-dev/source/share_group.yaml b/provider-dev/source/share_group.yaml index ed22a5e..18a5c58 100644 --- a/provider-dev/source/share_group.yaml +++ b/provider-dev/source/share_group.yaml @@ -30,12 +30,8 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' + parameters: + - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}: get: summary: Get Share Group @@ -61,6 +57,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' delete: summary: Delete Share Group operationId: deleteKafkaShareGroup @@ -88,13 +87,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers: get: summary: List Share Group Consumers @@ -121,13 +116,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}: get: summary: Get Share Group Consumer @@ -153,14 +144,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/ConsumerId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConsumerId' /kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}/assignments: get: summary: List Share Group Consumer Assignments @@ -186,14 +173,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/ConsumerId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/ConsumerId' components: schemas: ShareGroupDataList: diff --git a/provider-dev/source/sql.yaml b/provider-dev/source/sql.yaml index ef4fe48..a51ab28 100644 --- a/provider-dev/source/sql.yaml +++ b/provider-dev/source/sql.yaml @@ -319,9 +319,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint x-lifecycle-stage: Preview x-self-access: true x-request-access-name: SQL API v1 @@ -656,9 +653,6 @@ paths: - spec - name - metadata - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint x-lifecycle-stage: Preview x-self-access: true x-request-access-name: SQL API v1 @@ -809,9 +803,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint x-lifecycle-stage: General Availability x-self-access: true x-request-access-name: SQL API v1 @@ -1138,9 +1129,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint x-lifecycle-stage: General Availability x-self-access: true x-request-access-name: SQL API v1 @@ -1643,9 +1631,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint x-lifecycle-stage: General Availability x-self-access: true x-request-access-name: SQL API v1 @@ -1709,9 +1694,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint x-lifecycle-stage: General Availability x-self-access: true x-request-access-name: SQL API v1 @@ -1785,9 +1767,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables: post: x-lifecycle-stage: General Availability @@ -2133,9 +2112,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}: get: x-lifecycle-stage: General Availability @@ -2468,9 +2444,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}/versions: get: x-lifecycle-stage: General Availability @@ -2553,9 +2526,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}/versions/{version}: get: x-lifecycle-stage: General Availability @@ -2630,9 +2600,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint /sql/v1/organizations/{organization_id}/environments/{environment_id}/agents: get: x-lifecycle-stage: Preview @@ -2703,9 +2670,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents: post: x-lifecycle-stage: Preview @@ -2987,9 +2951,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents/{agent_name}: get: x-lifecycle-stage: Preview @@ -3291,9 +3252,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools: post: x-lifecycle-stage: Preview @@ -3590,9 +3548,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint x-lifecycle-stage: Preview x-self-access: true x-request-access-name: SQL API v1 @@ -3799,9 +3754,6 @@ paths: $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/DefaultSystemError' - servers: - - url: https://flink.region.provider.confluent.cloud - description: Flink Compute Pool Endpoint x-lifecycle-stage: Preview x-self-access: true x-request-access-name: SQL API v1 diff --git a/provider-dev/source/streams_group.yaml b/provider-dev/source/streams_group.yaml index c375198..944181c 100644 --- a/provider-dev/source/streams_group.yaml +++ b/provider-dev/source/streams_group.yaml @@ -29,12 +29,8 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' + parameters: + - $ref: '#/components/parameters/ClusterId' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}: get: summary: Get Streams Group @@ -60,13 +56,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/subtopologies: get: summary: List Streams Group Subtopologies @@ -92,13 +84,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/subtopologies/{subtopology_id}: get: summary: Get Streams Group Subtopology @@ -124,14 +112,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/SubtopologyId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/SubtopologyId' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members: get: summary: List Streams Group Members @@ -157,13 +141,9 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}: get: summary: Get Streams Group Member @@ -189,14 +169,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/MemberId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments: get: summary: Get Streams Group Member Assignments @@ -222,14 +198,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/MemberId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments: get: summary: Get Streams Group Member Target Assignments @@ -255,14 +227,10 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/MemberId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments/{assignments_type}: get: summary: List Streams Group Assignments of a Specific Type @@ -288,15 +256,11 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/MemberId' - - $ref: '#/components/parameters/AssignmentsType' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments/{assignments_type}: get: summary: List Streams Group Target Assignments of a Specific Type @@ -322,15 +286,11 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/MemberId' - - $ref: '#/components/parameters/AssignmentsType' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments/{assignments_type}/subtopologies/{subtopology_id}: get: summary: List Streams Group Assignments Task Partitions of a Specific Type and Subtopology @@ -356,16 +316,12 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/MemberId' - - $ref: '#/components/parameters/AssignmentsType' - - $ref: '#/components/parameters/SubtopologyId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' + - $ref: '#/components/parameters/SubtopologyId' /kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments/{assignments_type}/subtopologies/{subtopology_id}: get: summary: List Streams Group Target Assignments Task Partitions of a Specific Type and Subtopology @@ -391,16 +347,12 @@ paths: $ref: '#/components/responses/TooManyRequestsErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' - servers: - - url: https://pkc-00000.region.provider.confluent.cloud - x-audience: business-unit-internal - description: Confluent Cloud REST Endpoint. For example https://pkc-00000.region.provider.confluent.cloud - parameters: - - $ref: '#/components/parameters/ClusterId' - - $ref: '#/components/parameters/GroupId' - - $ref: '#/components/parameters/MemberId' - - $ref: '#/components/parameters/AssignmentsType' - - $ref: '#/components/parameters/SubtopologyId' + parameters: + - $ref: '#/components/parameters/ClusterId' + - $ref: '#/components/parameters/GroupId' + - $ref: '#/components/parameters/MemberId' + - $ref: '#/components/parameters/AssignmentsType' + - $ref: '#/components/parameters/SubtopologyId' components: schemas: StreamsGroupDataList: diff --git a/views/managed_kafka_clusters/views.yaml b/views/managed_kafka_clusters/views.yaml new file mode 100644 index 0000000..1fd3399 --- /dev/null +++ b/views/managed_kafka_clusters/views.yaml @@ -0,0 +1,123 @@ + vw_clusters: + name: vw_clusters + id: confluent.managed_kafka_clusters.vw_clusters + config: + docs: + fields: + - name: environment + type: string + description: Environment ID used to scope the cluster list (required `WHERE` parameter; echoed back as a column). + - name: id + type: string + description: Cluster ID (e.g. lkc-50r5wn). + - name: kind + type: string + description: Object kind (always `Cluster`). + - name: api_version + type: string + description: Confluent API version (e.g. `cmk/v2`). + - name: display_name + type: string + description: Human-readable cluster name. + - name: availability + type: string + description: Cluster availability tier (e.g. LOW, HIGH). + - name: cloud + type: string + description: Cloud provider (AWS, GCP, AZURE). + - name: region + type: string + description: Cloud region the cluster runs in. + - name: config_kind + type: string + description: Cluster sizing kind (Basic, Standard, Enterprise, Dedicated, Freight). + - name: max_ecku + type: integer + description: Maximum eCKU count for elastic clusters. + - name: api_endpoint + type: string + description: Cluster REST API endpoint URL. + - name: http_endpoint + type: string + description: Cluster HTTP endpoint URL. + - name: kafka_bootstrap_endpoint + type: string + description: Kafka bootstrap endpoint URL (SASL_SSL://...). + - name: environment_id + type: string + description: ID of the environment that owns this cluster. + - name: environment_resource_name + type: string + description: Confluent Resource Name (CRN) of the owning environment. + - name: phase + type: string + description: Cluster lifecycle phase (e.g. PROVISIONED). + - name: created_at + type: string + description: Timestamp when the cluster was created (ISO 8601). + - name: updated_at + type: string + description: Timestamp when the cluster was last updated (ISO 8601). + - name: resource_name + type: string + description: Confluent Resource Name (CRN) for this cluster. + - name: self + type: string + description: Self-link URL for this cluster. + requiredParams: + - name: environment + type: string + description: Environment ID used to scope the cluster list. + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + id, + kind, + api_version, + environment, + JSON_EXTRACT(spec, '$.display_name') AS display_name, + JSON_EXTRACT(spec, '$.availability') AS availability, + JSON_EXTRACT(spec, '$.cloud') AS cloud, + JSON_EXTRACT(spec, '$.region') AS region, + JSON_EXTRACT(spec, '$.config.kind') AS config_kind, + JSON_EXTRACT(spec, '$.config.max_ecku') AS max_ecku, + JSON_EXTRACT(spec, '$.api_endpoint') AS api_endpoint, + JSON_EXTRACT(spec, '$.http_endpoint') AS http_endpoint, + JSON_EXTRACT(spec, '$.kafka_bootstrap_endpoint') AS kafka_bootstrap_endpoint, + JSON_EXTRACT(spec, '$.environment.id') AS environment_id, + JSON_EXTRACT(spec, '$.environment.resource_name') AS environment_resource_name, + JSON_EXTRACT(status, '$.phase') AS phase, + JSON_EXTRACT(metadata, '$.created_at') AS created_at, + JSON_EXTRACT(metadata, '$.updated_at') AS updated_at, + JSON_EXTRACT(metadata, '$.resource_name') AS resource_name, + JSON_EXTRACT(metadata, '$.self') AS self + FROM confluent.managed_kafka_clusters.clusters + WHERE environment = '{{ environment }}' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + id, + kind, + api_version, + environment, + spec->>'display_name' AS display_name, + spec->>'availability' AS availability, + spec->>'cloud' AS cloud, + spec->>'region' AS region, + spec->'config'->>'kind' AS config_kind, + (spec->'config'->>'max_ecku')::integer AS max_ecku, + spec->>'api_endpoint' AS api_endpoint, + spec->>'http_endpoint' AS http_endpoint, + spec->>'kafka_bootstrap_endpoint' AS kafka_bootstrap_endpoint, + spec->'environment'->>'id' AS environment_id, + spec->'environment'->>'resource_name' AS environment_resource_name, + status->>'phase' AS phase, + metadata->>'created_at' AS created_at, + metadata->>'updated_at' AS updated_at, + metadata->>'resource_name' AS resource_name, + metadata->>'self' AS self + FROM confluent.managed_kafka_clusters.clusters + WHERE environment = '{{ environment }}' diff --git a/website/docs/index.md b/website/docs/index.md index 82d382f..98fb53a 100644 --- a/website/docs/index.md +++ b/website/docs/index.md @@ -23,7 +23,7 @@ Confluent Cloud for managing Kafka clusters, topics, and streaming services in a :::info[Provider Summary] total services: __28__ -total resources: __170__ +total resources: __171__ ::: diff --git a/website/docs/services/connect/connector_config/index.md b/website/docs/services/connect/connector_config/index.md index 7d3b815..d12882e 100644 --- a/website/docs/services/connect/connector_config/index.md +++ b/website/docs/services/connect/connector_config/index.md @@ -114,14 +114,14 @@ The following methods are available for this resource: - + connector_name, environment_id, kafka_cluster_id Get the configuration for the connector. - connector.class, name, kafka.api.key, kafka.api.secret + connector_name, environment_id, kafka_cluster_id, connector.class, name, kafka.api.key, kafka.api.secret Create a new connector using the given configuration, or update the configuration for an existing connector. Returns information about the connector after the change has been made. @@ -141,6 +141,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The unique name of the connector. + + + + string + The unique identifier of the environment this resource belongs to. + + + + string + The unique identifier for the Kafka cluster. + @@ -167,6 +182,9 @@ kafka.api.secret, kafka.endpoint, kafka.region FROM confluent.connect.connector_config +WHERE connector_name = '{{ connector_name }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required ; ``` @@ -199,7 +217,10 @@ confluent.custom.schema.registry.auto = '{{ confluent.custom.schema.registry.aut confluent.custom.connect.plugin.runtime = '{{ confluent.custom.connect.plugin.runtime }}', confluent.custom.connect.java.version = '{{ confluent.custom.connect.java.version }}' WHERE -connector.class = '{{ connector.class }}' --required +connector_name = '{{ connector_name }}' --required +AND environment_id = '{{ environment_id }}' --required +AND kafka_cluster_id = '{{ kafka_cluster_id }}' --required +AND connector.class = '{{ connector.class }}' --required AND name = '{{ name }}' --required AND kafka.api.key = '{{ kafka.api.key }}' --required AND kafka.api.secret = '{{ kafka.api.secret }}' --required diff --git a/website/docs/services/connect/connector_offsets/index.md b/website/docs/services/connect/connector_offsets/index.md index 72fb5c4..2eed3a1 100644 --- a/website/docs/services/connect/connector_offsets/index.md +++ b/website/docs/services/connect/connector_offsets/index.md @@ -94,7 +94,7 @@ The following methods are available for this resource: - + connector_name, environment_id, kafka_cluster_id Get the current offsets for the connector. The offsets provide information on the point in the source system,
from which the connector is pulling in data. The offsets of a connector are continuously observed periodically and are queryable via this API. @@ -114,6 +114,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The unique name of the connector. + + + + string + The unique identifier of the environment this resource belongs to. + + + + string + The unique identifier for the Kafka cluster. + @@ -136,6 +151,9 @@ name, metadata, offsets FROM confluent.connect.connector_offsets +WHERE connector_name = '{{ connector_name }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required ; ``` diff --git a/website/docs/services/connect/connector_offsets_requests/index.md b/website/docs/services/connect/connector_offsets_requests/index.md index d59d6cd..5748b6d 100644 --- a/website/docs/services/connect/connector_offsets_requests/index.md +++ b/website/docs/services/connect/connector_offsets_requests/index.md @@ -94,14 +94,14 @@ The following methods are available for this resource: - + connector_name, environment_id, kafka_cluster_id Get the status of the previous alter offset request. - type + connector_name, environment_id, kafka_cluster_id, type Request to alter the offsets of a connector. This supports the ability to PATCH/DELETE the offsets of a connector.
Note, you will see momentary downtime as this will internally stop the connector, while the offsets are being altered.
You can only make one alter offsets request at a time for a connector. @@ -121,6 +121,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The unique name of the connector. + + + + string + The unique identifier of the environment this resource belongs to. + + + + string + The unique identifier for the Kafka cluster. + @@ -143,6 +158,9 @@ previous_offsets, request, status FROM confluent.connect.connector_offsets_requests +WHERE connector_name = '{{ connector_name }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required ; ``` @@ -163,6 +181,9 @@ Request to alter the offsets of a connector. This supports the ability to PATCH/ ```sql EXEC confluent.connect.connector_offsets_requests.alter_connectv1_connector_offsets_request +@connector_name='{{ connector_name }}' --required, +@environment_id='{{ environment_id }}' --required, +@kafka_cluster_id='{{ kafka_cluster_id }}' --required @@json= '{ "type": "{{ type }}", diff --git a/website/docs/services/connect/connector_status/index.md b/website/docs/services/connect/connector_status/index.md index 6b531a4..4d33ae8 100644 --- a/website/docs/services/connect/connector_status/index.md +++ b/website/docs/services/connect/connector_status/index.md @@ -94,7 +94,7 @@ The following methods are available for this resource: - + connector_name, environment_id, kafka_cluster_id Get current status of the connector. This includes whether it is running, failed, or paused. Also includes which worker it is assigned to, error information if it has failed, and the state of all its tasks. @@ -114,6 +114,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The unique name of the connector. + + + + string + The unique identifier of the environment this resource belongs to. + + + + string + The unique identifier for the Kafka cluster. + @@ -136,6 +151,9 @@ connector, tasks, type FROM confluent.connect.connector_status +WHERE connector_name = '{{ connector_name }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required ; ``` diff --git a/website/docs/services/connect/connector_tasks/index.md b/website/docs/services/connect/connector_tasks/index.md index 3331425..f9b7936 100644 --- a/website/docs/services/connect/connector_tasks/index.md +++ b/website/docs/services/connect/connector_tasks/index.md @@ -84,7 +84,7 @@ The following methods are available for this resource: - + connector_name, environment_id, kafka_cluster_id Get a list of tasks currently running for the connector. @@ -104,6 +104,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The unique name of the connector. + + + + string + The unique identifier of the environment this resource belongs to. + + + + string + The unique identifier for the Kafka cluster. + @@ -124,6 +139,9 @@ SELECT id, config FROM confluent.connect.connector_tasks +WHERE connector_name = '{{ connector_name }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required ; ``` diff --git a/website/docs/services/connect/connectors/index.md b/website/docs/services/connect/connectors/index.md index 5f9b3fc..d7cfbec 100644 --- a/website/docs/services/connect/connectors/index.md +++ b/website/docs/services/connect/connectors/index.md @@ -111,28 +111,28 @@ The following methods are available for this resource: - + connector_name, environment_id, kafka_cluster_id Get information about the connector. - + environment_id, kafka_cluster_id Retrieve a list of "names" of the active connectors. You can then make a read request for a specific connector by name. - + environment_id, kafka_cluster_id Create a new connector. Returns the new connector information if successful. - + connector_name, environment_id, kafka_cluster_id Delete a connector. Halts all tasks and deletes the connector configuration. @@ -146,21 +146,21 @@ The following methods are available for this resource: - + connector_name, environment_id, kafka_cluster_id Pause the connector and its tasks. Stops message processing until the connector is resumed. This call is asynchronous and the tasks will not transition to PAUSED state at the same time. - + connector_name, environment_id, kafka_cluster_id Resume a paused connector or do nothing if the connector is not paused. This call is asynchronous and the tasks will not transition to RUNNING state at the same time. - + connector_name, environment_id, kafka_cluster_id Restart the connector and its tasks. Stops message processing until the connector and tasks are restart. This call is asynchronous and the connector will not transition to another state at the same time. @@ -180,6 +180,11 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The unique name of the connector. + string @@ -218,6 +223,9 @@ config, tasks, type FROM confluent.connect.connectors +WHERE connector_name = '{{ connector_name }}' -- required +AND environment_id = '{{ environment_id }}' -- required +AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required ; ``` @@ -229,6 +237,8 @@ Retrieve a list of "names" of the active connectors. You can then make a read re SELECT * FROM confluent.connect.connectors +WHERE environment_id = '{{ environment_id }}' -- required +AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required ; ``` @@ -252,12 +262,16 @@ Create a new connector. Returns the new connector information if successful. INSERT INTO confluent.connect.connectors ( name, config, -offsets +offsets, +environment_id, +kafka_cluster_id ) SELECT '{{ name }}', '{{ config }}', -'{{ offsets }}' +'{{ offsets }}', +'{{ environment_id }}', +'{{ kafka_cluster_id }}' RETURNING name, config, @@ -272,6 +286,12 @@ type {`# Description fields are for documentation purposes - name: connectors props: + - name: environment_id + value: "{{ environment_id }}" + description: Required parameter for the connectors resource. + - name: kafka_cluster_id + value: "{{ kafka_cluster_id }}" + description: Required parameter for the connectors resource. - name: name value: "{{ name }}" description: | @@ -316,6 +336,9 @@ Delete a connector. Halts all tasks and deletes the connector configuration. ```sql DELETE FROM confluent.connect.connectors +WHERE connector_name = '{{ connector_name }}' --required +AND environment_id = '{{ environment_id }}' --required +AND kafka_cluster_id = '{{ kafka_cluster_id }}' --required ; ``` @@ -351,7 +374,9 @@ Pause the connector and its tasks. Stops message processing until the connector ```sql EXEC confluent.connect.connectors.pause_connectv1_connector - +@connector_name='{{ connector_name }}' --required, +@environment_id='{{ environment_id }}' --required, +@kafka_cluster_id='{{ kafka_cluster_id }}' --required ; ``` @@ -361,7 +386,9 @@ Resume a paused connector or do nothing if the connector is not paused. This cal ```sql EXEC confluent.connect.connectors.resume_connectv1_connector - +@connector_name='{{ connector_name }}' --required, +@environment_id='{{ environment_id }}' --required, +@kafka_cluster_id='{{ kafka_cluster_id }}' --required ; ``` @@ -371,7 +398,9 @@ Restart the connector and its tasks. Stops message processing until the connecto ```sql EXEC confluent.connect.connectors.restart_connectv1_connector - +@connector_name='{{ connector_name }}' --required, +@environment_id='{{ environment_id }}' --required, +@kafka_cluster_id='{{ kafka_cluster_id }}' --required ; ``` diff --git a/website/docs/services/connect/managed_connector_plugins/index.md b/website/docs/services/connect/managed_connector_plugins/index.md index b3a3ebf..09c5d63 100644 --- a/website/docs/services/connect/managed_connector_plugins/index.md +++ b/website/docs/services/connect/managed_connector_plugins/index.md @@ -89,22 +89,22 @@ The following methods are available for this resource: - + environment_id, kafka_cluster_id Return a list of Managed Connector plugins installed in the Kafka Connect cluster. - + plugin_name, environment_id, kafka_cluster_id Validate the provided configuration values against the configuration definition. This API performs per config validation and returns suggested values and validation error messages. - - + plugin_name, environment_id, kafka_cluster_id + mask_sensitive Translate the provided Self Managed configuration values. This API performs configuration translation
and returns the translated fully managed configuration along with any errors or warnings.
Query Parameter `mask_sensitive=true` redacts sensitive config values in response. @@ -123,6 +123,26 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The unique identifier of the environment this resource belongs to. + + + + string + The unique identifier for the Kafka cluster. + + + + string + The unique name of the connector plugin. + + + + string + Indicates whether to redact sensitive config values in response. + @@ -144,6 +164,8 @@ class, type, version FROM confluent.connect.managed_connector_plugins +WHERE environment_id = '{{ environment_id }}' -- required +AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required ; ``` @@ -165,7 +187,9 @@ Validate the provided configuration values against the configuration definition. ```sql EXEC confluent.connect.managed_connector_plugins.validate_connectv1_connector_plugin - +@plugin_name='{{ plugin_name }}' --required, +@environment_id='{{ environment_id }}' --required, +@kafka_cluster_id='{{ kafka_cluster_id }}' --required ; ``` @@ -175,7 +199,10 @@ Translate the provided Self Managed configuration values. This API performs conf ```sql EXEC confluent.connect.managed_connector_plugins.translate_connectv1_connector_plugin - +@plugin_name='{{ plugin_name }}' --required, +@environment_id='{{ environment_id }}' --required, +@kafka_cluster_id='{{ kafka_cluster_id }}' --required, +@mask_sensitive='{{ mask_sensitive }}' ; ``` diff --git a/website/docs/services/kafka/acls/index.md b/website/docs/services/kafka/acls/index.md index 1856f0f..7a37af6 100644 --- a/website/docs/services/kafka/acls/index.md +++ b/website/docs/services/kafka/acls/index.md @@ -89,28 +89,28 @@ The following methods are available for this resource: - + cluster_id resource_type, resource_name, pattern_type, principal, host, operation, permission - 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
`/acls?principal=UserV2:*`.
- The `principal` parameter supports both legacy `User:` format and
new `UserV2:` format for service accounts.
Return a list of ACLs that match the search criteria. - resource_type, resource_name, pattern_type, principal, host, operation, permission + cluster_id, resource_type, resource_name, pattern_type, principal, host, operation, permission Create an ACL. - resource_type, pattern_type, operation, permission + resource_type, pattern_type, operation, permission, cluster_id resource_name, principal, host Delete the ACLs that match the search criteria. - data + cluster_id, data Create ACLs. @@ -130,6 +130,11 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + string @@ -206,7 +211,8 @@ data, kind, metadata FROM confluent.kafka.acls -WHERE resource_type = '{{ resource_type }}' +WHERE cluster_id = '{{ cluster_id }}' -- required +AND resource_type = '{{ resource_type }}' AND resource_name = '{{ resource_name }}' AND pattern_type = '{{ pattern_type }}' AND principal = '{{ principal }}' @@ -240,7 +246,8 @@ pattern_type, principal, host, operation, -permission +permission, +cluster_id ) SELECT '{{ resource_type }}' /* required */, @@ -249,7 +256,8 @@ SELECT '{{ principal }}' /* required */, '{{ host }}' /* required */, '{{ operation }}' /* required */, -'{{ permission }}' /* required */ +'{{ permission }}' /* required */, +'{{ cluster_id }}' ; ``` @@ -258,6 +266,9 @@ SELECT {`# Description fields are for documentation purposes - name: acls props: + - name: cluster_id + value: "{{ cluster_id }}" + description: Required parameter for the acls resource. - name: resource_type value: "{{ resource_type }}" valid_values: ['UNKNOWN', 'ANY', 'TOPIC', 'GROUP', 'CLUSTER', 'TRANSACTIONAL_ID', 'DELEGATION_TOKEN'] @@ -297,6 +308,7 @@ WHERE resource_type = '{{ resource_type }}' --required AND pattern_type = '{{ pattern_type }}' --required AND operation = '{{ operation }}' --required AND permission = '{{ permission }}' --required +AND cluster_id = '{{ cluster_id }}' --required AND resource_name = '{{ resource_name }}' AND principal = '{{ principal }}' AND host = '{{ host }}' @@ -320,6 +332,7 @@ Create ACLs. ```sql EXEC confluent.kafka.acls.batch_create_kafka_acls +@cluster_id='{{ cluster_id }}' --required @@json= '{ "data": "{{ data }}" diff --git a/website/docs/services/kafka/cluster_configs/index.md b/website/docs/services/kafka/cluster_configs/index.md index 3e8988c..2f613b4 100644 --- a/website/docs/services/kafka/cluster_configs/index.md +++ b/website/docs/services/kafka/cluster_configs/index.md @@ -201,35 +201,35 @@ The following methods are available for this resource: - + cluster_id, name Return the dynamic cluster-wide broker configuration parameter specified by ``name``. - + cluster_id 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. - + cluster_id, name Update the dynamic cluster-wide broker configuration parameter specified by ``name``. - data + cluster_id, data Update or delete a set of dynamic cluster-wide broker configuration parameters. - + cluster_id, name Reset the configuration parameter specified by ``name`` to its
default value by deleting a dynamic cluster-wide configuration. @@ -249,6 +249,16 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The configuration parameter name. (example: compression.type) + @@ -279,6 +289,8 @@ source, synonyms, value FROM confluent.kafka.cluster_configs +WHERE cluster_id = '{{ cluster_id }}' -- required +AND name = '{{ name }}' -- required ; ``` @@ -300,6 +312,7 @@ source, synonyms, value FROM confluent.kafka.cluster_configs +WHERE cluster_id = '{{ cluster_id }}' -- required ; ``` @@ -322,7 +335,10 @@ Update the dynamic cluster-wide broker configuration parameter specified by ``na ```sql REPLACE confluent.kafka.cluster_configs SET -value = '{{ value }}'; +value = '{{ value }}' +WHERE +cluster_id = '{{ cluster_id }}' --required +AND name = '{{ name }}' --required; ``` @@ -335,7 +351,8 @@ SET data = '{{ data }}', validate_only = {{ validate_only }} WHERE -data = '{{ data }}' --required; +cluster_id = '{{ cluster_id }}' --required +AND data = '{{ data }}' --required; ``` @@ -355,6 +372,8 @@ Reset the configuration parameter specified by ``name`` to its
default valu ```sql DELETE FROM confluent.kafka.cluster_configs +WHERE cluster_id = '{{ cluster_id }}' --required +AND name = '{{ name }}' --required ; ``` diff --git a/website/docs/services/kafka/cluster_link_configs/index.md b/website/docs/services/kafka/cluster_link_configs/index.md index c9085cc..9e35eb6 100644 --- a/website/docs/services/kafka/cluster_link_configs/index.md +++ b/website/docs/services/kafka/cluster_link_configs/index.md @@ -201,35 +201,35 @@ The following methods are available for this resource: - + cluster_id, link_name, config_name - + cluster_id, link_name - value + cluster_id, link_name, config_name, value - data + cluster_id, link_name, data validate_only Batch Alter Cluster Link Configs - + cluster_id, link_name, config_name @@ -249,6 +249,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The link config name (example: consumer.offset.sync.enable) + + + + string + The link name (example: link-sb1) + boolean @@ -284,6 +299,9 @@ source, synonyms, value FROM confluent.kafka.cluster_link_configs +WHERE cluster_id = '{{ cluster_id }}' -- required +AND link_name = '{{ link_name }}' -- required +AND config_name = '{{ config_name }}' -- required ; ``` @@ -305,6 +323,8 @@ source, synonyms, value FROM confluent.kafka.cluster_link_configs +WHERE cluster_id = '{{ cluster_id }}' -- required +AND link_name = '{{ link_name }}' -- required ; ``` @@ -329,7 +349,10 @@ REPLACE confluent.kafka.cluster_link_configs SET value = '{{ value }}' WHERE -value = '{{ value }}' --required; +cluster_id = '{{ cluster_id }}' --required +AND link_name = '{{ link_name }}' --required +AND config_name = '{{ config_name }}' --required +AND value = '{{ value }}' --required; ``` @@ -342,7 +365,9 @@ SET data = '{{ data }}', validate_only = {{ validate_only }} WHERE -data = '{{ data }}' --required +cluster_id = '{{ cluster_id }}' --required +AND link_name = '{{ link_name }}' --required +AND data = '{{ data }}' --required AND validate_only = {{ validate_only}}; ``` @@ -363,6 +388,9 @@ AND validate_only = {{ validate_only}}; ```sql DELETE FROM confluent.kafka.cluster_link_configs +WHERE cluster_id = '{{ cluster_id }}' --required +AND link_name = '{{ link_name }}' --required +AND config_name = '{{ config_name }}' --required ; ``` diff --git a/website/docs/services/kafka/cluster_links/index.md b/website/docs/services/kafka/cluster_links/index.md index daa9b0b..10a9bf8 100644 --- a/website/docs/services/kafka/cluster_links/index.md +++ b/website/docs/services/kafka/cluster_links/index.md @@ -231,28 +231,28 @@ The following methods are available for this resource: - + cluster_id, link_name include_tasks ``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead. - + cluster_id ``link_id`` in ``ListLinksResponseData`` is deprecated and may be removed in a future release. Use the new ``cluster_link_id`` instead. - link_name + link_name, cluster_id validate_only, validate_link Cluster link creation requires source cluster security configurations in
the configs JSON section of the data request payload. - + cluster_id, link_name force, validate_only @@ -272,6 +272,11 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + string @@ -330,7 +335,9 @@ metadata, tasks, topic_names FROM confluent.kafka.cluster_links -WHERE include_tasks = '{{ include_tasks }}' +WHERE cluster_id = '{{ cluster_id }}' -- required +AND link_name = '{{ link_name }}' -- required +AND include_tasks = '{{ include_tasks }}' ; ``` @@ -355,6 +362,7 @@ metadata, tasks, topic_names FROM confluent.kafka.cluster_links +WHERE cluster_id = '{{ cluster_id }}' -- required ; ``` @@ -382,6 +390,7 @@ remote_cluster_id, cluster_link_id, configs, link_name, +cluster_id, validate_only, validate_link ) @@ -392,6 +401,7 @@ SELECT '{{ cluster_link_id }}', '{{ configs }}', '{{ link_name }}', +'{{ cluster_id }}', '{{ validate_only }}', '{{ validate_link }}' ; @@ -405,6 +415,9 @@ SELECT - name: link_name value: "{{ link_name }}" description: Required parameter for the cluster_links resource. + - name: cluster_id + value: "{{ cluster_id }}" + description: Required parameter for the cluster_links resource. - name: source_cluster_id value: "{{ source_cluster_id }}" - name: destination_cluster_id @@ -449,7 +462,9 @@ SELECT ```sql DELETE FROM confluent.kafka.cluster_links -WHERE force = '{{ force }}' +WHERE cluster_id = '{{ cluster_id }}' --required +AND link_name = '{{ link_name }}' --required +AND force = '{{ force }}' AND validate_only = '{{ validate_only }}' ; ``` diff --git a/website/docs/services/kafka/clusters/index.md b/website/docs/services/kafka/clusters/index.md index 086d7e6..8c18298 100644 --- a/website/docs/services/kafka/clusters/index.md +++ b/website/docs/services/kafka/clusters/index.md @@ -124,7 +124,7 @@ The following methods are available for this resource: - + cluster_id Return the Kafka cluster with the specified ``cluster_id``. @@ -144,6 +144,11 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + @@ -172,6 +177,7 @@ metadata, partition_reassignments, topics FROM confluent.kafka.clusters +WHERE cluster_id = '{{ cluster_id }}' -- required ; ``` diff --git a/website/docs/services/kafka/consumer_groups/index.md b/website/docs/services/kafka/consumer_groups/index.md index d68f9ef..b5698b9 100644 --- a/website/docs/services/kafka/consumer_groups/index.md +++ b/website/docs/services/kafka/consumer_groups/index.md @@ -211,14 +211,14 @@ The following methods are available for this resource: - + cluster_id, consumer_group_id Return the consumer group specified by the ``consumer_group_id``. - + cluster_id Return the list of consumer groups that belong to the specified
Kafka cluster. @@ -238,6 +238,16 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The consumer group ID. (example: consumer-group-1) + @@ -269,6 +279,8 @@ partition_assignor, state, type FROM confluent.kafka.consumer_groups +WHERE cluster_id = '{{ cluster_id }}' -- required +AND consumer_group_id = '{{ consumer_group_id }}' -- required ; ``` @@ -291,6 +303,7 @@ partition_assignor, state, type FROM confluent.kafka.consumer_groups +WHERE cluster_id = '{{ cluster_id }}' -- required ; ``` diff --git a/website/docs/services/kafka/consumers/index.md b/website/docs/services/kafka/consumers/index.md index 95cd3f4..dbf2045 100644 --- a/website/docs/services/kafka/consumers/index.md +++ b/website/docs/services/kafka/consumers/index.md @@ -171,14 +171,14 @@ The following methods are available for this resource: - + cluster_id, consumer_group_id, consumer_id Return the consumer specified by the ``consumer_id``. - + cluster_id, consumer_group_id Return a list of consumers that belong to the specified consumer
group. @@ -198,6 +198,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The consumer group ID. (example: consumer-group-1) + + + + string + The consumer ID. (example: consumer-1) + @@ -225,6 +240,9 @@ assignments, kind, metadata FROM confluent.kafka.consumers +WHERE cluster_id = '{{ cluster_id }}' -- required +AND consumer_group_id = '{{ consumer_group_id }}' -- required +AND consumer_id = '{{ consumer_id }}' -- required ; ``` @@ -243,6 +261,8 @@ assignments, kind, metadata FROM confluent.kafka.consumers +WHERE cluster_id = '{{ cluster_id }}' -- required +AND consumer_group_id = '{{ consumer_group_id }}' -- required ; ``` diff --git a/website/docs/services/kafka/consumers_lag_summary/index.md b/website/docs/services/kafka/consumers_lag_summary/index.md index 5a66476..f36fa03 100644 --- a/website/docs/services/kafka/consumers_lag_summary/index.md +++ b/website/docs/services/kafka/consumers_lag_summary/index.md @@ -139,7 +139,7 @@ The following methods are available for this resource: - + cluster_id, consumer_group_id Return the maximum and total lag of the consumers belonging to the
specified consumer group. @@ -159,6 +159,16 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The consumer group ID. (example: consumer-group-1) + @@ -190,6 +200,8 @@ max_lag_partition, metadata, total_lag FROM confluent.kafka.consumers_lag_summary +WHERE cluster_id = '{{ cluster_id }}' -- required +AND consumer_group_id = '{{ consumer_group_id }}' -- required ; ``` diff --git a/website/docs/services/kafka/consumers_lags/index.md b/website/docs/services/kafka/consumers_lags/index.md index a136f39..20046f2 100644 --- a/website/docs/services/kafka/consumers_lags/index.md +++ b/website/docs/services/kafka/consumers_lags/index.md @@ -211,14 +211,14 @@ The following methods are available for this resource: - + cluster_id, consumer_group_id, topic_name, partition_id Return the consumer lag on a partition with the given `partition_id`. - + cluster_id, consumer_group_id Return a list of consumer lags of the consumers belonging to the
specified consumer group. @@ -238,6 +238,26 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The consumer group ID. (example: consumer-group-1) + + + + integer + The partition ID. (example: 0) + + + + string + The topic name. (example: topic-1) + @@ -269,6 +289,10 @@ lag, log_end_offset, metadata FROM confluent.kafka.consumers_lags +WHERE cluster_id = '{{ cluster_id }}' -- required +AND consumer_group_id = '{{ consumer_group_id }}' -- required +AND topic_name = '{{ topic_name }}' -- required +AND partition_id = '{{ partition_id }}' -- required ; ``` @@ -291,6 +315,8 @@ lag, log_end_offset, metadata FROM confluent.kafka.consumers_lags +WHERE cluster_id = '{{ cluster_id }}' -- required +AND consumer_group_id = '{{ consumer_group_id }}' -- required ; ``` diff --git a/website/docs/services/kafka/default_topic_configs/index.md b/website/docs/services/kafka/default_topic_configs/index.md index e78133a..dfc0d32 100644 --- a/website/docs/services/kafka/default_topic_configs/index.md +++ b/website/docs/services/kafka/default_topic_configs/index.md @@ -129,7 +129,7 @@ The following methods are available for this resource: - + cluster_id, topic_name List the default configuration parameters used if the topic were to be newly created. @@ -149,6 +149,16 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The topic name. (example: topic-1) + @@ -178,6 +188,8 @@ source, synonyms, value FROM confluent.kafka.default_topic_configs +WHERE cluster_id = '{{ cluster_id }}' -- required +AND topic_name = '{{ topic_name }}' -- required ; ``` diff --git a/website/docs/services/kafka/group_configs/index.md b/website/docs/services/kafka/group_configs/index.md index b175a76..05347f1 100644 --- a/website/docs/services/kafka/group_configs/index.md +++ b/website/docs/services/kafka/group_configs/index.md @@ -201,35 +201,35 @@ The following methods are available for this resource: - + cluster_id, group_id, name Get the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups. - + cluster_id, group_id List all configurations for the specified group. This API supports consumer groups, share groups, and streams groups. - value + cluster_id, group_id, name, value Update the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups. - + cluster_id, group_id, name 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. - data + cluster_id, group_id, data validate_only Batch alter configurations for the specified group. This API supports consumer groups, share groups, and streams groups. @@ -249,6 +249,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The group ID. (example: group-1) + + + + string + The configuration parameter name. (example: compression.type) + boolean @@ -284,6 +299,9 @@ source, synonyms, value FROM confluent.kafka.group_configs +WHERE cluster_id = '{{ cluster_id }}' -- required +AND group_id = '{{ group_id }}' -- required +AND name = '{{ name }}' -- required ; ``` @@ -305,6 +323,8 @@ source, synonyms, value FROM confluent.kafka.group_configs +WHERE cluster_id = '{{ cluster_id }}' -- required +AND group_id = '{{ group_id }}' -- required ; ``` @@ -328,7 +348,10 @@ REPLACE confluent.kafka.group_configs SET value = '{{ value }}' WHERE -value = '{{ value }}' --required; +cluster_id = '{{ cluster_id }}' --required +AND group_id = '{{ group_id }}' --required +AND name = '{{ name }}' --required +AND value = '{{ value }}' --required; ``` @@ -348,6 +371,9 @@ Delete the dynamic configuration override with the specified name for the specif ```sql DELETE FROM confluent.kafka.group_configs +WHERE cluster_id = '{{ cluster_id }}' --required +AND group_id = '{{ group_id }}' --required +AND name = '{{ name }}' --required ; ``` @@ -368,6 +394,8 @@ Batch alter configurations for the specified group. This API supports consumer g ```sql EXEC confluent.kafka.group_configs.update_kafka_group_config_batch +@cluster_id='{{ cluster_id }}' --required, +@group_id='{{ group_id }}' --required, @validate_only={{ validate_only }} @@json= '{ diff --git a/website/docs/services/kafka/mirror_topics/index.md b/website/docs/services/kafka/mirror_topics/index.md index 6e42845..3335832 100644 --- a/website/docs/services/kafka/mirror_topics/index.md +++ b/website/docs/services/kafka/mirror_topics/index.md @@ -273,78 +273,78 @@ The following methods are available for this resource: - + cluster_id, link_name, mirror_topic_name include_state_transition_errors - + cluster_id, link_name mirror_status List all mirror topics under the link - + cluster_id mirror_status List all mirror topics in the cluster - source_topic_name + cluster_id, link_name, source_topic_name Create a topic in the destination cluster mirroring a topic in
the source cluster - - + cluster_id, link_name + validate_only - - + cluster_id, link_name + validate_only - - + cluster_id, link_name + validate_only - - + cluster_id, link_name + validate_only - - + cluster_id, link_name + validate_only - - + cluster_id, link_name + validate_only - - + cluster_id, link_name + include_partition_level_truncation_data, validate_only @@ -363,6 +363,26 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The link name (example: link-sb1) + + + + string + Cluster Linking mirror topic name (example: topic-1) + + + + boolean + Whether to include partition level truncation information when truncating and restoring a topic in the response. Default: false (example: false) + boolean @@ -373,6 +393,11 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# string The status of the mirror topic. If not specified, all mirror topics will be returned. (example: ACTIVE) + + + boolean + To validate the action can be performed successfully or not. Default: false (example: false) + @@ -404,7 +429,10 @@ mirror_topic_error, num_partitions, state_time_ms FROM confluent.kafka.mirror_topics -WHERE include_state_transition_errors = '{{ include_state_transition_errors }}' +WHERE cluster_id = '{{ cluster_id }}' -- required +AND link_name = '{{ link_name }}' -- required +AND mirror_topic_name = '{{ mirror_topic_name }}' -- required +AND include_state_transition_errors = '{{ include_state_transition_errors }}' ; ``` @@ -426,7 +454,9 @@ mirror_topic_error, num_partitions, state_time_ms FROM confluent.kafka.mirror_topics -WHERE mirror_status = '{{ mirror_status }}' +WHERE cluster_id = '{{ cluster_id }}' -- required +AND link_name = '{{ link_name }}' -- required +AND mirror_status = '{{ mirror_status }}' ; ``` @@ -448,7 +478,8 @@ mirror_topic_error, num_partitions, state_time_ms FROM confluent.kafka.mirror_topics -WHERE mirror_status = '{{ mirror_status }}' +WHERE cluster_id = '{{ cluster_id }}' -- required +AND mirror_status = '{{ mirror_status }}' ; ``` @@ -473,13 +504,17 @@ INSERT INTO confluent.kafka.mirror_topics ( source_topic_name, mirror_topic_name, replication_factor, -configs +configs, +cluster_id, +link_name ) SELECT '{{ source_topic_name }}' /* required */, '{{ mirror_topic_name }}', {{ replication_factor }}, -'{{ configs }}' +'{{ configs }}', +'{{ cluster_id }}', +'{{ link_name }}' ; ``` @@ -488,6 +523,12 @@ SELECT {`# Description fields are for documentation purposes - name: mirror_topics props: + - name: cluster_id + value: "{{ cluster_id }}" + description: Required parameter for the mirror_topics resource. + - name: link_name + value: "{{ link_name }}" + description: Required parameter for the mirror_topics resource. - name: source_topic_name value: "{{ source_topic_name }}" - name: mirror_topic_name @@ -524,6 +565,9 @@ SELECT ```sql EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_promote +@cluster_id='{{ cluster_id }}' --required, +@link_name='{{ link_name }}' --required, +@validate_only={{ validate_only }} @@json= '{ "mirror_topic_names": "{{ mirror_topic_names }}", @@ -538,6 +582,9 @@ EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_promote ```sql EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_failover +@cluster_id='{{ cluster_id }}' --required, +@link_name='{{ link_name }}' --required, +@validate_only={{ validate_only }} @@json= '{ "mirror_topic_names": "{{ mirror_topic_names }}", @@ -552,6 +599,9 @@ EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_failover ```sql EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_pause +@cluster_id='{{ cluster_id }}' --required, +@link_name='{{ link_name }}' --required, +@validate_only={{ validate_only }} @@json= '{ "mirror_topic_names": "{{ mirror_topic_names }}", @@ -566,6 +616,9 @@ EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_pause ```sql EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_resume +@cluster_id='{{ cluster_id }}' --required, +@link_name='{{ link_name }}' --required, +@validate_only={{ validate_only }} @@json= '{ "mirror_topic_names": "{{ mirror_topic_names }}", @@ -580,6 +633,9 @@ EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_resume ```sql EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_reverse_and_start_mirror +@cluster_id='{{ cluster_id }}' --required, +@link_name='{{ link_name }}' --required, +@validate_only={{ validate_only }} @@json= '{ "mirror_topic_names": "{{ mirror_topic_names }}", @@ -594,6 +650,9 @@ EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_reverse_and_start_ ```sql EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_reverse_and_pause_mirror +@cluster_id='{{ cluster_id }}' --required, +@link_name='{{ link_name }}' --required, +@validate_only={{ validate_only }} @@json= '{ "mirror_topic_names": "{{ mirror_topic_names }}", @@ -608,6 +667,10 @@ EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_reverse_and_pause_ ```sql EXEC confluent.kafka.mirror_topics.update_kafka_mirror_topics_truncate_and_restore_mirror +@cluster_id='{{ cluster_id }}' --required, +@link_name='{{ link_name }}' --required, +@include_partition_level_truncation_data={{ include_partition_level_truncation_data }}, +@validate_only={{ validate_only }} @@json= '{ "mirror_topic_names": "{{ mirror_topic_names }}", diff --git a/website/docs/services/kafka/records/index.md b/website/docs/services/kafka/records/index.md index 5a16027..0bcac54 100644 --- a/website/docs/services/kafka/records/index.md +++ b/website/docs/services/kafka/records/index.md @@ -53,7 +53,7 @@ The following methods are available for this resource: - + cluster_id, topic_name 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.

This API currently does not support Schema Registry integration. Sending
schemas is not supported. Only BINARY, JSON, and STRING formats are
supported. @@ -73,6 +73,16 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The topic name. (example: topic-1) + @@ -95,14 +105,18 @@ partition_id, headers, key, value, -timestamp +timestamp, +cluster_id, +topic_name ) SELECT {{ partition_id }}, '{{ headers }}', '{{ key }}', '{{ value }}', -'{{ timestamp }}' +'{{ timestamp }}', +'{{ cluster_id }}', +'{{ topic_name }}' RETURNING cluster_id, partition_id, @@ -121,6 +135,12 @@ value {`# Description fields are for documentation purposes - name: records props: + - name: cluster_id + value: "{{ cluster_id }}" + description: Required parameter for the records resource. + - name: topic_name + value: "{{ topic_name }}" + description: Required parameter for the records resource. - name: partition_id value: {{ partition_id }} - name: headers diff --git a/website/docs/services/kafka/topic_configs/index.md b/website/docs/services/kafka/topic_configs/index.md index b849c7a..391676e 100644 --- a/website/docs/services/kafka/topic_configs/index.md +++ b/website/docs/services/kafka/topic_configs/index.md @@ -273,42 +273,42 @@ The following methods are available for this resource: - + cluster_id, topic_name, name Return the configuration parameter with the given `name`. - + cluster_id, topic_name Return the list of configuration parameters that belong to the specified topic. - + cluster_id Return the list of configuration parameters for all topics hosted by the specified
cluster. - + cluster_id, topic_name, name 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. - data + cluster_id, topic_name, data 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. - + cluster_id, topic_name, name Reset the configuration parameter with given `name` to its default value. @@ -328,6 +328,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The configuration parameter name. (example: compression.type) + + + + string + The topic name. (example: topic-1) + @@ -359,6 +374,9 @@ source, synonyms, value FROM confluent.kafka.topic_configs +WHERE cluster_id = '{{ cluster_id }}' -- required +AND topic_name = '{{ topic_name }}' -- required +AND name = '{{ name }}' -- required ; ``` @@ -380,6 +398,8 @@ source, synonyms, value FROM confluent.kafka.topic_configs +WHERE cluster_id = '{{ cluster_id }}' -- required +AND topic_name = '{{ topic_name }}' -- required ; ``` @@ -401,6 +421,7 @@ source, synonyms, value FROM confluent.kafka.topic_configs +WHERE cluster_id = '{{ cluster_id }}' -- required ; ``` @@ -423,7 +444,11 @@ Update the configuration parameter with given `name`. To update the
number ```sql REPLACE confluent.kafka.topic_configs SET -value = '{{ value }}'; +value = '{{ value }}' +WHERE +cluster_id = '{{ cluster_id }}' --required +AND topic_name = '{{ topic_name }}' --required +AND name = '{{ name }}' --required; ``` @@ -436,7 +461,9 @@ SET data = '{{ data }}', validate_only = {{ validate_only }} WHERE -data = '{{ data }}' --required; +cluster_id = '{{ cluster_id }}' --required +AND topic_name = '{{ topic_name }}' --required +AND data = '{{ data }}' --required; ``` @@ -456,6 +483,9 @@ Reset the configuration parameter with given `name` to its default value. ```sql DELETE FROM confluent.kafka.topic_configs +WHERE cluster_id = '{{ cluster_id }}' --required +AND topic_name = '{{ topic_name }}' --required +AND name = '{{ name }}' --required ; ``` diff --git a/website/docs/services/kafka/topic_partitions/index.md b/website/docs/services/kafka/topic_partitions/index.md index 87e2a68..b9f3f70 100644 --- a/website/docs/services/kafka/topic_partitions/index.md +++ b/website/docs/services/kafka/topic_partitions/index.md @@ -171,14 +171,14 @@ The following methods are available for this resource: - + cluster_id, topic_name, partition_id Return the partition with the given `partition_id`. - + cluster_id, topic_name Return the list of partitions that belong to the specified topic. @@ -198,6 +198,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + integer + The partition ID. (example: 0) + + + + string + The topic name. (example: topic-1) + @@ -225,6 +240,9 @@ metadata, reassignment, replicas FROM confluent.kafka.topic_partitions +WHERE cluster_id = '{{ cluster_id }}' -- required +AND topic_name = '{{ topic_name }}' -- required +AND partition_id = '{{ partition_id }}' -- required ; ``` @@ -243,6 +261,8 @@ metadata, reassignment, replicas FROM confluent.kafka.topic_partitions +WHERE cluster_id = '{{ cluster_id }}' -- required +AND topic_name = '{{ topic_name }}' -- required ; ``` diff --git a/website/docs/services/kafka/topics/index.md b/website/docs/services/kafka/topics/index.md index 681b872..6b791d3 100644 --- a/website/docs/services/kafka/topics/index.md +++ b/website/docs/services/kafka/topics/index.md @@ -201,35 +201,35 @@ The following methods are available for this resource: - + cluster_id, topic_name include_authorized_operations Return the topic with the given `topic_name`. - + cluster_id Return the list of topics that belong to the specified Kafka cluster. - topic_name + cluster_id, topic_name 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. - partitions_count + cluster_id, topic_name, partitions_count 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. - + cluster_id, topic_name Delete the topic with the given `topic_name`. @@ -249,6 +249,16 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The topic name. (example: topic-1) + boolean @@ -284,7 +294,9 @@ partitions, partitions_count, replication_factor FROM confluent.kafka.topics -WHERE include_authorized_operations = '{{ include_authorized_operations }}' +WHERE cluster_id = '{{ cluster_id }}' -- required +AND topic_name = '{{ topic_name }}' -- required +AND include_authorized_operations = '{{ include_authorized_operations }}' ; ``` @@ -306,6 +318,7 @@ partitions, partitions_count, replication_factor FROM confluent.kafka.topics +WHERE cluster_id = '{{ cluster_id }}' -- required ; ``` @@ -331,14 +344,16 @@ topic_name, partitions_count, replication_factor, configs, -validate_only +validate_only, +cluster_id ) SELECT '{{ topic_name }}' /* required */, {{ partitions_count }}, {{ replication_factor }}, '{{ configs }}', -{{ validate_only }} +{{ validate_only }}, +'{{ cluster_id }}' RETURNING cluster_id, topic_name, @@ -359,6 +374,9 @@ replication_factor {`# Description fields are for documentation purposes - name: topics props: + - name: cluster_id + value: "{{ cluster_id }}" + description: Required parameter for the topics resource. - name: topic_name value: "{{ topic_name }}" - name: partitions_count @@ -394,7 +412,9 @@ UPDATE confluent.kafka.topics SET partitions_count = {{ partitions_count }} WHERE -partitions_count = '{{ partitions_count }}' --required +cluster_id = '{{ cluster_id }}' --required +AND topic_name = '{{ topic_name }}' --required +AND partitions_count = '{{ partitions_count }}' --required RETURNING cluster_id, topic_name, @@ -426,6 +446,8 @@ Delete the topic with the given `topic_name`. ```sql DELETE FROM confluent.kafka.topics +WHERE cluster_id = '{{ cluster_id }}' --required +AND topic_name = '{{ topic_name }}' --required ; ``` diff --git a/website/docs/services/managed_kafka_clusters/index.md b/website/docs/services/managed_kafka_clusters/index.md index 6582c2d..bc7c76e 100644 --- a/website/docs/services/managed_kafka_clusters/index.md +++ b/website/docs/services/managed_kafka_clusters/index.md @@ -18,7 +18,7 @@ managed_kafka_clusters service documentation. :::info[Service Summary] -total resources: __1__ +total resources: __2__ ::: @@ -28,6 +28,6 @@ total resources: __1__ clusters
- +vw_clusters
\ No newline at end of file diff --git a/website/docs/services/managed_kafka_clusters/vw_clusters/index.md b/website/docs/services/managed_kafka_clusters/vw_clusters/index.md new file mode 100644 index 0000000..ec126f5 --- /dev/null +++ b/website/docs/services/managed_kafka_clusters/vw_clusters/index.md @@ -0,0 +1,263 @@ +--- +title: vw_clusters +hide_title: false +hide_table_of_contents: false +keywords: + - vw_clusters + - managed_kafka_clusters + - confluent + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage confluent resources using SQL +custom_edit_url: null +image: /img/stackql-confluent-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a vw_clusters resource. + +## Overview + + + + +
Name
TypeView
Id
+ +## Fields + +The following fields are returned by this view: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
Environment ID used to scope the cluster list (required `WHERE` parameter; echoed back as a column).
Cluster ID (e.g. lkc-50r5wn).
Object kind (always `Cluster`).
Confluent API version (e.g. `cmk/v2`).
Human-readable cluster name.
Cluster availability tier (e.g. LOW, HIGH).
Cloud provider (AWS, GCP, AZURE).
Cloud region the cluster runs in.
Cluster sizing kind (Basic, Standard, Enterprise, Dedicated, Freight).
Maximum eCKU count for elastic clusters.
Cluster REST API endpoint URL.
Cluster HTTP endpoint URL.
Kafka bootstrap endpoint URL (SASL_SSL://...).
ID of the environment that owns this cluster.
Confluent Resource Name (CRN) of the owning environment.
Cluster lifecycle phase (e.g. PROVISIONED).
Timestamp when the cluster was created (ISO 8601).
Timestamp when the cluster was last updated (ISO 8601).
Confluent Resource Name (CRN) for this cluster.
Self-link URL for this cluster.
+ +## Required Parameters + +The following parameters are required by this view: + + + + + + + + + + + + + + + + +
NameDatatypeDescription
Environment ID used to scope the cluster list.
+ +## `SELECT` Examples + +```sql +SELECT + environment, + id, + kind, + api_version, + display_name, + availability, + cloud, + region, + config_kind, + max_ecku, + api_endpoint, + http_endpoint, + kafka_bootstrap_endpoint, + environment_id, + environment_resource_name, + phase, + created_at, + updated_at, + resource_name, + self +FROM confluent.managed_kafka_clusters.vw_clusters +WHERE environment = '{{ environment }}'; +``` + +## SQL Definition + + + + +```sql +SELECT + id, + kind, + api_version, + environment, + JSON_EXTRACT(spec, '$.display_name') AS display_name, + JSON_EXTRACT(spec, '$.availability') AS availability, + JSON_EXTRACT(spec, '$.cloud') AS cloud, + JSON_EXTRACT(spec, '$.region') AS region, + JSON_EXTRACT(spec, '$.config.kind') AS config_kind, + JSON_EXTRACT(spec, '$.config.max_ecku') AS max_ecku, + JSON_EXTRACT(spec, '$.api_endpoint') AS api_endpoint, + JSON_EXTRACT(spec, '$.http_endpoint') AS http_endpoint, + JSON_EXTRACT(spec, '$.kafka_bootstrap_endpoint') AS kafka_bootstrap_endpoint, + JSON_EXTRACT(spec, '$.environment.id') AS environment_id, + JSON_EXTRACT(spec, '$.environment.resource_name') AS environment_resource_name, + JSON_EXTRACT(status, '$.phase') AS phase, + JSON_EXTRACT(metadata, '$.created_at') AS created_at, + JSON_EXTRACT(metadata, '$.updated_at') AS updated_at, + JSON_EXTRACT(metadata, '$.resource_name') AS resource_name, + JSON_EXTRACT(metadata, '$.self') AS self +FROM confluent.managed_kafka_clusters.clusters +WHERE environment = '{{ environment }}' +``` + + + + +```sql +SELECT + id, + kind, + api_version, + environment, + spec->>'display_name' AS display_name, + spec->>'availability' AS availability, + spec->>'cloud' AS cloud, + spec->>'region' AS region, + spec->'config'->>'kind' AS config_kind, + (spec->'config'->>'max_ecku')::integer AS max_ecku, + spec->>'api_endpoint' AS api_endpoint, + spec->>'http_endpoint' AS http_endpoint, + spec->>'kafka_bootstrap_endpoint' AS kafka_bootstrap_endpoint, + spec->'environment'->>'id' AS environment_id, + spec->'environment'->>'resource_name' AS environment_resource_name, + status->>'phase' AS phase, + metadata->>'created_at' AS created_at, + metadata->>'updated_at' AS updated_at, + metadata->>'resource_name' AS resource_name, + metadata->>'self' AS self +FROM confluent.managed_kafka_clusters.clusters +WHERE environment = '{{ environment }}' +``` + + + diff --git a/website/docs/services/share_group/consumer_assignments/index.md b/website/docs/services/share_group/consumer_assignments/index.md index f05087a..6c80e4d 100644 --- a/website/docs/services/share_group/consumer_assignments/index.md +++ b/website/docs/services/share_group/consumer_assignments/index.md @@ -114,7 +114,7 @@ The following methods are available for this resource: - + cluster_id, group_id, consumer_id Return the consumer assignments specified by the ``consumer_id``. @@ -134,6 +134,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The consumer ID. (example: consumer-1) + + + + string + The group ID. (example: group-1) + @@ -160,6 +175,9 @@ kind, metadata, partition FROM confluent.share_group.consumer_assignments +WHERE cluster_id = '{{ cluster_id }}' -- required +AND group_id = '{{ group_id }}' -- required +AND consumer_id = '{{ consumer_id }}' -- required ; ``` diff --git a/website/docs/services/share_group/consumers/index.md b/website/docs/services/share_group/consumers/index.md index d402590..5d90e42 100644 --- a/website/docs/services/share_group/consumers/index.md +++ b/website/docs/services/share_group/consumers/index.md @@ -161,14 +161,14 @@ The following methods are available for this resource: - + cluster_id, group_id, consumer_id Return the consumer specified by the ``consumer_id``. - + cluster_id, group_id Return a list of consumers that belong to the specified share
group. @@ -188,6 +188,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The consumer ID. (example: consumer-1) + + + + string + The group ID. (example: group-1) + @@ -214,6 +229,9 @@ assignments, kind, metadata FROM confluent.share_group.consumers +WHERE cluster_id = '{{ cluster_id }}' -- required +AND group_id = '{{ group_id }}' -- required +AND consumer_id = '{{ consumer_id }}' -- required ; ``` @@ -231,6 +249,8 @@ assignments, kind, metadata FROM confluent.share_group.consumers +WHERE cluster_id = '{{ cluster_id }}' -- required +AND group_id = '{{ group_id }}' -- required ; ``` diff --git a/website/docs/services/share_group/share_groups/index.md b/website/docs/services/share_group/share_groups/index.md index 86b073e..3ba6f0a 100644 --- a/website/docs/services/share_group/share_groups/index.md +++ b/website/docs/services/share_group/share_groups/index.md @@ -191,21 +191,21 @@ The following methods are available for this resource: - + cluster_id, group_id Return the share group specified by the ``group_id``. - + cluster_id Return the list of share groups that belong to the specified
Kafka cluster. - + cluster_id, group_id Delete the share group specified by the ``group_id``. @@ -225,6 +225,16 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The group ID. (example: group-1) + @@ -254,6 +264,8 @@ metadata, partition_count, state FROM confluent.share_group.share_groups +WHERE cluster_id = '{{ cluster_id }}' -- required +AND group_id = '{{ group_id }}' -- required ; ``` @@ -274,6 +286,7 @@ metadata, partition_count, state FROM confluent.share_group.share_groups +WHERE cluster_id = '{{ cluster_id }}' -- required ; ``` @@ -294,6 +307,8 @@ Delete the share group specified by the ``group_id``. ```sql DELETE FROM confluent.share_group.share_groups +WHERE cluster_id = '{{ cluster_id }}' --required +AND group_id = '{{ group_id }}' --required ; ``` diff --git a/website/docs/services/streams_group/member_assignment_task_partitions/index.md b/website/docs/services/streams_group/member_assignment_task_partitions/index.md index d051c1b..e2562cf 100644 --- a/website/docs/services/streams_group/member_assignment_task_partitions/index.md +++ b/website/docs/services/streams_group/member_assignment_task_partitions/index.md @@ -94,7 +94,7 @@ The following methods are available for this resource: - + cluster_id, group_id, member_id, assignments_type, subtopology_id Return the tasks of the member specified by the ``member_id``, and the type ``assignments_type``. @@ -114,6 +114,31 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The streams member Assignment type. (example: active) + + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The group ID. (example: group-1) + + + + string + The streams member ID. (example: member-1) + + + + string + The streams subtopology ID. (example: subtopology-1) + @@ -136,6 +161,11 @@ kind, metadata, partition_ids FROM confluent.streams_group.member_assignment_task_partitions +WHERE cluster_id = '{{ cluster_id }}' -- required +AND group_id = '{{ group_id }}' -- required +AND member_id = '{{ member_id }}' -- required +AND assignments_type = '{{ assignments_type }}' -- required +AND subtopology_id = '{{ subtopology_id }}' -- required ; ``` diff --git a/website/docs/services/streams_group/member_assignment_tasks/index.md b/website/docs/services/streams_group/member_assignment_tasks/index.md index c66d0fe..21f1981 100644 --- a/website/docs/services/streams_group/member_assignment_tasks/index.md +++ b/website/docs/services/streams_group/member_assignment_tasks/index.md @@ -94,7 +94,7 @@ The following methods are available for this resource: - + cluster_id, group_id, member_id, assignments_type Return the tasks of the member specified by the ``member_id``, and the type ``assignments_type``. @@ -114,6 +114,26 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The streams member Assignment type. (example: active) + + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The group ID. (example: group-1) + + + + string + The streams member ID. (example: member-1) + @@ -136,6 +156,10 @@ kind, metadata, partition_ids FROM confluent.streams_group.member_assignment_tasks +WHERE cluster_id = '{{ cluster_id }}' -- required +AND group_id = '{{ group_id }}' -- required +AND member_id = '{{ member_id }}' -- required +AND assignments_type = '{{ assignments_type }}' -- required ; ``` diff --git a/website/docs/services/streams_group/member_assignments/index.md b/website/docs/services/streams_group/member_assignments/index.md index 9bf1305..83857f6 100644 --- a/website/docs/services/streams_group/member_assignments/index.md +++ b/website/docs/services/streams_group/member_assignments/index.md @@ -114,7 +114,7 @@ The following methods are available for this resource: - + cluster_id, group_id, member_id Return the assignments of the member specified by the ``member_id``. @@ -134,6 +134,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The group ID. (example: group-1) + + + + string + The streams member ID. (example: member-1) + @@ -160,6 +175,9 @@ metadata, standby_tasks, warmup_tasks FROM confluent.streams_group.member_assignments +WHERE cluster_id = '{{ cluster_id }}' -- required +AND group_id = '{{ group_id }}' -- required +AND member_id = '{{ member_id }}' -- required ; ``` diff --git a/website/docs/services/streams_group/member_target_assignment_task_partitions/index.md b/website/docs/services/streams_group/member_target_assignment_task_partitions/index.md index 2a44783..e7c346a 100644 --- a/website/docs/services/streams_group/member_target_assignment_task_partitions/index.md +++ b/website/docs/services/streams_group/member_target_assignment_task_partitions/index.md @@ -94,7 +94,7 @@ The following methods are available for this resource: - + cluster_id, group_id, member_id, assignments_type, subtopology_id Return the tasks of the member specified by the ``member_id``, and the type ``assignments_type``. @@ -114,6 +114,31 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The streams member Assignment type. (example: active) + + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The group ID. (example: group-1) + + + + string + The streams member ID. (example: member-1) + + + + string + The streams subtopology ID. (example: subtopology-1) + @@ -136,6 +161,11 @@ kind, metadata, partition_ids FROM confluent.streams_group.member_target_assignment_task_partitions +WHERE cluster_id = '{{ cluster_id }}' -- required +AND group_id = '{{ group_id }}' -- required +AND member_id = '{{ member_id }}' -- required +AND assignments_type = '{{ assignments_type }}' -- required +AND subtopology_id = '{{ subtopology_id }}' -- required ; ``` diff --git a/website/docs/services/streams_group/member_target_assignment_tasks/index.md b/website/docs/services/streams_group/member_target_assignment_tasks/index.md index b3d87da..4bdd430 100644 --- a/website/docs/services/streams_group/member_target_assignment_tasks/index.md +++ b/website/docs/services/streams_group/member_target_assignment_tasks/index.md @@ -94,7 +94,7 @@ The following methods are available for this resource: - + cluster_id, group_id, member_id, assignments_type Return the target tasks of the member specified by the ``member_id``, and the type ``assignments_type``. @@ -114,6 +114,26 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The streams member Assignment type. (example: active) + + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The group ID. (example: group-1) + + + + string + The streams member ID. (example: member-1) + @@ -136,6 +156,10 @@ kind, metadata, partition_ids FROM confluent.streams_group.member_target_assignment_tasks +WHERE cluster_id = '{{ cluster_id }}' -- required +AND group_id = '{{ group_id }}' -- required +AND member_id = '{{ member_id }}' -- required +AND assignments_type = '{{ assignments_type }}' -- required ; ``` diff --git a/website/docs/services/streams_group/member_target_assignments/index.md b/website/docs/services/streams_group/member_target_assignments/index.md index c528d1b..19b2ec0 100644 --- a/website/docs/services/streams_group/member_target_assignments/index.md +++ b/website/docs/services/streams_group/member_target_assignments/index.md @@ -114,7 +114,7 @@ The following methods are available for this resource: - + cluster_id, group_id, member_id Return the target assignments of the member specified by the ``member_id``. @@ -134,6 +134,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The group ID. (example: group-1) + + + + string + The streams member ID. (example: member-1) + @@ -160,6 +175,9 @@ metadata, standby_tasks, warmup_tasks FROM confluent.streams_group.member_target_assignments +WHERE cluster_id = '{{ cluster_id }}' -- required +AND group_id = '{{ group_id }}' -- required +AND member_id = '{{ member_id }}' -- required ; ``` diff --git a/website/docs/services/streams_group/members/index.md b/website/docs/services/streams_group/members/index.md index d51195e..ce4e9fd 100644 --- a/website/docs/services/streams_group/members/index.md +++ b/website/docs/services/streams_group/members/index.md @@ -221,14 +221,14 @@ The following methods are available for this resource: - + cluster_id, group_id, member_id Return the members specified by the ``member_id``. - + cluster_id, group_id Return a list of members that belong to the specified streams group. @@ -248,6 +248,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The group ID. (example: group-1) + + + + string + The streams member ID. (example: member-1) + @@ -280,6 +295,9 @@ metadata, target_assignment, topology_epoch FROM confluent.streams_group.members +WHERE cluster_id = '{{ cluster_id }}' -- required +AND group_id = '{{ group_id }}' -- required +AND member_id = '{{ member_id }}' -- required ; ``` @@ -303,6 +321,8 @@ metadata, target_assignment, topology_epoch FROM confluent.streams_group.members +WHERE cluster_id = '{{ cluster_id }}' -- required +AND group_id = '{{ group_id }}' -- required ; ``` diff --git a/website/docs/services/streams_group/streams_groups/index.md b/website/docs/services/streams_group/streams_groups/index.md index 39b8d5c..39cf4f8 100644 --- a/website/docs/services/streams_group/streams_groups/index.md +++ b/website/docs/services/streams_group/streams_groups/index.md @@ -211,14 +211,14 @@ The following methods are available for this resource: - + cluster_id, group_id Return the streams group specified by the ``group_id``. - + cluster_id Return the list of streams groups that belong to the specified Kafka cluster @@ -238,6 +238,16 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The group ID. (example: group-1) + @@ -269,6 +279,8 @@ subtopology_count, target_assignment_epoch, topology_epoch FROM confluent.streams_group.streams_groups +WHERE cluster_id = '{{ cluster_id }}' -- required +AND group_id = '{{ group_id }}' -- required ; ``` @@ -291,6 +303,7 @@ subtopology_count, target_assignment_epoch, topology_epoch FROM confluent.streams_group.streams_groups +WHERE cluster_id = '{{ cluster_id }}' -- required ; ``` diff --git a/website/docs/services/streams_group/subtopologies/index.md b/website/docs/services/streams_group/subtopologies/index.md index b0ffa7a..489e361 100644 --- a/website/docs/services/streams_group/subtopologies/index.md +++ b/website/docs/services/streams_group/subtopologies/index.md @@ -151,14 +151,14 @@ The following methods are available for this resource: - + cluster_id, group_id, subtopology_id Return the subtopology specified by the ``subtopology_id``. - + cluster_id, group_id Return a list of subtopologies that belong to the specified streams group. @@ -178,6 +178,21 @@ Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](# + + + string + The Kafka cluster ID. (example: cluster-1) + + + + string + The group ID. (example: group-1) + + + + string + The streams subtopology ID. (example: subtopology-1) + @@ -203,6 +218,9 @@ kind, metadata, source_topics FROM confluent.streams_group.subtopologies +WHERE cluster_id = '{{ cluster_id }}' -- required +AND group_id = '{{ group_id }}' -- required +AND subtopology_id = '{{ subtopology_id }}' -- required ; ``` @@ -219,6 +237,8 @@ kind, metadata, source_topics FROM confluent.streams_group.subtopologies +WHERE cluster_id = '{{ cluster_id }}' -- required +AND group_id = '{{ group_id }}' -- required ; ```