Skip to content

Commit 75d27d6

Browse files
jeffreyavenjeffreyaven
authored
Merge pull request #201 from stackql/feature/doc-updates
anthropic and confluent
2 parents f802f59 + 4205811 commit 75d27d6

File tree

146 files changed

+6187
-18
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

146 files changed

+6187
-18
lines changed

‎.github/workflows/build-docs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ jobs:
7878
if [ $PROVIDER == "root" ]; then
7979
echo "adding vanity url redirects to _redirects file.."
8080
touch ./build/_redirects
81-
array=( aws azure azure-extras azure-isv azure-stack digitalocean firebase github openai anthropic google googleadmin k8s linode netlify okta sumologic vercel godaddy pagerduty homebrew datadog )
81+
array=( aws azure azure-extras azure-isv azure-stack digitalocean firebase confluent github openai anthropic google googleadmin k8s linode netlify okta sumologic vercel godaddy pagerduty homebrew datadog )
8282
for i in "${array[@]}"
8383
do
8484
echo "adding redirects for $i"

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ This repository contains documentation for StackQL providers, which is published
2929
| Netlify Deploy Azure Stack | [![Netlify Status](https://api.netlify.com/api/v1/badges/53abcb20-0194-41dd-b466-4d933cfffcad/deploy-status)](https://app.netlify.com/sites/stackql-azure-stack-docs/deploys) | [azure-stack-docs.stackql.io](https://azure-stack-docs.stackql.io)<br/>[azure-stack.stackql.io](https://azure-stack.stackql.io) |
3030
| Netlify Deploy OpenAI | [![Netlify Status](https://api.netlify.com/api/v1/badges/6df5743b-8c5d-4949-866e-eda4ca3f74d0/deploy-status)](https://app.netlify.com/sites/stackql-openai-docs/deploys) | [openai-docs.stackql.io](https://openai-docs.stackql.io)<br/>[openai.stackql.io](https://openai.stackql.io) |
3131
| Netlify Deploy Anthropic | [![Netlify Status](https://api.netlify.com/api/v1/badges/114c5a2a-9b76-4941-a0e8-3669ee7d2016/deploy-status)](https://app.netlify.com/sites/stackql-anthropic-docs/deploys) | [anthropic-docs.stackql.io](https://anthropic-docs.stackql.io)<br/>[anthropic.stackql.io](https://anthropic.stackql.io) |
32-
32+
| Netlify Deploy Confluent | [![Netlify Status](https://api.netlify.com/api/v1/badges/63149c2f-6c3d-43f1-be38-80c55c223ac0/deploy-status)](https://app.netlify.com/sites/stackql-confluent-docs/deploys) | [confluent-docs.stackql.io](https://confluent-docs.stackql.io)<br/>[confluent.stackql.io](https://confluent.stackql.io) |
3333

3434
## Adding Docs for a New Provider
3535

‎ci-scripts/get-providers-to-deploy.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ const allProviders = [
1515
'digitalocean',
1616
'firebase',
1717
'github',
18+
'confluent',
1819
'openai',
1920
'anthropic',
2021
'google',

‎docs/anthropic-docs/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,16 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
1919

2020
AI models including Claude for advanced language understanding and generation.
2121

22-
:::info Provider Summary (v24.10.00267)
22+
:::info Provider Summary (v24.11.00270)
2323

2424
<div class="row">
2525
<div class="providerDocColumn">
2626
<span>total services:&nbsp;<b>1</b></span><br />
27-
<span>total methods:&nbsp;<b>2</b></span><br />
27+
<span>total methods:&nbsp;<b>1</b></span><br />
2828
</div>
2929
<div class="providerDocColumn">
30-
<span>total resources:&nbsp;<b>2</b></span><br />
31-
<span>total selectable resources:&nbsp;<b>2</b></span><br />
30+
<span>total resources:&nbsp;<b>1</b></span><br />
31+
<span>total selectable resources:&nbsp;<b>1</b></span><br />
3232
</div>
3333
</div>
3434

@@ -63,15 +63,15 @@ To use different environment variables (instead of the defaults), use the `--aut
6363

6464
```bash
6565

66-
AUTH='{ "anthropic": { "type": "bearer", "credentialsenvvar": "MY_ANTHROPIC_API_KEY" }}'
66+
AUTH='{ "anthropic": { "type": "bearer", "credentialsenvvar": "MY_ANTHROPIC_API_KEY_VAR" }}'
6767
stackql shell --auth="${AUTH}"
6868

6969
```
7070
or using PowerShell:
7171

7272
```powershell
7373
74-
$Auth = "{ 'anthropic': { 'type': 'bearer', 'credentialsenvvar': 'MY_ANTHROPIC_API_KEY' }}"
74+
$Auth = "{ 'anthropic': { 'type': 'bearer', 'credentialsenvvar': 'MY_ANTHROPIC_API_KEY_VAR' }}"
7575
stackql.exe shell --auth=$Auth
7676
7777
```

‎docs/anthropic-docs/providers/anthropic/messages/index.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ Given A List Of Messages Comprising A Conversation, The Model Will Return A Resp
2020

2121
<div class="row">
2222
<div class="providerDocColumn">
23-
<span>total resources:&nbsp;<b>2</b></span><br />
24-
<span>total selectable resources:&nbsp;<b>2</b></span><br />
25-
<span>total methods:&nbsp;<b>2</b></span><br />
23+
<span>total resources:&nbsp;<b>1</b></span><br />
24+
<span>total selectable resources:&nbsp;<b>1</b></span><br />
25+
<span>total methods:&nbsp;<b>1</b></span><br />
2626
</div>
2727
</div>
2828

@@ -34,15 +34,14 @@ Given A List Of Messages Comprising A Conversation, The Model Will Return A Resp
3434
<tr><td><b>Type</b></td><td>Service</td></tr>
3535
<tr><td><b>Title</b></td><td>Anthropic API - Messages</td></tr>
3636
<tr><td><b>Description</b></td><td>Given A List Of Messages Comprising A Conversation, The Model Will Return A Response.</td></tr>
37-
<tr><td><b>Id</b></td><td><code>messages:v24.10.00267</code></td></tr>
37+
<tr><td><b>Id</b></td><td><code>messages:v24.11.00270</code></td></tr>
3838
</tbody></table>
3939

4040
## Resources
4141
<div class="row">
4242
<div class="providerDocColumn">
43-
<a href="/providers/anthropic/messages/claude_35_chat/">claude_35_chat</a><br />
43+
<a href="/providers/anthropic/messages/message/">message</a><br />
4444
</div>
4545
<div class="providerDocColumn">
46-
<a href="/providers/anthropic/messages/message/">message</a><br />
4746
</div>
4847
</div>

‎docs/confluent-docs/index.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
title: confluent
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- confluent
7+
- stackql
8+
- infrastructure-as-code
9+
- configuration-as-data
10+
- cloud inventory
11+
description: Query, deploy, and manage Confluent Cloud resources using SQL.
12+
custom_edit_url: null
13+
image: /img/providers/confluent/stackql-confluent-provider-featured-image.png
14+
id: confluent-doc
15+
slug: /providers/confluent
16+
---
17+
18+
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
19+
20+
Confluent Cloud for managing Kafka clusters, topics, and streaming services in a scalable cloud environment.
21+
22+
:::info Provider Summary (v24.11.00270)
23+
24+
<div class="row">
25+
<div class="providerDocColumn">
26+
<span>total services:&nbsp;<b>22</b></span><br />
27+
<span>total methods:&nbsp;<b>391</b></span><br />
28+
</div>
29+
<div class="providerDocColumn">
30+
<span>total resources:&nbsp;<b>111</b></span><br />
31+
<span>total selectable resources:&nbsp;<b>81</b></span><br />
32+
</div>
33+
</div>
34+
35+
:::
36+
37+
See also:
38+
[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
39+
* * *
40+
41+
## Installation
42+
43+
To pull the latest version of the `confluent` provider, run the following command:
44+
45+
```bash
46+
REGISTRY PULL confluent;
47+
```
48+
> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).
49+
50+
## Authentication
51+
52+
The following system environment variables are used for authentication by default:
53+
54+
- <CopyableCode code="CONFLUENT_CLOUD_API_KEY" /> - Confluent Cloud API key (see <a href="https://confluent.cloud/settings/api-keys">Confluent Cloud API keys</a>)
55+
- <CopyableCode code="CONFLUENT_CLOUD_API_SECRET" /> - Confluent Cloud API secret (see <a href="https://confluent.cloud/settings/api-keys">Confluent Cloud API keys</a>)
56+
57+
These variables are sourced at runtime (from the local machine or as CI variables/secrets).
58+
59+
<details>
60+
61+
<summary>Using different environment variables</summary>
62+
63+
To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example:
64+
65+
```bash
66+
67+
AUTH='{ "anthropic": { "type": "basic", "username_var": "MY_CONFLUENT_CLOUD_API_KEY_VAR", "password_var": "MY_CONFLUENT_CLOUD_API_SECRET_VAR" }}'
68+
stackql shell --auth="${AUTH}"
69+
70+
```
71+
or using PowerShell:
72+
73+
```powershell
74+
75+
$Auth = "{ 'anthropic': { 'type': 'basic', 'username_var': 'MY_CONFLUENT_CLOUD_API_KEY_VAR', 'password_var': 'MY_CONFLUENT_CLOUD_API_SECRET_VAR' }}"
76+
stackql.exe shell --auth=$Auth
77+
78+
```
79+
</details>
80+
81+
## Services
82+
<div class="row">
83+
<div class="providerDocColumn">
84+
<a href="/providers/confluent/billing/">billing</a><br />
85+
<a href="/providers/confluent/catalog/">catalog</a><br />
86+
<a href="/providers/confluent/connect/">connect</a><br />
87+
<a href="/providers/confluent/encryption_keys/">encryption_keys</a><br />
88+
<a href="/providers/confluent/flink_artifacts/">flink_artifacts</a><br />
89+
<a href="/providers/confluent/flink_compute_pools/">flink_compute_pools</a><br />
90+
<a href="/providers/confluent/iam/">iam</a><br />
91+
<a href="/providers/confluent/kafka/">kafka</a><br />
92+
<a href="/providers/confluent/ksqldb_clusters/">ksqldb_clusters</a><br />
93+
<a href="/providers/confluent/managed_kafka_clusters/">managed_kafka_clusters</a><br />
94+
<a href="/providers/confluent/networking/">networking</a><br />
95+
</div>
96+
<div class="providerDocColumn">
97+
<a href="/providers/confluent/notifications/">notifications</a><br />
98+
<a href="/providers/confluent/org/">org</a><br />
99+
<a href="/providers/confluent/partner/">partner</a><br />
100+
<a href="/providers/confluent/pipelines/">pipelines</a><br />
101+
<a href="/providers/confluent/provider_integrations/">provider_integrations</a><br />
102+
<a href="/providers/confluent/quotas/">quotas</a><br />
103+
<a href="/providers/confluent/schema_registry/">schema_registry</a><br />
104+
<a href="/providers/confluent/schema_registry_clusters/">schema_registry_clusters</a><br />
105+
<a href="/providers/confluent/sql/">sql</a><br />
106+
<a href="/providers/confluent/stream_sharing/">stream_sharing</a><br />
107+
<a href="/providers/confluent/sts/">sts</a><br />
108+
</div>
109+
</div>

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

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: costs
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- costs
7+
- billing
8+
- confluent
9+
- stackql
10+
- infrastructure-as-code
11+
- configuration-as-data
12+
- cloud inventory
13+
description: Query, deploy, and manage Confluent Cloud resources using SQL.
14+
custom_edit_url: null
15+
image: /img/providers/confluent/stackql-confluent-provider-featured-image.png
16+
---
17+
18+
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
19+
20+
21+
22+
23+
## Overview
24+
<table><tbody>
25+
<tr><td><b>Name</b></td><td><code>costs</code></td></tr>
26+
<tr><td><b>Type</b></td><td>Resource</td></tr>
27+
<tr><td><b>Id</b></td><td><CopyableCode code="confluent.billing.costs" /></td></tr>
28+
</tbody></table>
29+
30+
## Fields
31+
| Name | Datatype | Description |
32+
|:-----|:---------|:------------|
33+
| <CopyableCode code="id" /> | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). |
34+
| <CopyableCode code="amount" /> | `number` | Final amount after deducting discounts. |
35+
| <CopyableCode code="api_version" /> | `string` | APIVersion defines the schema version of this representation of a resource. |
36+
| <CopyableCode code="discount_amount" /> | `number` | Amount discounted from the original amount in dollars. |
37+
| <CopyableCode code="end_date" /> | `string` | End date of time period (exclusive) to retrieve billing costs. It is represented in RFC3339 format and is in UTC. |
38+
| <CopyableCode code="granularity" /> | `string` | Granularity at which each line item is aggregated. |
39+
| <CopyableCode code="kind" /> | `string` | Kind defines the object this REST resource represents. |
40+
| <CopyableCode code="line_type" /> | `string` | Type of the line item. |
41+
| <CopyableCode code="network_access_type" /> | `string` | Network access type for the cluster. |
42+
| <CopyableCode code="original_amount" /> | `number` | Original amount accrued for this line item. |
43+
| <CopyableCode code="price" /> | `number` | Price for the line item in dollars. |
44+
| <CopyableCode code="product" /> | `string` | Product name. |
45+
| <CopyableCode code="quantity" /> | `number` | Quantity of the line item. |
46+
| <CopyableCode code="resource" /> | `object` | The resource for a given object |
47+
| <CopyableCode code="start_date" /> | `string` | Start date of time period (inclusive) to retrieve billing costs. It is represented in RFC3339 format and is in UTC. |
48+
| <CopyableCode code="unit" /> | `string` | Unit of the line item. |
49+
## Methods
50+
| Name | Accessible by | Required Params |
51+
|:-----|:--------------|:----------------|
52+
| <CopyableCode code="list_billing_v1costs" /> | `SELECT` | <CopyableCode code="end_date, start_date" /> |

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

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: billing
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- billing
7+
- confluent
8+
- stackql
9+
- infrastructure-as-code
10+
- configuration-as-data
11+
- cloud inventory
12+
description: Query, deploy, and manage Confluent Cloud resources using SQL.
13+
custom_edit_url: null
14+
image: /img/providers/confluent/stackql-confluent-provider-featured-image.png
15+
---
16+
17+
Billing
18+
19+
:::info Service Summary
20+
21+
<div class="row">
22+
<div class="providerDocColumn">
23+
<span>total resources:&nbsp;<b>1</b></span><br />
24+
<span>total selectable resources:&nbsp;<b>1</b></span><br />
25+
<span>total methods:&nbsp;<b>1</b></span><br />
26+
</div>
27+
</div>
28+
29+
:::
30+
31+
## Overview
32+
<table><tbody>
33+
<tr><td><b>Name</b></td><td><code>confluent.billing</code></td></tr>
34+
<tr><td><b>Type</b></td><td>Service</td></tr>
35+
<tr><td><b>Title</b></td><td>Confluent Cloud APIs - Billing</td></tr>
36+
<tr><td><b>Description</b></td><td>Billing</td></tr>
37+
<tr><td><b>Id</b></td><td><code>billing:v24.10.00268</code></td></tr>
38+
</tbody></table>
39+
40+
## Resources
41+
<div class="row">
42+
<div class="providerDocColumn">
43+
<a href="/providers/confluent/billing/costs/">costs</a><br />
44+
</div>
45+
<div class="providerDocColumn">
46+
</div>
47+
</div>

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

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: business_metadata
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- business_metadata
7+
- catalog
8+
- confluent
9+
- stackql
10+
- infrastructure-as-code
11+
- configuration-as-data
12+
- cloud inventory
13+
description: Query, deploy, and manage Confluent Cloud resources using SQL.
14+
custom_edit_url: null
15+
image: /img/providers/confluent/stackql-confluent-provider-featured-image.png
16+
---
17+
18+
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
19+
20+
21+
22+
23+
## Overview
24+
<table><tbody>
25+
<tr><td><b>Name</b></td><td><code>business_metadata</code></td></tr>
26+
<tr><td><b>Type</b></td><td>Resource</td></tr>
27+
<tr><td><b>Id</b></td><td><CopyableCode code="confluent.catalog.business_metadata" /></td></tr>
28+
</tbody></table>
29+
30+
## Fields
31+
| Name | Datatype | Description |
32+
|:-----|:---------|:------------|
33+
| <CopyableCode code="attributes" /> | `object` | The business metadata attributes |
34+
| <CopyableCode code="entityName" /> | `string` | The qualified name of the entity |
35+
| <CopyableCode code="entityType" /> | `string` | The entity type |
36+
| <CopyableCode code="error" /> | `object` | Error message of this operation |
37+
| <CopyableCode code="typeName" /> | `string` | The business metadata name |
38+
## Methods
39+
| Name | Accessible by | Required Params | Description |
40+
|:-----|:--------------|:----------------|:------------|
41+
| <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)<br /><br />Gets the list of business metadata for a given entity represented<br />by a qualified name. |
42+
| <CopyableCode code="create_business_metadata" /> | `INSERT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />Bulk API to create multiple business metadata. |
43+
| <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)<br /><br />Delete a business metadata on an entity. |
44+
| <CopyableCode code="update_business_metadata" /> | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />Bulk API to update multiple business metadata. |

0 commit comments

Comments
 (0)