Merge pull request #5944 from influxdata/staging/jts-api-distributed

Add Clustered Management API reference, get token createdAt and revokedAt fields

Author: jstirnaman

api-docs/getswagger.sh

@@ -62,7 +62,7 @@ function showHelp {
 subcommand=$1
 
 case "$subcommand" in
-  cloud-dedicated-v2|cloud-dedicated-management|cloud-serverless-v2|clustered-v2|cloud-v2|v2|v1-compat|core-v3|enterprise-v3|all)
+  cloud-dedicated-v2|cloud-dedicated-management|cloud-serverless-v2|clustered-management|clustered-v2|cloud-v2|v2|v1-compat|core-v3|enterprise-v3|all)
     product=$1
     shift
 
@@ -187,6 +187,22 @@ function updateCloudServerlessV2 {
   postProcess $outFile 'influxdb3/cloud-serverless/.config.yml' v2@2
 }
 
+function updateClusteredManagement {
+  outFile="influxdb3/clustered/management/openapi.yml"
+  if [[ -z "$baseUrl" ]];
+  then
+    echo "Using existing $outFile"
+  else
+    # Clone influxdata/granite and fetch the latest openapi.yaml file.
+    echo "Fetching the latest openapi.yaml file from influxdata/granite"
+    tmp_dir=$(mktemp -d)
+    git clone --depth 1 --branch main https://github.com/influxdata/granite.git "$tmp_dir"
+    cp "$tmp_dir/openapi.yaml" "$outFile"
+    rm -rf "$tmp_dir"
+  fi
+  postProcess $outFile 'influxdb3/clustered/.config.yml' management@0
+}
+
 function updateClusteredV2 {
   outFile="influxdb3/clustered/v2/ref.yml"
   if [[ -z "$baseUrl" ]];
@@ -278,6 +294,9 @@ then
 elif [ "$product" = "cloud-serverless-v2" ];
 then
   updateCloudServerlessV2
+elif [ "$product" = "clustered-management" ];
+then
+  updateClusteredManagement
 elif [ "$product" = "clustered-v2" ];
 then
   updateClusteredV2
@@ -305,6 +324,6 @@ then
   updateOSSV2
   updateV1Compat
 else
-  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."
+  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."
   showHelp
 fi

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

@@ -1,6 +1,6 @@
 - name: Using the Management API
   tags:
     - Authentication
-    - Examples
+    - Quickstart
 - name: All endpoints
   tags: []

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

@@ -7,10 +7,10 @@ info:
 
     This documentation is generated from the
     InfluxDB OpenAPI specification.
+  version: ''
   license:
     name: MIT
     url: https://opensource.org/licenses/MIT
-  version: ''
   contact:
     name: InfluxData
     url: https://www.influxdata.com
@@ -31,7 +31,7 @@ tags:
   - name: Authentication
     x-traitTag: true
     description: |
-      The InfluxDB Management API endpoints require the following credentials:
+      With InfluxDB 3 Cloud Dedicated, the InfluxDB Management API endpoints require the following credentials:
 
       - `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).
       - `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:
     description: Manage database read/write tokens for a cluster
   - name: Databases
     description: Manage databases for a cluster
-  - name: Example
+  - name: Quickstart
     x-traitTag: true
     description: |
       The following example script shows how to use `curl` to make database and token management requests:
@@ -630,7 +630,7 @@ paths:
                   maxTables: 300
                   maxColumnsPerTable: 150
                   retentionPeriod: 600000000000
-              maxTablsOnly:
+              maxTablesOnly:
                 summary: Update Max Tables Only
                 value:
                   maxTables: 300
@@ -681,7 +681,7 @@ paths:
                     maxTables: 300
                     maxColumnsPerTable: 150
                     retentionPeriod: 600000000000
-                maxTablsOnly:
+                maxTablesOnly:
                   summary: Update Max Tables Only
                   value:
                     accountId: 11111111-1111-4111-8111-111111111111
@@ -975,6 +975,10 @@ paths:
                       $ref: '#/components/schemas/DatabaseTokenPermissions'
                     createdAt:
                       $ref: '#/components/schemas/DatabaseTokenCreatedAt'
+                    expiresAt:
+                      $ref: '#/components/schemas/DatabaseTokenExpiresAt'
+                    revokedAt:
+                      $ref: '#/components/schemas/DatabaseTokenRevokedAt'
                   required:
                     - accountId
                     - clusterId
@@ -1078,6 +1082,8 @@ paths:
                   $ref: '#/components/schemas/DatabaseTokenDescription'
                 permissions:
                   $ref: '#/components/schemas/DatabaseTokenPermissions'
+                expiresAt:
+                  $ref: '#/components/schemas/DatabaseTokenExpiresAt'
               required:
                 - description
             examples:
@@ -1127,6 +1133,10 @@ paths:
                     $ref: '#/components/schemas/DatabaseTokenCreatedAt'
                   accessToken:
                     $ref: '#/components/schemas/DatabaseTokenAccessToken'
+                  expiresAt:
+                    $ref: '#/components/schemas/DatabaseTokenExpiresAt'
+                  revokedAt:
+                    $ref: '#/components/schemas/DatabaseTokenRevokedAt'
                 required:
                   - accountId
                   - clusterId
@@ -1270,6 +1280,10 @@ paths:
                     $ref: '#/components/schemas/DatabaseTokenPermissions'
                   createdAt:
                     $ref: '#/components/schemas/DatabaseTokenCreatedAt'
+                  expiresAt:
+                    $ref: '#/components/schemas/DatabaseTokenExpiresAt'
+                  revokedAt:
+                    $ref: '#/components/schemas/DatabaseTokenRevokedAt'
                 required:
                   - accountId
                   - clusterId
@@ -1427,6 +1441,10 @@ paths:
                     $ref: '#/components/schemas/DatabaseTokenPermissions'
                   createdAt:
                     $ref: '#/components/schemas/DatabaseTokenCreatedAt'
+                  expiresAt:
+                    $ref: '#/components/schemas/DatabaseTokenExpiresAt'
+                  revokedAt:
+                    $ref: '#/components/schemas/DatabaseTokenRevokedAt'
                 required:
                   - accountId
                   - clusterId
@@ -1876,6 +1894,18 @@ components:
       examples:
         - '2023-12-21T17:32:28.000Z'
         - '2024-03-02T04:20:19.000Z'
+    DatabaseTokenExpiresAt:
+      description: |
+        The date and time that the database token expires, if applicable
+
+        Uses RFC3339 format
+      $ref: '#/components/schemas/DateTimeRfc3339'
+    DatabaseTokenRevokedAt:
+      description: |
+        The date and time that the database token was revoked, if applicable
+
+        Uses RFC3339 format
+      $ref: '#/components/schemas/DateTimeRfc3339'
     DatabaseTokenAccessToken:
       description: |
         The access token that can be used to authenticate query and write requests to the cluster
@@ -1986,7 +2016,7 @@ x-tagGroups:
   - name: Using the Management API
     tags:
       - Authentication
-      - Examples
+      - Quickstart
   - name: All endpoints
     tags:
       - Database tokens

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

@@ -6,6 +6,8 @@ extends:
 x-influxdata-product-name: InfluxDB 3 Clustered
 
 apis:
+  management@0:
+    root: management/openapi.yml
   v2@2:
     root: v2/ref.yml
     x-influxdata-docs-aliases:

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

@@ -0,0 +1,15 @@
+title: InfluxDB 3 Clustered Management API
+x-influxdata-short-title: Management API
+description: |
+    The Management API for InfluxDB 3 Clustered provides a programmatic interface for managing an InfluxDB 3 cluster.
+    The Management API lets you integrate functions such as creating and managing databases, permissions, and tokens into your workflow or application.
+
+    This documentation is generated from the
+    InfluxDB 3 Management API OpenAPI specification.
+license:
+  name: MIT
+  url: 'https://opensource.org/licenses/MIT'
+contact:
+  name: InfluxData
+  url: https://www.influxdata.com
+  email: support@influxdata.com

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

@@ -0,0 +1,8 @@
+- url: 'https://{baseurl}/api/v0'
+  description: InfluxDB 3 Clustered Management API URL
+  variables:
+    baseurl:
+      enum:
+        - 'console.influxdata.com'
+      default: 'console.influxdata.com'
+      description: InfluxDB 3 Clustered Console URL

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

@@ -0,0 +1,6 @@
+- name: Using the Management API
+  tags:
+    - Authentication
+    - Quickstart
+- name: All endpoints
+  tags: []