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

updated confluent
stackql · Nov 10, 2024 · c46c478 · c46c478
2 parents a2bbefc + a861f58
commit c46c478
Show file tree

Hide file tree

Showing 132 changed files with 857 additions and 1,986 deletions.
diff --git a/docs/confluent-docs/providers/confluent/billing/costs/index.md b/docs/confluent-docs/providers/confluent/billing/costs/index.md
@@ -5,14 +5,13 @@ hide_table_of_contents: false
 keywords:
   - costs
   - billing
-  - azure
-  - microsoft azure
+  - confluent
   - infrastructure-as-code
   - configuration-as-data
   - cloud inventory
-description: Query, deploy and manage Microsoft Azure infrastructure and resources using SQL
+description: Query, deploy and manage confluent resources using SQL
 custom_edit_url: null
-image: /img/providers/azure/stackql-azure-provider-featured-image.png
+image: /img/providers/confluent/stackql-confluent-provider-featured-image.png
 ---
 
 import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
@@ -51,15 +50,11 @@ Creates, updates, deletes, gets or lists a <code>costs</code> resource.
 ## Methods
 | Name | Accessible by | Required Params | Description |
 |:-----|:--------------|:----------------|:------------|
-| <CopyableCode code="list_billing_v1costs" /> | `SELECT` | <CopyableCode code="end_date, start_date" /> | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Retrieve a sorted, filtered, paginated list of all costs. |
+| <CopyableCode code="list_billing_v1costs" /> | `SELECT` | <CopyableCode code="end_date, start_date" /> | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all costs. |
 
 ## `SELECT` examples
 
-[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Retrieve a sorted, filtered, paginated list of all costs.
+[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all costs.
 
 
 ```sql

diff --git a/docs/confluent-docs/providers/confluent/billing/index.md b/docs/confluent-docs/providers/confluent/billing/index.md
@@ -4,15 +4,14 @@ hide_title: false
 hide_table_of_contents: false
 keywords:
   - billing
-  - azure
-  - microsoft azure
+  - confluent
   - stackql
   - infrastructure-as-code
   - configuration-as-data
   - cloud inventory
-description: Query, deploy and manage Microsoft Azure resources using SQL
+description: Query, deploy and manage confluent resources using SQL
 custom_edit_url: null
-image: /img/providers/azure/stackql-azure-provider-featured-image.png
+image: /img/providers/confluent/stackql-confluent-provider-featured-image.png
 ---
 
 billing service documentation.

diff --git a/docs/confluent-docs/providers/confluent/catalog/business_metadata/index.md b/docs/confluent-docs/providers/confluent/catalog/business_metadata/index.md
@@ -5,14 +5,13 @@ hide_table_of_contents: false
 keywords:
   - business_metadata
   - catalog
-  - azure
-  - microsoft azure
+  - confluent
   - infrastructure-as-code
   - configuration-as-data
   - cloud inventory
-description: Query, deploy and manage Microsoft Azure infrastructure and resources using SQL
+description: Query, deploy and manage confluent resources using SQL
 custom_edit_url: null
-image: /img/providers/azure/stackql-azure-provider-featured-image.png
+image: /img/providers/confluent/stackql-confluent-provider-featured-image.png
 ---
 
 import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
@@ -40,26 +39,14 @@ Creates, updates, deletes, gets or lists a <code>business_metadata</code> resour
 ## Methods
 | Name | Accessible by | Required Params | Description |
 |:-----|:--------------|:----------------|:------------|
-| <CopyableCode code="get_business_metadata" /> | `SELECT` | <CopyableCode code="qualifiedName, typeName" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Gets the list of business metadata for a given entity represented
-by a qualified name. |
-| <CopyableCode code="create_business_metadata" /> | `INSERT` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Bulk API to create multiple business metadata. |
-| <CopyableCode code="delete_business_metadata" /> | `DELETE` | <CopyableCode code="bmName, qualifiedName, typeName" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Delete a business metadata on an entity. |
-| <CopyableCode code="update_business_metadata" /> | `EXEC` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Bulk API to update multiple business metadata. |
+| <CopyableCode code="get_business_metadata" /> | `SELECT` | <CopyableCode code="qualifiedName, typeName" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Gets the list of business metadata for a given entity represented by a qualified name. |
+| <CopyableCode code="create_business_metadata" /> | `INSERT` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk API to create multiple business metadata. |
+| <CopyableCode code="delete_business_metadata" /> | `DELETE` | <CopyableCode code="bmName, qualifiedName, typeName" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Delete a business metadata on an entity. |
+| <CopyableCode code="update_business_metadata" /> | `EXEC` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk API to update multiple business metadata. |
 
 ## `SELECT` examples
 
-[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Gets the list of business metadata for a given entity represented
-by a qualified name.
+[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Gets the list of business metadata for a given entity represented by a qualified name.
 
 
 ```sql

diff --git a/docs/confluent-docs/providers/confluent/catalog/business_metadata_defs/index.md b/docs/confluent-docs/providers/confluent/catalog/business_metadata_defs/index.md
@@ -5,14 +5,13 @@ hide_table_of_contents: false
 keywords:
   - business_metadata_defs
   - catalog
-  - azure
-  - microsoft azure
+  - confluent
   - infrastructure-as-code
   - configuration-as-data
   - cloud inventory
-description: Query, deploy and manage Microsoft Azure infrastructure and resources using SQL
+description: Query, deploy and manage confluent resources using SQL
 custom_edit_url: null
-image: /img/providers/azure/stackql-azure-provider-featured-image.png
+image: /img/providers/confluent/stackql-confluent-provider-featured-image.png
 ---
 
 import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
@@ -48,27 +47,15 @@ Creates, updates, deletes, gets or lists a <code>business_metadata_defs</code> r
 ## Methods
 | Name | Accessible by | Required Params | Description |
 |:-----|:--------------|:----------------|:------------|
-| <CopyableCode code="get_all_business_metadata_defs" /> | `SELECT` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Bulk retrieval API for retrieving business metadata definitions. |
-| <CopyableCode code="get_business_metadata_def_by_name" /> | `SELECT` | <CopyableCode code="bmName" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Get the business metadata definition with the given name. |
-| <CopyableCode code="create_business_metadata_defs" /> | `INSERT` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Bulk create API for business metadata definitions. |
-| <CopyableCode code="delete_business_metadata_def" /> | `DELETE` | <CopyableCode code="bmName" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Delete API for business metadata definition identified by its name. |
-| <CopyableCode code="update_business_metadata_defs" /> | `EXEC` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Bulk update API for business metadata definitions. |
+| <CopyableCode code="get_all_business_metadata_defs" /> | `SELECT` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk retrieval API for retrieving business metadata definitions. |
+| <CopyableCode code="get_business_metadata_def_by_name" /> | `SELECT` | <CopyableCode code="bmName" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Get the business metadata definition with the given name. |
+| <CopyableCode code="create_business_metadata_defs" /> | `INSERT` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk create API for business metadata definitions. |
+| <CopyableCode code="delete_business_metadata_def" /> | `DELETE` | <CopyableCode code="bmName" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Delete API for business metadata definition identified by its name. |
+| <CopyableCode code="update_business_metadata_defs" /> | `EXEC` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk update API for business metadata definitions. |
 
 ## `SELECT` examples
 
-[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Bulk retrieval API for retrieving business metadata definitions.
+[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk retrieval API for retrieving business metadata definitions.
 
 
 ```sql

diff --git a/docs/confluent-docs/providers/confluent/catalog/entities/index.md b/docs/confluent-docs/providers/confluent/catalog/entities/index.md
@@ -5,14 +5,13 @@ hide_table_of_contents: false
 keywords:
   - entities
   - catalog
-  - azure
-  - microsoft azure
+  - confluent
   - infrastructure-as-code
   - configuration-as-data
   - cloud inventory
-description: Query, deploy and manage Microsoft Azure infrastructure and resources using SQL
+description: Query, deploy and manage confluent resources using SQL
 custom_edit_url: null
-image: /img/providers/azure/stackql-azure-provider-featured-image.png
+image: /img/providers/confluent/stackql-confluent-provider-featured-image.png
 ---
 
 import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
@@ -37,18 +36,12 @@ Creates, updates, deletes, gets or lists a <code>entities</code> resource.
 ## Methods
 | Name | Accessible by | Required Params | Description |
 |:-----|:--------------|:----------------|:------------|
-| <CopyableCode code="get_by_unique_attributes" /> | `SELECT` | <CopyableCode code="qualifiedName, typeName" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Fetch complete definition of an entity given its type and unique attribute. |
-| <CopyableCode code="partial_entity_update" /> | `EXEC` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Partially update an entity attribute. |
+| <CopyableCode code="get_by_unique_attributes" /> | `SELECT` | <CopyableCode code="qualifiedName, typeName" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Fetch complete definition of an entity given its type and unique attribute. |
+| <CopyableCode code="partial_entity_update" /> | `EXEC` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Partially update an entity attribute. |
 
 ## `SELECT` examples
 
-[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Fetch complete definition of an entity given its type and unique attribute.
+[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Fetch complete definition of an entity given its type and unique attribute.
 
 
 ```sql

diff --git a/docs/confluent-docs/providers/confluent/catalog/index.md b/docs/confluent-docs/providers/confluent/catalog/index.md
@@ -4,15 +4,14 @@ hide_title: false
 hide_table_of_contents: false
 keywords:
   - catalog
-  - azure
-  - microsoft azure
+  - confluent
   - stackql
   - infrastructure-as-code
   - configuration-as-data
   - cloud inventory
-description: Query, deploy and manage Microsoft Azure resources using SQL
+description: Query, deploy and manage confluent resources using SQL
 custom_edit_url: null
-image: /img/providers/azure/stackql-azure-provider-featured-image.png
+image: /img/providers/confluent/stackql-confluent-provider-featured-image.png
 ---
 
 catalog service documentation.

diff --git a/docs/confluent-docs/providers/confluent/catalog/searches/index.md b/docs/confluent-docs/providers/confluent/catalog/searches/index.md
@@ -5,14 +5,13 @@ hide_table_of_contents: false
 keywords:
   - searches
   - catalog
-  - azure
-  - microsoft azure
+  - confluent
   - infrastructure-as-code
   - configuration-as-data
   - cloud inventory
-description: Query, deploy and manage Microsoft Azure infrastructure and resources using SQL
+description: Query, deploy and manage confluent resources using SQL
 custom_edit_url: null
-image: /img/providers/azure/stackql-azure-provider-featured-image.png
+image: /img/providers/confluent/stackql-confluent-provider-featured-image.png
 ---
 
 import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
@@ -39,18 +38,12 @@ Creates, updates, deletes, gets or lists a <code>searches</code> resource.
 ## Methods
 | Name | Accessible by | Required Params | Description |
 |:-----|:--------------|:----------------|:------------|
-| <CopyableCode code="search_using_attribute" /> | `SELECT` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Retrieve data for the specified attribute search query. |
-| <CopyableCode code="search_using_basic" /> | `SELECT` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Retrieve data for the specified fulltext query. |
+| <CopyableCode code="search_using_attribute" /> | `SELECT` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve data for the specified attribute search query. |
+| <CopyableCode code="search_using_basic" /> | `SELECT` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve data for the specified fulltext query. |
 
 ## `SELECT` examples
 
-[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
-
-Retrieve data for the specified attribute search query.
+[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve data for the specified attribute search query.
 
 
 ```sql