Merge pull request #514 from influxdata/513/doc_comments

fix(apidoc): repair generated links
influxdata · Aug 4, 2022 · 81c7f55 · 81c7f55
2 parents e1e8b72 + d098f3a
commit 81c7f55
Show file tree

Hide file tree

Showing 53 changed files with 275 additions and 260 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ### Other
 
 1. [#511](https://github.com/influxdata/influxdb-client-js/pull/511): Replace rollup with tsup.
+1. [#514](https://github.com/influxdata/influxdb-client-js/pull/514): Repair links in generated API documentation.
 
 ## 1.28.0 [2022-07-29]
 

diff --git a/examples/delete.ts b/examples/delete.ts
@@ -1,9 +1,9 @@
 #!./node_modules/.bin/ts-node
 
-///////////////////////////////////////////////////////////////////////
-// Shows how to delete data from InfluxDB. See                       //
-// https://docs.influxdata.com/influxdb/v2.1/write-data/delete-data/ //
-///////////////////////////////////////////////////////////////////////
+/////////////////////////////////////////////////////////////////////////
+// Shows how to delete data from InfluxDB. See                         //
+// https://docs.influxdata.com/influxdb/latest/write-data/delete-data/ //
+/////////////////////////////////////////////////////////////////////////
 
 import {InfluxDB} from '@influxdata/influxdb-client'
 import {DeleteAPI} from '@influxdata/influxdb-client-apis'
@@ -36,7 +36,7 @@ async function deleteData(): Promise<void> {
     body: {
       start: start.toISOString(),
       stop: stop.toISOString(),
-      // see https://docs.influxdata.com/influxdb/v2.1/reference/syntax/delete-predicate/
+      // see https://docs.influxdata.com/influxdb/latest/reference/syntax/delete-predicate/
       predicate: '_measurement="temperature"',
     },
   })

diff --git a/examples/query.ts b/examples/query.ts
@@ -15,7 +15,7 @@ console.log('*** QUERY ROWS ***')
 // the essential ones are shown/commented below. See also rxjs-query.ts .
 //
 // Execute query and receive table metadata and rows as they arrive from the server.
-// https://docs.influxdata.com/influxdb/v2.1/reference/syntax/annotated-csv/
+// https://docs.influxdata.com/influxdb/latest/reference/syntax/annotated-csv/
 queryApi.queryRows(fluxQuery, {
   next: (row: string[], tableMeta: FluxTableMetaData) => {
     // the following line creates an object for each row

diff --git a/examples/rxjs-query.ts b/examples/rxjs-query.ts
@@ -15,7 +15,7 @@ const fluxQuery =
 
 console.log('*** QUERY ROWS ***')
 // performs query and receive line table metadata and rows
-// https://docs.influxdata.com/influxdb/v2.1/reference/syntax/annotated-csv/
+// https://docs.influxdata.com/influxdb/latest/reference/syntax/annotated-csv/
 from(queryApi.rows(fluxQuery))
   .pipe(map(({values, tableMeta}) => tableMeta.toObject(values)))
   .subscribe({
@@ -34,5 +34,5 @@ from(queryApi.rows(fluxQuery))
   })
 
 // performs query and receive line results in annotated csv format
-// https://docs.influxdata.com/influxdb/v2.1/reference/syntax/annotated-csv/
+// https://docs.influxdata.com/influxdb/latest/reference/syntax/annotated-csv/
 // from(queryApi.lines(fluxQuery)).forEach(console.log)
diff --git a/packages/apis/generator/generateApi.ts b/packages/apis/generator/generateApi.ts
@@ -96,7 +96,7 @@ function apiDocLink(apiName: string, opID: string): string {
   if (CLOUD_APIS.includes(apiName)) {
     return `https://docs.influxdata.com/influxdb/cloud/api/#operation/${opID}`
   }
-  return `https://docs.influxdata.com/influxdb/v2.1/api/#operation/${opID}`
+  return `https://docs.influxdata.com/influxdb/v2.3/api/#operation/${opID}`
 }
 
 function generateClass(

diff --git a/packages/apis/src/generated/AuthorizationsAPI.ts b/packages/apis/src/generated/AuthorizationsAPI.ts
@@ -51,7 +51,7 @@ export class AuthorizationsAPI {
   }
   /**
    * List all authorizations.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/GetAuthorizations }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/GetAuthorizations }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -74,7 +74,7 @@ export class AuthorizationsAPI {
   }
   /**
    * Create an authorization.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/PostAuthorizations }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/PostAuthorizations }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -93,7 +93,7 @@ export class AuthorizationsAPI {
   }
   /**
    * Retrieve an authorization.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/GetAuthorizationsID }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/GetAuthorizationsID }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -111,7 +111,7 @@ export class AuthorizationsAPI {
   }
   /**
    * Update an authorization to be active or inactive.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/PatchAuthorizationsID }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/PatchAuthorizationsID }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -130,7 +130,7 @@ export class AuthorizationsAPI {
   }
   /**
    * Delete an authorization.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/DeleteAuthorizationsID }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/DeleteAuthorizationsID }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response

diff --git a/packages/apis/src/generated/BackupAPI.ts b/packages/apis/src/generated/BackupAPI.ts
@@ -26,7 +26,7 @@ export class BackupAPI {
   }
   /**
    * Download snapshot of metadata stored in the server's embedded KV store. Should not be used in versions greater than 2.1.x, as it doesn't include metadata stored in embedded SQL.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/GetBackupKV }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/GetBackupKV }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -44,7 +44,7 @@ export class BackupAPI {
   }
   /**
    * Download snapshot of all metadata in the server.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/GetBackupMetadata }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/GetBackupMetadata }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -62,7 +62,7 @@ export class BackupAPI {
   }
   /**
    * Download snapshot of all TSM data in a shard.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/GetBackupShardId }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/GetBackupShardId }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response

diff --git a/packages/apis/src/generated/BucketsAPI.ts b/packages/apis/src/generated/BucketsAPI.ts
@@ -112,7 +112,7 @@ export class BucketsAPI {
   }
   /**
    * List all buckets.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/GetBuckets }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/GetBuckets }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -138,7 +138,7 @@ export class BucketsAPI {
   }
   /**
    * Create a bucket.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/PostBuckets }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/PostBuckets }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -157,7 +157,7 @@ export class BucketsAPI {
   }
   /**
    * Retrieve a bucket.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/GetBucketsID }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/GetBucketsID }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -175,7 +175,7 @@ export class BucketsAPI {
   }
   /**
    * Update a bucket.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/PatchBucketsID }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/PatchBucketsID }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -194,7 +194,7 @@ export class BucketsAPI {
   }
   /**
    * Delete a bucket.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/DeleteBucketsID }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/DeleteBucketsID }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -212,7 +212,7 @@ export class BucketsAPI {
   }
   /**
    * List all labels for a bucket.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/GetBucketsIDLabels }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/GetBucketsIDLabels }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -230,7 +230,7 @@ export class BucketsAPI {
   }
   /**
    * Add a label to a bucket.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/PostBucketsIDLabels }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/PostBucketsIDLabels }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -249,7 +249,7 @@ export class BucketsAPI {
   }
   /**
    * Delete a label from a bucket.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/DeleteBucketsIDLabelsID }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/DeleteBucketsIDLabelsID }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -267,7 +267,7 @@ export class BucketsAPI {
   }
   /**
    * List all users with member privileges for a bucket.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/GetBucketsIDMembers }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/GetBucketsIDMembers }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -285,7 +285,7 @@ export class BucketsAPI {
   }
   /**
    * Add a member to a bucket.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/PostBucketsIDMembers }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/PostBucketsIDMembers }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -304,7 +304,7 @@ export class BucketsAPI {
   }
   /**
    * Remove a member from a bucket.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/DeleteBucketsIDMembersID }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/DeleteBucketsIDMembersID }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -322,7 +322,7 @@ export class BucketsAPI {
   }
   /**
    * List all owners of a bucket.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/GetBucketsIDOwners }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/GetBucketsIDOwners }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -340,7 +340,7 @@ export class BucketsAPI {
   }
   /**
    * Add an owner to a bucket.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/PostBucketsIDOwners }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/PostBucketsIDOwners }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -359,7 +359,7 @@ export class BucketsAPI {
   }
   /**
    * Remove an owner from a bucket.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/DeleteBucketsIDOwnersID }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/DeleteBucketsIDOwnersID }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response

diff --git a/packages/apis/src/generated/ChecksAPI.ts b/packages/apis/src/generated/ChecksAPI.ts
@@ -77,7 +77,7 @@ export class ChecksAPI {
   }
   /**
    * List all checks.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/GetChecks }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/GetChecks }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -99,7 +99,7 @@ export class ChecksAPI {
   }
   /**
    * Add new check.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/CreateCheck }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/CreateCheck }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -118,7 +118,7 @@ export class ChecksAPI {
   }
   /**
    * Retrieve a check.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/GetChecksID }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/GetChecksID }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -136,7 +136,7 @@ export class ChecksAPI {
   }
   /**
    * Update a check.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/PutChecksID }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/PutChecksID }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -155,7 +155,7 @@ export class ChecksAPI {
   }
   /**
    * Update a check.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/PatchChecksID }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/PatchChecksID }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -174,7 +174,7 @@ export class ChecksAPI {
   }
   /**
    * Delete a check.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/DeleteChecksID }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/DeleteChecksID }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -192,7 +192,7 @@ export class ChecksAPI {
   }
   /**
    * List all labels for a check.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/GetChecksIDLabels }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/GetChecksIDLabels }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -210,7 +210,7 @@ export class ChecksAPI {
   }
   /**
    * Add a label to a check.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/PostChecksIDLabels }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/PostChecksIDLabels }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -229,7 +229,7 @@ export class ChecksAPI {
   }
   /**
    * Delete label from a check.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/DeleteChecksIDLabelsID }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/DeleteChecksIDLabelsID }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response
@@ -247,7 +247,7 @@ export class ChecksAPI {
   }
   /**
    * Retrieve a check query.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/GetChecksIDQuery }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/GetChecksIDQuery }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response

diff --git a/packages/apis/src/generated/ConfigAPI.ts b/packages/apis/src/generated/ConfigAPI.ts
@@ -19,7 +19,7 @@ export class ConfigAPI {
   }
   /**
    * Retrieve runtime configuration.
-   * See {@link https://docs.influxdata.com/influxdb/v2.1/api/#operation/GetConfig }
+   * See {@link https://docs.influxdata.com/influxdb/v2.3/api/#operation/GetConfig }
    * @param request - request parameters and body (if supported)
    * @param requestOptions - optional transport options
    * @returns promise of response