Merge pull request #206 from stackql/feature/doc-updates

updated confluent

Author: jeffreyaven

docs/confluent-docs/index.md

@@ -19,16 +19,16 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
 
 Confluent Cloud for managing Kafka clusters, topics, and streaming services in a scalable cloud environment.  
 
-:::info Provider Summary (v24.11.00270)
+:::info Provider Summary (v24.11.00272)
 
 <div class="row">
 <div class="providerDocColumn">
 <span>total services:&nbsp;<b>22</b></span><br />
 <span>total methods:&nbsp;<b>391</b></span><br />
 </div>
 <div class="providerDocColumn">
-<span>total resources:&nbsp;<b>111</b></span><br />
-<span>total selectable resources:&nbsp;<b>81</b></span><br />
+<span>total resources:&nbsp;<b>113</b></span><br />
+<span>total selectable resources:&nbsp;<b>104</b></span><br />
 </div>
 </div>
 

docs/confluent-docs/providers/confluent/billing/index.md

@@ -34,7 +34,7 @@ Billing
 <tr><td><b>Type</b></td><td>Service</td></tr>
 <tr><td><b>Title</b></td><td>Confluent Cloud APIs - Billing</td></tr>
 <tr><td><b>Description</b></td><td>Billing</td></tr>
-<tr><td><b>Id</b></td><td><code>billing:v24.10.00268</code></td></tr>
+<tr><td><b>Id</b></td><td><code>billing:v24.11.00272</code></td></tr>
 </tbody></table>
 
 ## Resources

docs/confluent-docs/providers/confluent/catalog/index.md

@@ -34,7 +34,7 @@ Catalog
 <tr><td><b>Type</b></td><td>Service</td></tr>
 <tr><td><b>Title</b></td><td>Confluent Cloud APIs - Catalog</td></tr>
 <tr><td><b>Description</b></td><td>Catalog</td></tr>
-<tr><td><b>Id</b></td><td><code>catalog:v24.10.00268</code></td></tr>
+<tr><td><b>Id</b></td><td><code>catalog:v24.11.00272</code></td></tr>
 </tbody></table>
 
 ## Resources

docs/confluent-docs/providers/confluent/connect/connector_config/index.md

@@ -28,9 +28,18 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
 </tbody></table>
 
 ## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command  
+| Name | Datatype | Description |
+|:-----|:---------|:------------|
+| <CopyableCode code="name" /> | `string` | Name or alias of the class (plugin) for this connector. For Custom Connector, it must be the same as connector_name. |
+| <CopyableCode code="cloud.environment" /> | `string` | The cloud environment type. |
+| <CopyableCode code="cloud.provider" /> | `string` | The cloud service provider, e.g. aws, azure, etc. |
+| <CopyableCode code="connector.class" /> | `string` | The connector class name. E.g. BigQuerySink, GcsSink, etc. |
+| <CopyableCode code="kafka.api.key" /> | `string` | The kafka cluster api key. |
+| <CopyableCode code="kafka.api.secret" /> | `string` | The kafka cluster api secret key. |
+| <CopyableCode code="kafka.endpoint" /> | `string` | The kafka cluster endpoint. |
+| <CopyableCode code="kafka.region" /> | `string` | The kafka cluster region. |
 ## Methods
 | Name | Accessible by | Required Params | Description |
 |:-----|:--------------|:----------------|:------------|
+| <CopyableCode code="get_connectv1connector_config" /> | `SELECT` | <CopyableCode code="connector_name, environment_id, kafka_cluster_id" /> | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />Get the configuration for the connector. |
 | <CopyableCode code="create_or_update_connectv1connector_config" /> | `INSERT` | <CopyableCode code="connector_name, environment_id, kafka_cluster_id, data__connector.class, data__kafka.api.key, data__kafka.api.secret, data__name" /> | 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. |
-| <CopyableCode code="get_connectv1connector_config" /> | `EXEC` | <CopyableCode code="connector_name, environment_id, kafka_cluster_id" /> | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />Get the configuration for the connector. |

docs/confluent-docs/providers/confluent/connect/connector_offsets_request_status/index.md

@@ -28,8 +28,14 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
 </tbody></table>
 
 ## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command  
+| Name | Datatype | Description |
+|:-----|:---------|:------------|
+| <CopyableCode code="applied_at" /> | `string` | The time at which the offsets were applied. The time is in UTC, ISO 8601 format. |
+| <CopyableCode code="previous_offsets" /> | `array` | Array of offsets which are categorised into partitions. |
+| <CopyableCode code="request" /> | `object` | The request made to alter offsets. |
+| <CopyableCode code="status" /> | `object` | The response of the alter offsets operation. |
 ## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| <CopyableCode code="alter_connectv1connector_offsets_request" /> | `EXEC` | <CopyableCode code="connector_name, environment_id, kafka_cluster_id, data__type" /> |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| <CopyableCode code="get_connectv1connector_offsets_request_status" /> | `SELECT` | <CopyableCode code="connector_name, environment_id, kafka_cluster_id" /> | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />Get the status of the previous alter offset request. |
+| <CopyableCode code="alter_connectv1connector_offsets_request" /> | `EXEC` | <CopyableCode code="connector_name, environment_id, kafka_cluster_id, data__type" /> | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />Request to alter the offsets of a connector. This supports the ability to PATCH/DELETE the offsets of a connector.<br />Note, you will see momentary downtime as this will internally stop the connector, while the offsets are being altered.<br />You can only make one alter offsets request at a time for a connector. |

docs/confluent-docs/providers/confluent/connect/connector_offsets_requests/index.md

@@ -28,8 +28,13 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
 </tbody></table>
 
 ## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command  
+| Name | Datatype | Description |
+|:-----|:---------|:------------|
+| <CopyableCode code="name" /> | `string` | The name of the connector. |
+| <CopyableCode code="connector" /> | `object` | The map containing connector status. |
+| <CopyableCode code="tasks" /> | `array` | The map containing the task status. |
+| <CopyableCode code="type" /> | `string` | Type of connector, sink or source. |
 ## Methods
 | Name | Accessible by | Required Params |
 |:-----|:--------------|:----------------|
-| <CopyableCode code="read_connectv1connector_status" /> | `EXEC` | <CopyableCode code="connector_name, environment_id, kafka_cluster_id" /> |
+| <CopyableCode code="read_connectv1connector_status" /> | `SELECT` | <CopyableCode code="connector_name, environment_id, kafka_cluster_id" /> |

docs/confluent-docs/providers/confluent/connect/connector_status/index.md

@@ -37,9 +37,9 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
 ## Methods
 | Name | Accessible by | Required Params | Description |
 |:-----|:--------------|:----------------|:------------|
+| <CopyableCode code="list_connectv1connectors" /> | `SELECT` | <CopyableCode code="environment_id, kafka_cluster_id" /> | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />Retrieve a list of "names" of the active connectors. You can then make a [read request](#operation/readConnectv1Connector) for a specific connector by name. |
 | <CopyableCode code="read_connectv1connector" /> | `SELECT` | <CopyableCode code="connector_name, environment_id, kafka_cluster_id" /> | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />Get information about the connector. |
 | <CopyableCode code="create_connectv1connector" /> | `INSERT` | <CopyableCode code="environment_id, kafka_cluster_id" /> | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />Create a new connector. Returns the new connector information if successful. |
 | <CopyableCode code="delete_connectv1connector" /> | `DELETE` | <CopyableCode code="connector_name, environment_id, kafka_cluster_id" /> | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />Delete a connector. Halts all tasks and deletes the connector configuration. |
-| <CopyableCode code="list_connectv1connectors" /> | `EXEC` | <CopyableCode code="environment_id, kafka_cluster_id" /> | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />Retrieve a list of "names" of the active connectors. You can then make a [read request](#operation/readConnectv1Connector) for a specific connector by name. |
 | <CopyableCode code="pause_connectv1connector" /> | `EXEC` | <CopyableCode code="connector_name, environment_id, kafka_cluster_id" /> | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />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. |
 | <CopyableCode code="resume_connectv1connector" /> | `EXEC` | <CopyableCode code="connector_name, environment_id, kafka_cluster_id" /> | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />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. |

docs/confluent-docs/providers/confluent/connect/connectors/index.md

@@ -20,8 +20,8 @@ Connect
 
 <div class="row">
 <div class="providerDocColumn">
-<span>total resources:&nbsp;<b>11</b></span><br />
-<span>total selectable resources:&nbsp;<b>5</b></span><br />
+<span>total resources:&nbsp;<b>10</b></span><br />
+<span>total selectable resources:&nbsp;<b>8</b></span><br />
 <span>total methods:&nbsp;<b>22</b></span><br />
 </div>
 </div>
@@ -34,15 +34,14 @@ Connect
 <tr><td><b>Type</b></td><td>Service</td></tr>
 <tr><td><b>Title</b></td><td>Confluent Cloud APIs - Connect</td></tr>
 <tr><td><b>Description</b></td><td>Connect</td></tr>
-<tr><td><b>Id</b></td><td><code>connect:v24.10.00268</code></td></tr>
+<tr><td><b>Id</b></td><td><code>connect:v24.11.00272</code></td></tr>
 </tbody></table>
 
 ## Resources
 <div class="row">
 <div class="providerDocColumn">
 <a href="/providers/confluent/connect/connector_config/">connector_config</a><br />
 <a href="/providers/confluent/connect/connector_offsets/">connector_offsets</a><br />
-<a href="/providers/confluent/connect/connector_offsets_request_status/">connector_offsets_request_status</a><br />
 <a href="/providers/confluent/connect/connector_offsets_requests/">connector_offsets_requests</a><br />
 <a href="/providers/confluent/connect/connector_status/">connector_status</a><br />
 <a href="/providers/confluent/connect/connector_tasks/">connector_tasks</a><br />

docs/confluent-docs/providers/confluent/connect/index.md

@@ -28,9 +28,13 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
 </tbody></table>
 
 ## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command  
+| Name | Datatype | Description |
+|:-----|:---------|:------------|
+| <CopyableCode code="class" /> | `string` | The connector class name. E.g. BigQuerySink. |
+| <CopyableCode code="type" /> | `string` | Type of connector, sink or source. |
+| <CopyableCode code="version" /> | `string` | The version string for the connector available. |
 ## Methods
 | Name | Accessible by | Required Params | Description |
 |:-----|:--------------|:----------------|:------------|
-| <CopyableCode code="list_connectv1connector_plugins" /> | `EXEC` | <CopyableCode code="environment_id, kafka_cluster_id" /> | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />Return a list of Managed Connector plugins installed in the Kafka Connect cluster. |
+| <CopyableCode code="list_connectv1connector_plugins" /> | `SELECT` | <CopyableCode code="environment_id, kafka_cluster_id" /> | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />Return a list of Managed Connector plugins installed in the Kafka Connect cluster. |
 | <CopyableCode code="validate_connectv1connector_plugin" /> | `EXEC` | <CopyableCode code="environment_id, kafka_cluster_id, plugin_name" /> | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />Validate the provided configuration values against the configuration definition. This API performs per config validation and returns suggested values and validation error messages. |