Skip to content

Commit 5c5b923

Browse files
jstirnamanjstirnaman
authored
Merge branch 'master' into patch-2
2 parents 6013654 + 458ee7a commit 5c5b923

File tree

8 files changed

+1819
-9
lines changed

8 files changed

+1819
-9
lines changed

‎api-docs/getswagger.sh

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ function showHelp {
6262
subcommand=$1
6363

6464
case "$subcommand" in
65-
cloud-dedicated-v2|cloud-dedicated-management|cloud-serverless-v2|clustered-v2|cloud-v2|v2|v1-compat|core-v3|enterprise-v3|all)
65+
cloud-dedicated-v2|cloud-dedicated-management|cloud-serverless-v2|clustered-management|clustered-v2|cloud-v2|v2|v1-compat|core-v3|enterprise-v3|all)
6666
product=$1
6767
shift
6868

@@ -187,6 +187,22 @@ function updateCloudServerlessV2 {
187187
postProcess $outFile 'influxdb3/cloud-serverless/.config.yml' v2@2
188188
}
189189

190+
function updateClusteredManagement {
191+
outFile="influxdb3/clustered/management/openapi.yml"
192+
if [[ -z "$baseUrl" ]];
193+
then
194+
echo "Using existing $outFile"
195+
else
196+
# Clone influxdata/granite and fetch the latest openapi.yaml file.
197+
echo "Fetching the latest openapi.yaml file from influxdata/granite"
198+
tmp_dir=$(mktemp -d)
199+
git clone --depth 1 --branch main https://github.com/influxdata/granite.git "$tmp_dir"
200+
cp "$tmp_dir/openapi.yaml" "$outFile"
201+
rm -rf "$tmp_dir"
202+
fi
203+
postProcess $outFile 'influxdb3/clustered/.config.yml' management@0
204+
}
205+
190206
function updateClusteredV2 {
191207
outFile="influxdb3/clustered/v2/ref.yml"
192208
if [[ -z "$baseUrl" ]];
@@ -278,6 +294,9 @@ then
278294
elif [ "$product" = "cloud-serverless-v2" ];
279295
then
280296
updateCloudServerlessV2
297+
elif [ "$product" = "clustered-management" ];
298+
then
299+
updateClusteredManagement
281300
elif [ "$product" = "clustered-v2" ];
282301
then
283302
updateClusteredV2
@@ -305,6 +324,6 @@ then
305324
updateOSSV2
306325
updateV1Compat
307326
else
308-
echo "Provide a product argument: cloud-v2, cloud-serverless-v2, cloud-dedicated-v2, cloud-dedicated-management, clustered-v2, core-v3, enterprise-v3, v2, v1-compat, or all."
327+
echo "Provide a product argument: cloud-v2, cloud-serverless-v2, cloud-dedicated-v2, cloud-dedicated-management, clustered-management, clustered-v2, core-v3, enterprise-v3, v2, v1-compat, or all."
309328
showHelp
310329
fi

‎api-docs/influxdb3/cloud-dedicated/management/content/tag-groups.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
- name: Using the Management API
22
tags:
33
- Authentication
4-
- Examples
4+
- Quickstart
55
- name: All endpoints
66
tags: []

‎api-docs/influxdb3/cloud-dedicated/management/openapi.yml

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ info:
77
88
This documentation is generated from the
99
InfluxDB OpenAPI specification.
10+
version: ''
1011
license:
1112
name: MIT
1213
url: https://opensource.org/licenses/MIT
13-
version: ''
1414
contact:
1515
name: InfluxData
1616
url: https://www.influxdata.com
@@ -31,7 +31,7 @@ tags:
3131
- name: Authentication
3232
x-traitTag: true
3333
description: |
34-
The InfluxDB Management API endpoints require the following credentials:
34+
With InfluxDB 3 Cloud Dedicated, the InfluxDB Management API endpoints require the following credentials:
3535
3636
- `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to. To view account ID and cluster ID, [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json).
3737
- `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage. To view account ID and cluster ID, [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json).
@@ -45,7 +45,7 @@ tags:
4545
description: Manage database read/write tokens for a cluster
4646
- name: Databases
4747
description: Manage databases for a cluster
48-
- name: Example
48+
- name: Quickstart
4949
x-traitTag: true
5050
description: |
5151
The following example script shows how to use `curl` to make database and token management requests:
@@ -630,7 +630,7 @@ paths:
630630
maxTables: 300
631631
maxColumnsPerTable: 150
632632
retentionPeriod: 600000000000
633-
maxTablsOnly:
633+
maxTablesOnly:
634634
summary: Update Max Tables Only
635635
value:
636636
maxTables: 300
@@ -681,7 +681,7 @@ paths:
681681
maxTables: 300
682682
maxColumnsPerTable: 150
683683
retentionPeriod: 600000000000
684-
maxTablsOnly:
684+
maxTablesOnly:
685685
summary: Update Max Tables Only
686686
value:
687687
accountId: 11111111-1111-4111-8111-111111111111
@@ -975,6 +975,10 @@ paths:
975975
$ref: '#/components/schemas/DatabaseTokenPermissions'
976976
createdAt:
977977
$ref: '#/components/schemas/DatabaseTokenCreatedAt'
978+
expiresAt:
979+
$ref: '#/components/schemas/DatabaseTokenExpiresAt'
980+
revokedAt:
981+
$ref: '#/components/schemas/DatabaseTokenRevokedAt'
978982
required:
979983
- accountId
980984
- clusterId
@@ -1078,6 +1082,8 @@ paths:
10781082
$ref: '#/components/schemas/DatabaseTokenDescription'
10791083
permissions:
10801084
$ref: '#/components/schemas/DatabaseTokenPermissions'
1085+
expiresAt:
1086+
$ref: '#/components/schemas/DatabaseTokenExpiresAt'
10811087
required:
10821088
- description
10831089
examples:
@@ -1127,6 +1133,10 @@ paths:
11271133
$ref: '#/components/schemas/DatabaseTokenCreatedAt'
11281134
accessToken:
11291135
$ref: '#/components/schemas/DatabaseTokenAccessToken'
1136+
expiresAt:
1137+
$ref: '#/components/schemas/DatabaseTokenExpiresAt'
1138+
revokedAt:
1139+
$ref: '#/components/schemas/DatabaseTokenRevokedAt'
11301140
required:
11311141
- accountId
11321142
- clusterId
@@ -1270,6 +1280,10 @@ paths:
12701280
$ref: '#/components/schemas/DatabaseTokenPermissions'
12711281
createdAt:
12721282
$ref: '#/components/schemas/DatabaseTokenCreatedAt'
1283+
expiresAt:
1284+
$ref: '#/components/schemas/DatabaseTokenExpiresAt'
1285+
revokedAt:
1286+
$ref: '#/components/schemas/DatabaseTokenRevokedAt'
12731287
required:
12741288
- accountId
12751289
- clusterId
@@ -1427,6 +1441,10 @@ paths:
14271441
$ref: '#/components/schemas/DatabaseTokenPermissions'
14281442
createdAt:
14291443
$ref: '#/components/schemas/DatabaseTokenCreatedAt'
1444+
expiresAt:
1445+
$ref: '#/components/schemas/DatabaseTokenExpiresAt'
1446+
revokedAt:
1447+
$ref: '#/components/schemas/DatabaseTokenRevokedAt'
14301448
required:
14311449
- accountId
14321450
- clusterId
@@ -1876,6 +1894,18 @@ components:
18761894
examples:
18771895
- '2023-12-21T17:32:28.000Z'
18781896
- '2024-03-02T04:20:19.000Z'
1897+
DatabaseTokenExpiresAt:
1898+
description: |
1899+
The date and time that the database token expires, if applicable
1900+
1901+
Uses RFC3339 format
1902+
$ref: '#/components/schemas/DateTimeRfc3339'
1903+
DatabaseTokenRevokedAt:
1904+
description: |
1905+
The date and time that the database token was revoked, if applicable
1906+
1907+
Uses RFC3339 format
1908+
$ref: '#/components/schemas/DateTimeRfc3339'
18791909
DatabaseTokenAccessToken:
18801910
description: |
18811911
The access token that can be used to authenticate query and write requests to the cluster
@@ -1986,7 +2016,7 @@ x-tagGroups:
19862016
- name: Using the Management API
19872017
tags:
19882018
- Authentication
1989-
- Examples
2019+
- Quickstart
19902020
- name: All endpoints
19912021
tags:
19922022
- Database tokens

‎api-docs/influxdb3/clustered/.config.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ extends:
66
x-influxdata-product-name: InfluxDB 3 Clustered
77

88
apis:
9+
management@0:
10+
root: management/openapi.yml
911
v2@2:
1012
root: v2/ref.yml
1113
x-influxdata-docs-aliases:

‎api-docs/influxdb3/clustered/management/content/info.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
title: InfluxDB 3 Clustered Management API
2+
x-influxdata-short-title: Management API
3+
description: |
4+
The Management API for InfluxDB 3 Clustered provides a programmatic interface for managing an InfluxDB 3 cluster.
5+
The Management API lets you integrate functions such as creating and managing databases, permissions, and tokens into your workflow or application.
6+
7+
This documentation is generated from the
8+
InfluxDB 3 Management API OpenAPI specification.
9+
license:
10+
name: MIT
11+
url: 'https://opensource.org/licenses/MIT'
12+
contact:
13+
name: InfluxData
14+
url: https://www.influxdata.com
15+
email: support@influxdata.com

‎api-docs/influxdb3/clustered/management/content/servers.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
- url: 'https://{baseurl}/api/v0'
2+
description: InfluxDB 3 Clustered Management API URL
3+
variables:
4+
baseurl:
5+
enum:
6+
- 'console.influxdata.com'
7+
default: 'console.influxdata.com'
8+
description: InfluxDB 3 Clustered Console URL

‎api-docs/influxdb3/clustered/management/content/tag-groups.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
- name: Using the Management API
2+
tags:
3+
- Authentication
4+
- Quickstart
5+
- name: All endpoints
6+
tags: []

0 commit comments

Comments
 (0)