Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): use better links in code #173

Merged
merged 4 commits into from
Apr 15, 2020
+435 −402
Merged

fix(docs): use better links in code #173

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ad51307
fix(docs): use better links in code #172
sranka Apr 14, 2020
87063c1
chore: update changelog [skip CI]
sranka Apr 14, 2020
0dfd96a
chore: repair doc
sranka Apr 14, 2020
e2982cb
chore(doc): generate list of links
sranka Apr 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
4 changes: 2 additions & 2 deletions packages/apis/generator/generateApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ function generateClass(
): string {
let classDef = '/**\n'
for (const operation of operations) {
classDef += ` * @see https://v2.docs.influxdata.com/v2.0/api/#operation/${getOperationId(
classDef += ` * See https://v2.docs.influxdata.com/v2.0/api/#operation/${getOperationId(
operation
)}\n`
}
Expand Down Expand Up @@ -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) ? '' : '?'
Expand Down
20 changes: 10 additions & 10 deletions packages/apis/src/generated/AuthorizationsAPI.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ 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
* 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
*/
export class AuthorizationsAPI extends APIBase {
/**
Expand All @@ -49,9 +49,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,
Expand All @@ -71,9 +71,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,
Expand All @@ -89,9 +89,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,
Expand All @@ -106,9 +106,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,
Expand All @@ -124,9 +124,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,
Expand Down
60 changes: 30 additions & 30 deletions packages/apis/src/generated/BucketsAPI.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,21 +97,21 @@ 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
* 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
*/
export class BucketsAPI extends APIBase {
/**
Expand All @@ -122,9 +122,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,
Expand All @@ -145,9 +145,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,
Expand All @@ -163,9 +163,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,
Expand All @@ -180,9 +180,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,
Expand All @@ -198,9 +198,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,
Expand All @@ -215,9 +215,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,
Expand All @@ -232,9 +232,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,
Expand All @@ -250,9 +250,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,
Expand All @@ -267,9 +267,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,
Expand All @@ -284,9 +284,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,
Expand All @@ -302,9 +302,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,
Expand All @@ -319,9 +319,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,
Expand All @@ -336,9 +336,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,
Expand All @@ -354,9 +354,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,
Expand All @@ -371,9 +371,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,
Expand Down
Loading