Merge pull request #173 from influxdata/sranka/172

fix(docs): use better links in code
influxdata · Apr 15, 2020 · f34e992 · f34e992
2 parents 258391c + e2982cb
commit f34e992
Show file tree

Hide file tree

Showing 35 changed files with 435 additions and 402 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,14 +1,20 @@
 ## 1.2.0 [unreleased]
 
-### Bug
-1. [#160](https://github.com/influxdata/influxdb-client-js/issues/160): Disabled using credentials for CORS 
+### Features
+
+### Bug Fixes
+
+1. [#160](https://github.com/influxdata/influxdb-client-js/issues/160): Disabled using credentials for CORS
+1. [#173](https://github.com/influxdata/influxdb-client-js/pull/173): use links that are clickable in VSCode
 
 ### Security
+
 1. [#157](https://github.com/influxdata/influxdb-client-js/issues/157): [ESLint dependencies are vulnerable (ReDoS and Prototype Pollution)](https://github.com/advisories/GHSA-7fhm-mqm4-2wp7)
 
 ## 1.1.0 [2020-03-13]
 
 ### Features
+
 1. [#152](https://github.com/influxdata/influxdb-client-js/issues/152): Set User-Agent to influxdb-client-js/VERSION for all requests
 
 ## 1.0.0 [2020-03-09]

diff --git a/packages/apis/generator/generateApi.ts b/packages/apis/generator/generateApi.ts
@@ -94,9 +94,9 @@ function generateClass(
   apiName: string,
   operations: Operation[]
 ): string {
-  let classDef = '/**\n'
+  let classDef = '/**\n * See\n'
   for (const operation of operations) {
-    classDef += ` * @see https://v2.docs.influxdata.com/v2.0/api/#operation/${getOperationId(
+    classDef += ` * * https://v2.docs.influxdata.com/v2.0/api/#operation/${getOperationId(
       operation
     )}\n`
   }
@@ -124,9 +124,9 @@ export class ${apiName} extends APIBase {
       classDef += '\n  /**'
     }
     classDef += `
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/${opId}
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/${opId}
    */
   ${decapitalize1(opId)}(request${
       requestRequired(operation) ? '' : '?'

diff --git a/packages/apis/src/generated/AuthorizationsAPI.ts b/packages/apis/src/generated/AuthorizationsAPI.ts
@@ -34,11 +34,12 @@ export interface DeleteAuthorizationsIDRequest {
   authID: string
 }
 /**
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/GetAuthorizations
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/PostAuthorizations
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/GetAuthorizationsID
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/PatchAuthorizationsID
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteAuthorizationsID
+ * See
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/GetAuthorizations
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/PostAuthorizations
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/GetAuthorizationsID
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/PatchAuthorizationsID
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteAuthorizationsID
  */
 export class AuthorizationsAPI extends APIBase {
   /**
@@ -49,9 +50,9 @@ export class AuthorizationsAPI extends APIBase {
   }
   /**
    * List all authorizations.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/GetAuthorizations
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/GetAuthorizations
    */
   getAuthorizations(
     request?: GetAuthorizationsRequest,
@@ -71,9 +72,9 @@ export class AuthorizationsAPI extends APIBase {
   }
   /**
    * Create an authorization.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/PostAuthorizations
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/PostAuthorizations
    */
   postAuthorizations(
     request: PostAuthorizationsRequest,
@@ -89,9 +90,9 @@ export class AuthorizationsAPI extends APIBase {
   }
   /**
    * Retrieve an authorization.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/GetAuthorizationsID
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/GetAuthorizationsID
    */
   getAuthorizationsID(
     request: GetAuthorizationsIDRequest,
@@ -106,9 +107,9 @@ export class AuthorizationsAPI extends APIBase {
   }
   /**
    * Update an authorization to be active or inactive.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/PatchAuthorizationsID
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/PatchAuthorizationsID
    */
   patchAuthorizationsID(
     request: PatchAuthorizationsIDRequest,
@@ -124,9 +125,9 @@ export class AuthorizationsAPI extends APIBase {
   }
   /**
    * Delete a authorization.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteAuthorizationsID
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteAuthorizationsID
    */
   deleteAuthorizationsID(
     request: DeleteAuthorizationsIDRequest,

diff --git a/packages/apis/src/generated/BucketsAPI.ts b/packages/apis/src/generated/BucketsAPI.ts
@@ -97,21 +97,22 @@ export interface GetBucketsIDLogsRequest {
   limit?: number
 }
 /**
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/GetBuckets
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/PostBuckets
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsID
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/PatchBucketsID
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteBucketsID
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsIDLabels
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/PostBucketsIDLabels
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteBucketsIDLabelsID
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsIDMembers
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/PostBucketsIDMembers
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteBucketsIDMembersID
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsIDOwners
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/PostBucketsIDOwners
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteBucketsIDOwnersID
- * @see https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsIDLogs
+ * See
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/GetBuckets
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/PostBuckets
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsID
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/PatchBucketsID
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteBucketsID
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsIDLabels
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/PostBucketsIDLabels
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteBucketsIDLabelsID
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsIDMembers
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/PostBucketsIDMembers
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteBucketsIDMembersID
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsIDOwners
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/PostBucketsIDOwners
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteBucketsIDOwnersID
+ * * https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsIDLogs
  */
 export class BucketsAPI extends APIBase {
   /**
@@ -122,9 +123,9 @@ export class BucketsAPI extends APIBase {
   }
   /**
    * List all buckets.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/GetBuckets
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/GetBuckets
    */
   getBuckets(
     request?: GetBucketsRequest,
@@ -145,9 +146,9 @@ export class BucketsAPI extends APIBase {
   }
   /**
    * Create a bucket.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/PostBuckets
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/PostBuckets
    */
   postBuckets(
     request: PostBucketsRequest,
@@ -163,9 +164,9 @@ export class BucketsAPI extends APIBase {
   }
   /**
    * Retrieve a bucket.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsID
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsID
    */
   getBucketsID(
     request: GetBucketsIDRequest,
@@ -180,9 +181,9 @@ export class BucketsAPI extends APIBase {
   }
   /**
    * Update a bucket.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/PatchBucketsID
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/PatchBucketsID
    */
   patchBucketsID(
     request: PatchBucketsIDRequest,
@@ -198,9 +199,9 @@ export class BucketsAPI extends APIBase {
   }
   /**
    * Delete a bucket.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteBucketsID
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteBucketsID
    */
   deleteBucketsID(
     request: DeleteBucketsIDRequest,
@@ -215,9 +216,9 @@ export class BucketsAPI extends APIBase {
   }
   /**
    * List all labels for a bucket.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsIDLabels
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsIDLabels
    */
   getBucketsIDLabels(
     request: GetBucketsIDLabelsRequest,
@@ -232,9 +233,9 @@ export class BucketsAPI extends APIBase {
   }
   /**
    * Add a label to a bucket.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/PostBucketsIDLabels
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/PostBucketsIDLabels
    */
   postBucketsIDLabels(
     request: PostBucketsIDLabelsRequest,
@@ -250,9 +251,9 @@ export class BucketsAPI extends APIBase {
   }
   /**
    * delete a label from a bucket.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteBucketsIDLabelsID
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteBucketsIDLabelsID
    */
   deleteBucketsIDLabelsID(
     request: DeleteBucketsIDLabelsIDRequest,
@@ -267,9 +268,9 @@ export class BucketsAPI extends APIBase {
   }
   /**
    * List all users with member privileges for a bucket.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsIDMembers
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsIDMembers
    */
   getBucketsIDMembers(
     request: GetBucketsIDMembersRequest,
@@ -284,9 +285,9 @@ export class BucketsAPI extends APIBase {
   }
   /**
    * Add a member to a bucket.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/PostBucketsIDMembers
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/PostBucketsIDMembers
    */
   postBucketsIDMembers(
     request: PostBucketsIDMembersRequest,
@@ -302,9 +303,9 @@ export class BucketsAPI extends APIBase {
   }
   /**
    * Remove a member from a bucket.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteBucketsIDMembersID
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteBucketsIDMembersID
    */
   deleteBucketsIDMembersID(
     request: DeleteBucketsIDMembersIDRequest,
@@ -319,9 +320,9 @@ export class BucketsAPI extends APIBase {
   }
   /**
    * List all owners of a bucket.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsIDOwners
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsIDOwners
    */
   getBucketsIDOwners(
     request: GetBucketsIDOwnersRequest,
@@ -336,9 +337,9 @@ export class BucketsAPI extends APIBase {
   }
   /**
    * Add an owner to a bucket.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/PostBucketsIDOwners
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/PostBucketsIDOwners
    */
   postBucketsIDOwners(
     request: PostBucketsIDOwnersRequest,
@@ -354,9 +355,9 @@ export class BucketsAPI extends APIBase {
   }
   /**
    * Remove an owner from a bucket.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteBucketsIDOwnersID
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/DeleteBucketsIDOwnersID
    */
   deleteBucketsIDOwnersID(
     request: DeleteBucketsIDOwnersIDRequest,
@@ -371,9 +372,9 @@ export class BucketsAPI extends APIBase {
   }
   /**
    * Retrieve operation logs for a bucket.
+   * See https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsIDLogs
    * @param request
    * @return promise of response
-   * @see https://v2.docs.influxdata.com/v2.0/api/#operation/GetBucketsIDLogs
    */
   getBucketsIDLogs(
     request: GetBucketsIDLogsRequest,