From 61c5b4d5338321e46544f8810e44916b1bd071b6 Mon Sep 17 00:00:00 2001 From: Jeffrey Smith II Date: Thu, 29 Dec 2022 07:58:32 -0500 Subject: [PATCH] chore: update to go 1.19 (#465) * chore: upgrade go releaser to v1.13.1 (#464) * chore: update goreleaser and actually use go 1.19 * chore: format for go 1.19 Co-authored-by: Brandon Pfeifer --- .circleci/config.yml | 2 +- api/api_authorizations.gen.go | 34 +-- api/api_backup.gen.go | 9 +- api/api_bucket_schemas.gen.go | 46 +-- api/api_buckets.gen.go | 63 ++-- api/api_config.gen.go | 8 +- api/api_delete.gen.go | 29 +- api/api_invokable_scripts.gen.go | 37 +-- api/api_legacy_authorizations.gen.go | 8 +- api/api_organizations.gen.go | 142 ++++----- api/api_ping.gen.go | 16 +- api/api_signin.gen.go | 17 +- api/api_tasks.gen.go | 211 ++++++------- api/api_users.gen.go | 84 +++--- api/api_write.gen.go | 32 +- scripts/ci/download-goreleaser.sh | 431 ++------------------------- scripts/ci/install-go.sh | 10 +- 17 files changed, 408 insertions(+), 771 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 35fd4eee..75a360f7 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -251,7 +251,7 @@ commands: steps: - run: name: Install goreleaser - command: ./scripts/ci/download-goreleaser.sh -b ${GOPATH}/bin v0.165.0 + command: ./scripts/ci/download-goreleaser.sh v1.14.0 jobs: lint: diff --git a/api/api_authorizations.gen.go b/api/api_authorizations.gen.go index f833d7e4..4d92f68b 100644 --- a/api/api_authorizations.gen.go +++ b/api/api_authorizations.gen.go @@ -383,18 +383,18 @@ func (r ApiGetAuthorizationsRequest) ExecuteWithHttpInfo() (Authorizations, *_ne } /* - * GetAuthorizations List authorizations - * Retrieves a list of authorizations. + - GetAuthorizations List authorizations + - Retrieves a list of authorizations. To limit which authorizations are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all authorizations. #### InfluxDB OSS -- Returns - [API token]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#token) values in authorizations. -- If the request uses an _[operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_, - InfluxDB OSS returns authorizations for all organizations in the instance. + - Returns + [API token]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#token) values in authorizations. + - If the request uses an _[operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_, + InfluxDB OSS returns authorizations for all organizations in the instance. #### Required permissions @@ -404,8 +404,8 @@ If no query parameters are passed, InfluxDB returns all authorizations. - [View tokens]({{% INFLUXDB_DOCS_URL %}}/security/tokens/view-tokens/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiGetAuthorizationsRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiGetAuthorizationsRequest */ func (a *AuthorizationsApiService) GetAuthorizations(ctx _context.Context) ApiGetAuthorizationsRequest { return ApiGetAuthorizationsRequest{ @@ -940,8 +940,8 @@ func (r ApiPostAuthorizationsRequest) ExecuteWithHttpInfo() (Authorization, *_ne } /* - * PostAuthorizations Create an authorization - * Creates an authorization. + - PostAuthorizations Create an authorization + - Creates an authorization. Use this endpoint to create an authorization, which generates an API token with permissions to `read` or `write` to a specific resource or `type` of resource. @@ -955,11 +955,11 @@ Keep the following in mind when creating and updating authorizations: #### Limitations -- In InfluxDB OSS, API tokens are visible to the user who created the authorization and to any - user with an _[operator token]({{% INFLUXDB_DOCS_URL %}}/security/tokens/#operator-token)_. -- Even if an API token has `read-authorizations` permission, the - token can't be used to view its authorization details. -- Tokens stop working when the user who created the token is deleted. + - In InfluxDB OSS, API tokens are visible to the user who created the authorization and to any + user with an _[operator token]({{% INFLUXDB_DOCS_URL %}}/security/tokens/#operator-token)_. + - Even if an API token has `read-authorizations` permission, the + token can't be used to view its authorization details. + - Tokens stop working when the user who created the token is deleted. We recommend creating a generic user to create and manage tokens for writing data. @@ -967,8 +967,8 @@ We recommend creating a generic user to create and manage tokens for writing dat - [Create a token]({{% INFLUXDB_DOCS_URL %}}/security/tokens/create-token/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiPostAuthorizationsRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiPostAuthorizationsRequest */ func (a *AuthorizationsApiService) PostAuthorizations(ctx _context.Context) ApiPostAuthorizationsRequest { return ApiPostAuthorizationsRequest{ diff --git a/api/api_backup.gen.go b/api/api_backup.gen.go index cfab5984..35b78474 100644 --- a/api/api_backup.gen.go +++ b/api/api_backup.gen.go @@ -122,13 +122,14 @@ func (r ApiGetBackupKVRequest) ExecuteWithHttpInfo() (*_nethttp.Response, *_neth } /* - * GetBackupKV Download snapshot of metadata stored in the server's embedded KV store. Don't use with InfluxDB versions greater than InfluxDB 2.1.x. - * Retrieves a snapshot of metadata stored in the server's embedded KV store. + - GetBackupKV Download snapshot of metadata stored in the server's embedded KV store. Don't use with InfluxDB versions greater than InfluxDB 2.1.x. + - Retrieves a snapshot of metadata stored in the server's embedded KV store. + InfluxDB versions greater than 2.1.x don't include metadata stored in embedded SQL; avoid using this endpoint with versions greater than 2.1.x. - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiGetBackupKVRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiGetBackupKVRequest */ func (a *BackupApiService) GetBackupKV(ctx _context.Context) ApiGetBackupKVRequest { return ApiGetBackupKVRequest{ diff --git a/api/api_bucket_schemas.gen.go b/api/api_bucket_schemas.gen.go index edfd8c8d..f1ab9575 100644 --- a/api/api_bucket_schemas.gen.go +++ b/api/api_bucket_schemas.gen.go @@ -221,8 +221,9 @@ func (r ApiCreateMeasurementSchemaRequest) ExecuteWithHttpInfo() (MeasurementSch } /* - * CreateMeasurementSchema Create a measurement schema for a bucket - * Creates an _explict_ measurement [schema]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#schema) + - CreateMeasurementSchema Create a measurement schema for a bucket + - Creates an _explict_ measurement [schema]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#schema) + for a bucket. _Explicit_ schemas are used to enforce column names, tags, fields, and data @@ -243,9 +244,9 @@ schemas. - [Manage bucket schemas]({{% INFLUXDB_DOCS_URL %}}/organizations/buckets/bucket-schema/). - [Create a bucket with an explicit schema]({{% INFLUXDB_DOCS_URL %}}/organizations/buckets/create-bucket/#create-a-bucket-with-an-explicit-schema) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param bucketID A bucket ID. Adds a schema for the specified bucket. - * @return ApiCreateMeasurementSchemaRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param bucketID A bucket ID. Adds a schema for the specified bucket. + - @return ApiCreateMeasurementSchemaRequest */ func (a *BucketSchemasApiService) CreateMeasurementSchema(ctx _context.Context, bucketID string) ApiCreateMeasurementSchemaRequest { return ApiCreateMeasurementSchemaRequest{ @@ -443,13 +444,13 @@ func (r ApiGetMeasurementSchemaRequest) ExecuteWithHttpInfo() (MeasurementSchema } /* - * GetMeasurementSchema Retrieve a measurement schema - * Retrieves an explicit measurement [schema]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#schema). +* GetMeasurementSchema Retrieve a measurement schema +* Retrieves an explicit measurement [schema]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#schema). - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param bucketID A bucket ID. Retrieves schemas for the specified bucket. - * @param measurementID The measurement schema ID. Specifies the measurement schema to retrieve. - * @return ApiGetMeasurementSchemaRequest +* @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +* @param bucketID A bucket ID. Retrieves schemas for the specified bucket. +* @param measurementID The measurement schema ID. Specifies the measurement schema to retrieve. +* @return ApiGetMeasurementSchemaRequest */ func (a *BucketSchemasApiService) GetMeasurementSchema(ctx _context.Context, bucketID string, measurementID string) ApiGetMeasurementSchemaRequest { return ApiGetMeasurementSchemaRequest{ @@ -636,8 +637,9 @@ func (r ApiGetMeasurementSchemasRequest) ExecuteWithHttpInfo() (MeasurementSchem } /* - * GetMeasurementSchemas List measurement schemas of a bucket - * Retrieves a list of _explicit_ + - GetMeasurementSchemas List measurement schemas of a bucket + - Retrieves a list of _explicit_ + [schemas]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#schema) (`"schemaType": "explicit"`) for a bucket. @@ -651,9 +653,9 @@ that conforms to your data. - [Using bucket schemas](https://www.influxdata.com/blog/new-bucket-schema-option-protect-from-unwanted-schema-changes/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param bucketID A bucket ID. Lists measurement schemas for the specified bucket. - * @return ApiGetMeasurementSchemasRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param bucketID A bucket ID. Lists measurement schemas for the specified bucket. + - @return ApiGetMeasurementSchemasRequest */ func (a *BucketSchemasApiService) GetMeasurementSchemas(ctx _context.Context, bucketID string) ApiGetMeasurementSchemasRequest { return ApiGetMeasurementSchemasRequest{ @@ -861,8 +863,8 @@ func (r ApiUpdateMeasurementSchemaRequest) ExecuteWithHttpInfo() (MeasurementSch } /* - * UpdateMeasurementSchema Update a measurement schema - * Updates a measurement [schema]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#schema). + - UpdateMeasurementSchema Update a measurement schema + - Updates a measurement [schema]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#schema). Use this endpoint to update the fields (`name`, `type`, and `dataType`) of a measurement schema. @@ -876,10 +878,10 @@ measurement schema. - [Manage bucket schemas]({{% INFLUXDB_DOCS_URL %}}/organizations/buckets/bucket-schema/). - [Using bucket schemas](https://www.influxdata.com/blog/new-bucket-schema-option-protect-from-unwanted-schema-changes/). - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param bucketID A bucket ID. Specifies the bucket to retrieve schemas for. - * @param measurementID A measurement schema ID. Retrieves the specified measurement schema. - * @return ApiUpdateMeasurementSchemaRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param bucketID A bucket ID. Specifies the bucket to retrieve schemas for. + - @param measurementID A measurement schema ID. Retrieves the specified measurement schema. + - @return ApiUpdateMeasurementSchemaRequest */ func (a *BucketSchemasApiService) UpdateMeasurementSchema(ctx _context.Context, bucketID string, measurementID string) ApiUpdateMeasurementSchemaRequest { return ApiUpdateMeasurementSchemaRequest{ diff --git a/api/api_buckets.gen.go b/api/api_buckets.gen.go index c43f422b..d1dada1d 100644 --- a/api/api_buckets.gen.go +++ b/api/api_buckets.gen.go @@ -271,16 +271,16 @@ func (r ApiDeleteBucketsIDRequest) ExecuteWithHttpInfo() (*_nethttp.Response, er } /* - * DeleteBucketsID Delete a bucket - * Deletes a bucket and all associated records. + - DeleteBucketsID Delete a bucket + - Deletes a bucket and all associated records. #### InfluxDB Cloud - Does the following when you send a delete request: - 1. Validates the request and queues the delete. - 2. Returns an HTTP `204` status code if queued; _error_ otherwise. - 3. Handles the delete asynchronously. + 1. Validates the request and queues the delete. + 2. Returns an HTTP `204` status code if queued; _error_ otherwise. + 3. Handles the delete asynchronously. #### InfluxDB OSS @@ -295,9 +295,9 @@ and then responds with success or failure. - [Delete a bucket]({{% INFLUXDB_DOCS_URL %}}/organizations/buckets/delete-bucket/#delete-a-bucket-in-the-influxdb-ui) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param bucketID Bucket ID. The ID of the bucket to delete. - * @return ApiDeleteBucketsIDRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param bucketID Bucket ID. The ID of the bucket to delete. + - @return ApiDeleteBucketsIDRequest */ func (a *BucketsApiService) DeleteBucketsID(ctx _context.Context, bucketID string) ApiDeleteBucketsIDRequest { return ApiDeleteBucketsIDRequest{ @@ -523,8 +523,8 @@ func (r ApiGetBucketsRequest) ExecuteWithHttpInfo() (Buckets, *_nethttp.Response } /* - * GetBuckets List buckets - * Retrieves a list of [buckets]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#bucket). + - GetBuckets List buckets + - Retrieves a list of [buckets]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#bucket). InfluxDB retrieves buckets owned by the [organization]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#organization) @@ -540,11 +540,11 @@ default `limit`. #### InfluxDB OSS -- If you use an _[operator token]({{% INFLUXDB_DOCS_URL %}}/security/tokens/#operator-token)_ - to authenticate your request, InfluxDB retrieves resources for _all - organizations_ in the instance. - To retrieve resources for only a specific organization, use the - `org` parameter or the `orgID` parameter to specify the organization. + - If you use an _[operator token]({{% INFLUXDB_DOCS_URL %}}/security/tokens/#operator-token)_ + to authenticate your request, InfluxDB retrieves resources for _all + organizations_ in the instance. + To retrieve resources for only a specific organization, use the + `org` parameter or the `orgID` parameter to specify the organization. #### Required permissions @@ -557,8 +557,8 @@ default `limit`. - [Manage buckets]({{% INFLUXDB_DOCS_URL %}}/organizations/buckets/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiGetBucketsRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiGetBucketsRequest */ func (a *BucketsApiService) GetBuckets(ctx _context.Context) ApiGetBucketsRequest { return ApiGetBucketsRequest{ @@ -749,14 +749,14 @@ func (r ApiGetBucketsIDRequest) ExecuteWithHttpInfo() (Bucket, *_nethttp.Respons } /* - * GetBucketsID Retrieve a bucket - * Retrieves a bucket. + - GetBucketsID Retrieve a bucket + - Retrieves a bucket. Use this endpoint to retrieve information for a specific bucket. - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param bucketID The ID of the bucket to retrieve. - * @return ApiGetBucketsIDRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param bucketID The ID of the bucket to retrieve. + - @return ApiGetBucketsIDRequest */ func (a *BucketsApiService) GetBucketsID(ctx _context.Context, bucketID string) ApiGetBucketsIDRequest { return ApiGetBucketsIDRequest{ @@ -948,8 +948,8 @@ func (r ApiPatchBucketsIDRequest) ExecuteWithHttpInfo() (Bucket, *_nethttp.Respo } /* - * PatchBucketsID Update a bucket - * Updates a bucket. + - PatchBucketsID Update a bucket + - Updates a bucket. Use this endpoint to update properties (`name`, `description`, and `retentionRules`) of a bucket. @@ -967,9 +967,9 @@ provide `retentionRules`, InfluxDB responds with an HTTP `403` status code. - [Update a bucket]({{% INFLUXDB_DOCS_URL %}}/organizations/buckets/update-bucket/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param bucketID The bucket ID. - * @return ApiPatchBucketsIDRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param bucketID The bucket ID. + - @return ApiPatchBucketsIDRequest */ func (a *BucketsApiService) PatchBucketsID(ctx _context.Context, bucketID string) ApiPatchBucketsIDRequest { return ApiPatchBucketsIDRequest{ @@ -1179,8 +1179,9 @@ func (r ApiPostBucketsRequest) ExecuteWithHttpInfo() (Bucket, *_nethttp.Response } /* - * PostBuckets Create a bucket - * Creates a [bucket]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#bucket) + - PostBuckets Create a bucket + - Creates a [bucket]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#bucket) + and returns the bucket resource. The default data [retention period]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#retention-period) @@ -1205,8 +1206,8 @@ For additional information regarding InfluxDB Cloud offerings, see - [Create a bucket]({{% INFLUXDB_DOCS_URL %}}/organizations/buckets/create-bucket/) - [Create bucket CLI reference]({{% INFLUXDB_DOCS_URL %}}/reference/cli/influx/bucket/create) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiPostBucketsRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiPostBucketsRequest */ func (a *BucketsApiService) PostBuckets(ctx _context.Context) ApiPostBucketsRequest { return ApiPostBucketsRequest{ diff --git a/api/api_config.gen.go b/api/api_config.gen.go index c86fc0ae..02c7df9d 100644 --- a/api/api_config.gen.go +++ b/api/api_config.gen.go @@ -82,8 +82,8 @@ func (r ApiGetConfigRequest) ExecuteWithHttpInfo() (Config, *_nethttp.Response, } /* - * GetConfig Retrieve runtime configuration - * Returns the active runtime configuration of the InfluxDB instance. + - GetConfig Retrieve runtime configuration + - Returns the active runtime configuration of the InfluxDB instance. In InfluxDB v2.2+, use this endpoint to view your active runtime configuration, including flags and environment variables. @@ -92,8 +92,8 @@ including flags and environment variables. - [View your runtime server configuration]({{% INFLUXDB_DOCS_URL %}}/reference/config-options/#view-your-runtime-server-configuration) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiGetConfigRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiGetConfigRequest */ func (a *ConfigApiService) GetConfig(ctx _context.Context) ApiGetConfigRequest { return ApiGetConfigRequest{ diff --git a/api/api_delete.gen.go b/api/api_delete.gen.go index 520d80ed..3b47e7ff 100644 --- a/api/api_delete.gen.go +++ b/api/api_delete.gen.go @@ -157,8 +157,8 @@ func (r ApiPostDeleteRequest) ExecuteWithHttpInfo() (*_nethttp.Response, error) } /* - * PostDelete Delete data - * Deletes data from a bucket. + - PostDelete Delete data + - Deletes data from a bucket. Use this endpoint to delete points from a bucket in a specified time range. @@ -166,9 +166,9 @@ Use this endpoint to delete points from a bucket in a specified time range. - Does the following when you send a delete request: - 1. Validates the request and queues the delete. - 2. If queued, responds with _success_ (HTTP `2xx` status code); _error_ otherwise. - 3. Handles the delete asynchronously and reaches eventual consistency. + 1. Validates the request and queues the delete. + 2. If queued, responds with _success_ (HTTP `2xx` status code); _error_ otherwise. + 3. Handles the delete asynchronously and reaches eventual consistency. To ensure that InfluxDB Cloud handles writes and deletes in the order you request them, wait for a success response (HTTP `2xx` status code) before you send the next request. @@ -178,8 +178,8 @@ when you receive the response. #### InfluxDB OSS -- Validates the request, handles the delete synchronously, - and then responds with success or failure. + - Validates the request, handles the delete synchronously, + and then responds with success or failure. #### Required permissions @@ -194,13 +194,16 @@ For more information, see [limits and adjustable quotas](https://docs.influxdata #### Related guides -- [Delete data]({{% INFLUXDB_DOCS_URL %}}/write-data/delete-data/) -- Learn how to use [delete predicate syntax]({{% INFLUXDB_DOCS_URL %}}/reference/syntax/delete-predicate/). -- Learn how InfluxDB handles [deleted tags](https://docs.influxdata.com/flux/v0.x/stdlib/influxdata/influxdb/schema/measurementtagkeys/) - and [deleted fields](https://docs.influxdata.com/flux/v0.x/stdlib/influxdata/influxdb/schema/measurementfieldkeys/). + - [Delete data]({{% INFLUXDB_DOCS_URL %}}/write-data/delete-data/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiPostDeleteRequest + - Learn how to use [delete predicate syntax]({{% INFLUXDB_DOCS_URL %}}/reference/syntax/delete-predicate/). + + - Learn how InfluxDB handles [deleted tags](https://docs.influxdata.com/flux/v0.x/stdlib/influxdata/influxdb/schema/measurementtagkeys/) + and [deleted fields](https://docs.influxdata.com/flux/v0.x/stdlib/influxdata/influxdb/schema/measurementfieldkeys/). + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + + - @return ApiPostDeleteRequest */ func (a *DeleteApiService) PostDelete(ctx _context.Context) ApiPostDeleteRequest { return ApiPostDeleteRequest{ diff --git a/api/api_invokable_scripts.gen.go b/api/api_invokable_scripts.gen.go index 331b130b..33bd7db0 100644 --- a/api/api_invokable_scripts.gen.go +++ b/api/api_invokable_scripts.gen.go @@ -382,15 +382,15 @@ func (r ApiGetScriptsRequest) ExecuteWithHttpInfo() (Scripts, *_nethttp.Response } /* - * GetScripts List scripts - * Retrieves a list of [scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/). + - GetScripts List scripts + - Retrieves a list of [scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/). #### Related guides - [Invoke custom scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiGetScriptsRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiGetScriptsRequest */ func (a *InvokableScriptsApiService) GetScripts(ctx _context.Context) ApiGetScriptsRequest { return ApiGetScriptsRequest{ @@ -582,12 +582,12 @@ func (r ApiGetScriptsIDRequest) ExecuteWithHttpInfo() (Script, *_nethttp.Respons } /* - * GetScriptsID Retrieve a script - * Retrieves a [script](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/). +* GetScriptsID Retrieve a script +* Retrieves a [script](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/). - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param scriptID A script ID. Retrieves the specified script. - * @return ApiGetScriptsIDRequest +* @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +* @param scriptID A script ID. Retrieves the specified script. +* @return ApiGetScriptsIDRequest */ func (a *InvokableScriptsApiService) GetScriptsID(ctx _context.Context, scriptID string) ApiGetScriptsIDRequest { return ApiGetScriptsIDRequest{ @@ -756,14 +756,14 @@ func (r ApiPatchScriptsIDRequest) ExecuteWithHttpInfo() (Script, *_nethttp.Respo } /* - * PatchScriptsID Update a script - * Updates a [script](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/) and returns the script. + - PatchScriptsID Update a script + - Updates a [script](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/) and returns the script. Use this endpoint to update the properties (`name`, `description`, and `script`) of an invokable script. - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param scriptID A script ID. Updates the specified script. - * @return ApiPatchScriptsIDRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param scriptID A script ID. Updates the specified script. + - @return ApiPatchScriptsIDRequest */ func (a *InvokableScriptsApiService) PatchScriptsID(ctx _context.Context, scriptID string) ApiPatchScriptsIDRequest { return ApiPatchScriptsIDRequest{ @@ -928,8 +928,9 @@ func (r ApiPostScriptsRequest) ExecuteWithHttpInfo() (Script, *_nethttp.Response } /* - * PostScripts Create a script - * Creates an [invokable script](https://docs.influxdata.com/resources/videos/api-invokable-scripts/) + - PostScripts Create a script + - Creates an [invokable script](https://docs.influxdata.com/resources/videos/api-invokable-scripts/) + and returns the script. #### Related guides @@ -937,8 +938,8 @@ and returns the script. - [Invokable scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/) - [Creating custom InfluxDB endpoints](https://docs.influxdata.com/resources/videos/api-invokable-scripts/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiPostScriptsRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiPostScriptsRequest */ func (a *InvokableScriptsApiService) PostScripts(ctx _context.Context) ApiPostScriptsRequest { return ApiPostScriptsRequest{ diff --git a/api/api_legacy_authorizations.gen.go b/api/api_legacy_authorizations.gen.go index e7b428a5..b35cc46c 100644 --- a/api/api_legacy_authorizations.gen.go +++ b/api/api_legacy_authorizations.gen.go @@ -904,8 +904,8 @@ func (r ApiPostLegacyAuthorizationsRequest) ExecuteWithHttpInfo() (Authorization } /* - * PostLegacyAuthorizations Create a legacy authorization - * Creates a legacy authorization and returns the legacy authorization. + - PostLegacyAuthorizations Create a legacy authorization + - Creates a legacy authorization and returns the legacy authorization. #### Required permissions @@ -913,8 +913,8 @@ func (r ApiPostLegacyAuthorizationsRequest) ExecuteWithHttpInfo() (Authorization *`USER_ID`* is the ID of the user that you want to scope the authorization to. - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiPostLegacyAuthorizationsRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiPostLegacyAuthorizationsRequest */ func (a *LegacyAuthorizationsApiService) PostLegacyAuthorizations(ctx _context.Context) ApiPostLegacyAuthorizationsRequest { return ApiPostLegacyAuthorizationsRequest{ diff --git a/api/api_organizations.gen.go b/api/api_organizations.gen.go index f3e6e003..51c9dca7 100644 --- a/api/api_organizations.gen.go +++ b/api/api_organizations.gen.go @@ -519,8 +519,8 @@ func (r ApiDeleteOrgsIDRequest) ExecuteWithHttpInfo() (*_nethttp.Response, error } /* - * DeleteOrgsID Delete an organization - * Deletes an organization. + - DeleteOrgsID Delete an organization + - Deletes an organization. Deleting an organization from InfluxDB Cloud can't be undone. Once deleted, all data associated with the organization is removed. @@ -529,9 +529,9 @@ Once deleted, all data associated with the organization is removed. - Does the following when you send a delete request: - 1. Validates the request and queues the delete. - 2. Returns an HTTP `204` status code if queued; _error_ otherwise. - 3. Handles the delete asynchronously. + 1. Validates the request and queues the delete. + 2. Returns an HTTP `204` status code if queued; _error_ otherwise. + 3. Handles the delete asynchronously. #### InfluxDB OSS @@ -546,9 +546,9 @@ and then responds with success or failure. - [Delete organizations]({{% INFLUXDB_DOCS_URL %}}/organizations/delete-orgs/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param orgID The ID of the organization to delete. - * @return ApiDeleteOrgsIDRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param orgID The ID of the organization to delete. + - @return ApiDeleteOrgsIDRequest */ func (a *OrganizationsApiService) DeleteOrgsID(ctx _context.Context, orgID string) ApiDeleteOrgsIDRequest { return ApiDeleteOrgsIDRequest{ @@ -718,16 +718,16 @@ func (r ApiDeleteOrgsIDMembersIDRequest) ExecuteWithHttpInfo() (*_nethttp.Respon } /* - * DeleteOrgsIDMembersID Remove a member from an organization - * Removes a member from an organization. + - DeleteOrgsIDMembersID Remove a member from an organization + - Removes a member from an organization. Use this endpoint to remove a user's member privileges from a bucket. This removes the user's `read` and `write` permissions from the organization. #### InfluxDB Cloud -- Doesn't use `owner` and `member` roles. - Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. + - Doesn't use `owner` and `member` roles. + Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. #### Limitations @@ -745,10 +745,10 @@ owner from. - [Manage members]({{% INFLUXDB_DOCS_URL %}}/organizations/members/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param userID The ID of the user to remove. - * @param orgID The ID of the organization to remove a user from. - * @return ApiDeleteOrgsIDMembersIDRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param userID The ID of the user to remove. + - @param orgID The ID of the organization to remove a user from. + - @return ApiDeleteOrgsIDMembersIDRequest */ func (a *OrganizationsApiService) DeleteOrgsIDMembersID(ctx _context.Context, userID string, orgID string) ApiDeleteOrgsIDMembersIDRequest { return ApiDeleteOrgsIDMembersIDRequest{ @@ -909,16 +909,17 @@ func (r ApiDeleteOrgsIDOwnersIDRequest) ExecuteWithHttpInfo() (*_nethttp.Respons } /* - * DeleteOrgsIDOwnersID Remove an owner from an organization - * Removes an [owner]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#owner) from + - DeleteOrgsIDOwnersID Remove an owner from an organization + - Removes an [owner]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#owner) from + the organization. Organization owners have permission to delete organizations and remove user and member permissions from the organization. #### InfluxDB Cloud -- Doesn't use `owner` and `member` roles. - Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. + - Doesn't use `owner` and `member` roles. + Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. #### Limitations @@ -935,10 +936,10 @@ remove an owner from. #### Related endpoints - [Authorizations](#tag/Authorizations) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param userID The ID of the user to remove. - * @param orgID The ID of the organization to remove an owner from. - * @return ApiDeleteOrgsIDOwnersIDRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param userID The ID of the user to remove. + - @param orgID The ID of the organization to remove an owner from. + - @return ApiDeleteOrgsIDOwnersIDRequest */ func (a *OrganizationsApiService) DeleteOrgsIDOwnersID(ctx _context.Context, userID string, orgID string) ApiDeleteOrgsIDOwnersIDRequest { return ApiDeleteOrgsIDOwnersIDRequest{ @@ -1135,8 +1136,8 @@ func (r ApiGetOrgsRequest) ExecuteWithHttpInfo() (Organizations, *_nethttp.Respo } /* - * GetOrgs List organizations - * Retrieves a list of [organizations]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#organization/). + - GetOrgs List organizations + - Retrieves a list of [organizations]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#organization/). To limit which organizations are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all organizations up to the default `limit`. @@ -1149,8 +1150,8 @@ If no query parameters are passed, InfluxDB returns all organizations up to the - [View organizations]({{% INFLUXDB_DOCS_URL %}}/organizations/view-orgs/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiGetOrgsRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiGetOrgsRequest */ func (a *OrganizationsApiService) GetOrgs(ctx _context.Context) ApiGetOrgsRequest { return ApiGetOrgsRequest{ @@ -1371,8 +1372,8 @@ func (r ApiGetOrgsIDRequest) ExecuteWithHttpInfo() (Organization, *_nethttp.Resp } /* - * GetOrgsID Retrieve an organization - * Retrieves an organization. + - GetOrgsID Retrieve an organization + - Retrieves an organization. Use this endpoint to retrieve information for a specific organization. @@ -1380,9 +1381,9 @@ Use this endpoint to retrieve information for a specific organization. - [View organizations]({{% INFLUXDB_DOCS_URL %}}/organizations/view-orgs/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param orgID The ID of the organization to retrieve. - * @return ApiGetOrgsIDRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param orgID The ID of the organization to retrieve. + - @return ApiGetOrgsIDRequest */ func (a *OrganizationsApiService) GetOrgsID(ctx _context.Context, orgID string) ApiGetOrgsIDRequest { return ApiGetOrgsIDRequest{ @@ -1565,8 +1566,8 @@ func (r ApiGetOrgsIDMembersRequest) ExecuteWithHttpInfo() (ResourceMembers, *_ne } /* - * GetOrgsIDMembers List all members of an organization - * Retrieves a list of all users that belong to an organization. + - GetOrgsIDMembers List all members of an organization + - Retrieves a list of all users that belong to an organization. InfluxDB [users]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user) have permission to access InfluxDB. @@ -1576,8 +1577,8 @@ within the organization. #### InfluxDB Cloud -- Doesn't use `owner` and `member` roles. - Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. + - Doesn't use `owner` and `member` roles. + Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. #### Limitations @@ -1596,9 +1597,9 @@ members for. - [Manage users]({{% INFLUXDB_DOCS_URL %}}/users/) - [Manage members]({{% INFLUXDB_DOCS_URL %}}/organizations/members/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param orgID The ID of the organization to retrieve users for. - * @return ApiGetOrgsIDMembersRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param orgID The ID of the organization to retrieve users for. + - @return ApiGetOrgsIDMembersRequest */ func (a *OrganizationsApiService) GetOrgsIDMembers(ctx _context.Context, orgID string) ApiGetOrgsIDMembersRequest { return ApiGetOrgsIDMembersRequest{ @@ -1781,13 +1782,13 @@ func (r ApiGetOrgsIDOwnersRequest) ExecuteWithHttpInfo() (ResourceOwners, *_neth } /* - * GetOrgsIDOwners List all owners of an organization - * Retrieves a list of all owners of an organization. + - GetOrgsIDOwners List all owners of an organization + - Retrieves a list of all owners of an organization. #### InfluxDB Cloud -- Doesn't use `owner` and `member` roles. - Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. + - Doesn't use `owner` and `member` roles. + Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. #### Required permissions @@ -1796,9 +1797,9 @@ func (r ApiGetOrgsIDOwnersRequest) ExecuteWithHttpInfo() (ResourceOwners, *_neth *`INFLUX_ORG_ID`* is the ID of the organization that you want to retrieve a list of owners from. - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param orgID The ID of the organization to list owners for. - * @return ApiGetOrgsIDOwnersRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param orgID The ID of the organization to list owners for. + - @return ApiGetOrgsIDOwnersRequest */ func (a *OrganizationsApiService) GetOrgsIDOwners(ctx _context.Context, orgID string) ApiGetOrgsIDOwnersRequest { return ApiGetOrgsIDOwnersRequest{ @@ -1979,8 +1980,8 @@ func (r ApiPatchOrgsIDRequest) ExecuteWithHttpInfo() (Organization, *_nethttp.Re } /* - * PatchOrgsID Update an organization - * Updates an organization. + - PatchOrgsID Update an organization + - Updates an organization. Use this endpoint to update properties (`name`, `description`) of an organization. @@ -2001,9 +2002,9 @@ in these resources as well. - [Update an organization]({{% INFLUXDB_DOCS_URL %}}/organizations/update-org/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param orgID The ID of the organization to update. - * @return ApiPatchOrgsIDRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param orgID The ID of the organization to update. + - @return ApiPatchOrgsIDRequest */ func (a *OrganizationsApiService) PatchOrgsID(ctx _context.Context, orgID string) ApiPatchOrgsIDRequest { return ApiPatchOrgsIDRequest{ @@ -2180,8 +2181,9 @@ func (r ApiPostOrgsRequest) ExecuteWithHttpInfo() (Organization, *_nethttp.Respo } /* - * PostOrgs Create an organization - * Creates an [organization]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#organization) + - PostOrgs Create an organization + - Creates an [organization]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#organization) + and returns the newly created organization. #### InfluxDB Cloud @@ -2192,8 +2194,8 @@ and returns the newly created organization. - [Manage organizations]({{% INFLUXDB_DOCS_URL %}}/organizations) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiPostOrgsRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiPostOrgsRequest */ func (a *OrganizationsApiService) PostOrgs(ctx _context.Context) ApiPostOrgsRequest { return ApiPostOrgsRequest{ @@ -2377,8 +2379,8 @@ func (r ApiPostOrgsIDMembersRequest) ExecuteWithHttpInfo() (ResourceMember, *_ne } /* - * PostOrgsIDMembers Add a member to an organization - * Add a user to an organization. + - PostOrgsIDMembers Add a member to an organization + - Add a user to an organization. InfluxDB [users]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user) have permission to access InfluxDB. @@ -2387,8 +2389,8 @@ permission to access InfluxDB. within the organization. #### InfluxDB Cloud -- Doesn't use `owner` and `member` roles. - Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. + - Doesn't use `owner` and `member` roles. + Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. #### Limitations @@ -2406,9 +2408,9 @@ within the organization. - [Manage users]({{% INFLUXDB_DOCS_URL %}}/users/) - [Manage members]({{% INFLUXDB_DOCS_URL %}}/organizations/members/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param orgID The ID of the organization. - * @return ApiPostOrgsIDMembersRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param orgID The ID of the organization. + - @return ApiPostOrgsIDMembersRequest */ func (a *OrganizationsApiService) PostOrgsIDMembers(ctx _context.Context, orgID string) ApiPostOrgsIDMembersRequest { return ApiPostOrgsIDMembersRequest{ @@ -2594,15 +2596,15 @@ func (r ApiPostOrgsIDOwnersRequest) ExecuteWithHttpInfo() (ResourceOwner, *_neth } /* - * PostOrgsIDOwners Add an owner to an organization - * Adds an owner to an organization. + - PostOrgsIDOwners Add an owner to an organization + - Adds an owner to an organization. Use this endpoint to assign the organization `owner` role to a user. #### InfluxDB Cloud -- Doesn't use `owner` and `member` roles. - Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. + - Doesn't use `owner` and `member` roles. + Use [`/api/v2/authorizations`](#tag/Authorizations) to assign user permissions. #### Required permissions @@ -2614,9 +2616,9 @@ Use this endpoint to assign the organization `owner` role to a user. - [Authorizations](#tag/Authorizations) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param orgID The ID of the organization that you want to add an owner for. - * @return ApiPostOrgsIDOwnersRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param orgID The ID of the organization that you want to add an owner for. + - @return ApiPostOrgsIDOwnersRequest */ func (a *OrganizationsApiService) PostOrgsIDOwners(ctx _context.Context, orgID string) ApiPostOrgsIDOwnersRequest { return ApiPostOrgsIDOwnersRequest{ diff --git a/api/api_ping.gen.go b/api/api_ping.gen.go index 1e61b641..2cfbefbc 100644 --- a/api/api_ping.gen.go +++ b/api/api_ping.gen.go @@ -106,8 +106,8 @@ func (r ApiGetPingRequest) ExecuteWithHttpInfo() (*_nethttp.Response, error) { } /* - * GetPing Get the status of the instance - * Retrieves the status and InfluxDB version of the instance. + - GetPing Get the status of the instance + - Retrieves the status and InfluxDB version of the instance. Use this endpoint to monitor uptime for the InfluxDB instance. The response returns a HTTP `204` status code to inform you the instance is available. @@ -120,8 +120,8 @@ returns a HTTP `204` status code to inform you the instance is available. - [Influx ping]({{% INFLUXDB_DOCS_URL %}}/reference/cli/influx/ping/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiGetPingRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiGetPingRequest */ func (a *PingApiService) GetPing(ctx _context.Context) ApiGetPingRequest { return ApiGetPingRequest{ @@ -229,8 +229,8 @@ func (r ApiHeadPingRequest) ExecuteWithHttpInfo() (*_nethttp.Response, error) { } /* - * HeadPing Get the status of the instance - * Returns the status and InfluxDB version of the instance. + - HeadPing Get the status of the instance + - Returns the status and InfluxDB version of the instance. Use this endpoint to monitor uptime for the InfluxDB instance. The response returns a HTTP `204` status code to inform you the instance is available. @@ -243,8 +243,8 @@ returns a HTTP `204` status code to inform you the instance is available. - [Influx ping]({{% INFLUXDB_DOCS_URL %}}/reference/cli/influx/ping/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiHeadPingRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiHeadPingRequest */ func (a *PingApiService) HeadPing(ctx _context.Context) ApiHeadPingRequest { return ApiHeadPingRequest{ diff --git a/api/api_signin.gen.go b/api/api_signin.gen.go index a2ba528b..72be52bc 100644 --- a/api/api_signin.gen.go +++ b/api/api_signin.gen.go @@ -97,8 +97,9 @@ func (r ApiPostSigninRequest) ExecuteWithHttpInfo() (*_nethttp.Response, error) } /* - * PostSignin Create a user session. - * Authenticates [Basic authentication credentials](#section/Authentication/BasicAuthentication) + - PostSignin Create a user session. + - Authenticates [Basic authentication credentials](#section/Authentication/BasicAuthentication) + for a [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user), and then, if successful, generates a user session. @@ -115,17 +116,17 @@ They expire within ten minutes and during restarts of the InfluxDB instance. #### User sessions with authorizations -- In InfluxDB Cloud, a user session inherits all the user's permissions for - the organization. -- In InfluxDB OSS, a user session inherits all the user's permissions for all - the organizations that the user belongs to. + - In InfluxDB Cloud, a user session inherits all the user's permissions for + the organization. + - In InfluxDB OSS, a user session inherits all the user's permissions for all + the organizations that the user belongs to. #### Related endpoints - [Signout](#tag/Signout) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiPostSigninRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiPostSigninRequest */ func (a *SigninApiService) PostSignin(ctx _context.Context) ApiPostSigninRequest { return ApiPostSigninRequest{ diff --git a/api/api_tasks.gen.go b/api/api_tasks.gen.go index ce8662e4..cae5cd31 100644 --- a/api/api_tasks.gen.go +++ b/api/api_tasks.gen.go @@ -499,17 +499,17 @@ func (r ApiDeleteTasksIDRequest) ExecuteWithHttpInfo() (*_nethttp.Response, erro } /* - * DeleteTasksID Delete a task - * Deletes a [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task) and associated records. + - DeleteTasksID Delete a task + - Deletes a [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task) and associated records. Use this endpoint to delete a task and all associated records (task runs, logs, and labels). Once the task is deleted, InfluxDB cancels all scheduled runs of the task. If you want to disable a task instead of delete it, [update the task status to `inactive`](#operation/PatchTasksID). - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param taskID A [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task) ID. Specifies the task to delete. - * @return ApiDeleteTasksIDRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param taskID A [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task) ID. Specifies the task to delete. + - @return ApiDeleteTasksIDRequest */ func (a *TasksApiService) DeleteTasksID(ctx _context.Context, taskID string) ApiDeleteTasksIDRequest { return ApiDeleteTasksIDRequest{ @@ -668,8 +668,8 @@ func (r ApiDeleteTasksIDRunsIDRequest) ExecuteWithHttpInfo() (*_nethttp.Response } /* - * DeleteTasksIDRunsID Cancel a running task - * Cancels a running [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task). + - DeleteTasksIDRunsID Cancel a running task + - Cancels a running [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task). Use this endpoint with InfluxDB OSS to cancel a running task. @@ -677,10 +677,10 @@ Use this endpoint with InfluxDB OSS to cancel a running task. - Doesn't support this operation. - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param taskID The ID of the task to cancel. - * @param runID The ID of the task run to cancel. - * @return ApiDeleteTasksIDRunsIDRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param taskID The ID of the task to cancel. + - @param runID The ID of the task run to cancel. + - @return ApiDeleteTasksIDRunsIDRequest */ func (a *TasksApiService) DeleteTasksIDRunsID(ctx _context.Context, taskID string, runID string) ApiDeleteTasksIDRunsIDRequest { return ApiDeleteTasksIDRunsIDRequest{ @@ -933,14 +933,14 @@ func (r ApiGetTasksRequest) ExecuteWithHttpInfo() (Tasks, *_nethttp.Response, er } /* - * GetTasks List all tasks - * Retrieves a list of [tasks]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task). + - GetTasks List all tasks + - Retrieves a list of [tasks]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task). To limit which tasks are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all tasks up to the default `limit`. - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiGetTasksRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiGetTasksRequest */ func (a *TasksApiService) GetTasks(ctx _context.Context) ApiGetTasksRequest { return ApiGetTasksRequest{ @@ -1143,12 +1143,12 @@ func (r ApiGetTasksIDRequest) ExecuteWithHttpInfo() (Task, *_nethttp.Response, e } /* - * GetTasksID Retrieve a task - * Retrieves a [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task). +* GetTasksID Retrieve a task +* Retrieves a [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task). - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param taskID A [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task) ID. Specifies the task to retrieve. - * @return ApiGetTasksIDRequest +* @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +* @param taskID A [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task) ID. Specifies the task to retrieve. +* @return ApiGetTasksIDRequest */ func (a *TasksApiService) GetTasksID(ctx _context.Context, taskID string) ApiGetTasksIDRequest { return ApiGetTasksIDRequest{ @@ -1320,8 +1320,8 @@ func (r ApiGetTasksIDLogsRequest) ExecuteWithHttpInfo() (Logs, *_nethttp.Respons } /* - * GetTasksIDLogs Retrieve all logs for a task - * Retrieves a list of all logs for a [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task). + - GetTasksIDLogs Retrieve all logs for a task + - Retrieves a list of all logs for a [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task). When an InfluxDB task runs, a “run” record is created in the task’s history. Logs associated with each run provide relevant log messages, timestamps, and the exit status of the run attempt. @@ -1329,9 +1329,9 @@ Logs associated with each run provide relevant log messages, timestamps, and the Use this endpoint to retrieve only the log events for a task, without additional task metadata. - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param taskID The task ID. - * @return ApiGetTasksIDLogsRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param taskID The task ID. + - @return ApiGetTasksIDLogsRequest */ func (a *TasksApiService) GetTasksIDLogs(ctx _context.Context, taskID string) ApiGetTasksIDLogsRequest { return ApiGetTasksIDLogsRequest{ @@ -1539,15 +1539,15 @@ func (r ApiGetTasksIDRunsRequest) ExecuteWithHttpInfo() (Runs, *_nethttp.Respons } /* - * GetTasksIDRuns List runs for a task - * Retrieves a list of runs for a [task]({{% INFLUXDB_DOCS_URL %}}/process-data/). + - GetTasksIDRuns List runs for a task + - Retrieves a list of runs for a [task]({{% INFLUXDB_DOCS_URL %}}/process-data/). To limit which task runs are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all task runs up to the default `limit`. - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param taskID The ID of the task to get runs for. Only returns runs for this task. - * @return ApiGetTasksIDRunsRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param taskID The ID of the task to get runs for. Only returns runs for this task. + - @return ApiGetTasksIDRunsRequest */ func (a *TasksApiService) GetTasksIDRuns(ctx _context.Context, taskID string) ApiGetTasksIDRunsRequest { return ApiGetTasksIDRunsRequest{ @@ -1740,15 +1740,15 @@ func (r ApiGetTasksIDRunsIDRequest) ExecuteWithHttpInfo() (Run, *_nethttp.Respon } /* - * GetTasksIDRunsID Retrieve a run for a task. - * Retrieves a specific run for a [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task). + - GetTasksIDRunsID Retrieve a run for a task. + - Retrieves a specific run for a [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task). Use this endpoint to retrieve detail and logs for a specific task run. - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param taskID The ID of the task to retrieve runs for. - * @param runID The ID of the run to retrieve. - * @return ApiGetTasksIDRunsIDRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param taskID The ID of the task to retrieve runs for. + - @param runID The ID of the run to retrieve. + - @return ApiGetTasksIDRunsIDRequest */ func (a *TasksApiService) GetTasksIDRunsID(ctx _context.Context, taskID string, runID string) ApiGetTasksIDRunsIDRequest { return ApiGetTasksIDRunsIDRequest{ @@ -1931,16 +1931,17 @@ func (r ApiGetTasksIDRunsIDLogsRequest) ExecuteWithHttpInfo() (Logs, *_nethttp.R } /* - * GetTasksIDRunsIDLogs Retrieve all logs for a run - * Retrieves all logs for a task run. + - GetTasksIDRunsIDLogs Retrieve all logs for a run + - Retrieves all logs for a task run. + A log is a list of run events with `runID`, `time`, and `message` properties. Use this endpoint to help analyze task performance and troubleshoot failed task runs. - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param taskID The ID of the task to get logs for. - * @param runID The ID of the run to get logs for. - * @return ApiGetTasksIDRunsIDLogsRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param taskID The ID of the task to get logs for. + - @param runID The ID of the run to get logs for. + - @return ApiGetTasksIDRunsIDLogsRequest */ func (a *TasksApiService) GetTasksIDRunsIDLogs(ctx _context.Context, taskID string, runID string) ApiGetTasksIDRunsIDLogsRequest { return ApiGetTasksIDRunsIDLogsRequest{ @@ -2123,8 +2124,9 @@ func (r ApiPatchTasksIDRequest) ExecuteWithHttpInfo() (Task, *_nethttp.Response, } /* - * PatchTasksID Update a task - * Updates a [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task), + - PatchTasksID Update a task + - Updates a [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task), + and then cancels all scheduled runs of the task. Use this endpoint to set, modify, or clear task properties--for example: `cron`, `name`, `flux`, `status`. @@ -2142,16 +2144,16 @@ _`"status": "inactive"`_ cancels scheduled runs and prevents manual runs of the ```json { - "flux": "option task = {name: \"CPU Total 1 Hour New\", every: 1h}\ - from(bucket: \"telegraf\") - |> range(start: -1h) - |> filter(fn: (r) => (r._measurement == \"cpu\")) - |> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\")) - |> filter(fn: (r) => (r.cpu == \"cpu-total\")) - |> aggregateWindow(every: 1h, fn: max) - |> to(bucket: \"cpu_usage_user_total_1h\", org: \"INFLUX_ORG\")", - "status": "active", - "description": "This task downsamples CPU data every hour" + "flux": "option task = {name: \"CPU Total 1 Hour New\", every: 1h}\ + from(bucket: \"telegraf\") + |> range(start: -1h) + |> filter(fn: (r) => (r._measurement == \"cpu\")) + |> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\")) + |> filter(fn: (r) => (r.cpu == \"cpu-total\")) + |> aggregateWindow(every: 1h, fn: max) + |> to(bucket: \"cpu_usage_user_total_1h\", org: \"INFLUX_ORG\")", + "status": "active", + "description": "This task downsamples CPU data every hour" } ``` @@ -2162,26 +2164,26 @@ _`"status": "inactive"`_ cancels scheduled runs and prevents manual runs of the ```json { - "name": "CPU Total 1 Hour New", - "description": "This task downsamples CPU data every hour", - "every": "1h", - "scriptID": "SCRIPT_ID", - "scriptParameters": - { - "rangeStart": "-1h", - "bucket": "telegraf", - "filterField": "cpu-total" - } - } + "name": "CPU Total 1 Hour New", + "description": "This task downsamples CPU data every hour", + "every": "1h", + "scriptID": "SCRIPT_ID", + "scriptParameters": + { + "rangeStart": "-1h", + "bucket": "telegraf", + "filterField": "cpu-total" + } + } ``` #### Limitations: - You can't use `flux` and `scriptID` for the same task. - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param taskID A [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task) ID. Specifies the task to update. - * @return ApiPatchTasksIDRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param taskID A [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task) ID. Specifies the task to update. + - @return ApiPatchTasksIDRequest */ func (a *TasksApiService) PatchTasksID(ctx _context.Context, taskID string) ApiPatchTasksIDRequest { return ApiPatchTasksIDRequest{ @@ -2358,8 +2360,8 @@ func (r ApiPostTasksRequest) ExecuteWithHttpInfo() (Task, *_nethttp.Response, er } /* - * PostTasks Create a task - * Creates a [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task) and returns the task. + - PostTasks Create a task + - Creates a [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task) and returns the task. Use this endpoint to create a scheduled task that runs a Flux script. @@ -2371,16 +2373,16 @@ Use this endpoint to create a scheduled task that runs a Flux script. ```json { - "flux": "option task = {name: \"CPU Total 1 Hour New\", every: 1h}\ - from(bucket: \"telegraf\") - |> range(start: -1h) - |> filter(fn: (r) => (r._measurement == \"cpu\")) - |> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\")) - |> filter(fn: (r) => (r.cpu == \"cpu-total\")) - |> aggregateWindow(every: 1h, fn: max) - |> to(bucket: \"cpu_usage_user_total_1h\", org: \"INFLUX_ORG\")", - "status": "active", - "description": "This task downsamples CPU data every hour" + "flux": "option task = {name: \"CPU Total 1 Hour New\", every: 1h}\ + from(bucket: \"telegraf\") + |> range(start: -1h) + |> filter(fn: (r) => (r._measurement == \"cpu\")) + |> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\")) + |> filter(fn: (r) => (r.cpu == \"cpu-total\")) + |> aggregateWindow(every: 1h, fn: max) + |> to(bucket: \"cpu_usage_user_total_1h\", org: \"INFLUX_ORG\")", + "status": "active", + "description": "This task downsamples CPU data every hour" } ``` @@ -2391,17 +2393,17 @@ Use this endpoint to create a scheduled task that runs a Flux script. ```json { - "name": "CPU Total 1 Hour New", - "description": "This task downsamples CPU data every hour", - "every": "1h", - "scriptID": "SCRIPT_ID", - "scriptParameters": - { - "rangeStart": "-1h", - "bucket": "telegraf", - "filterField": "cpu-total" - } - } + "name": "CPU Total 1 Hour New", + "description": "This task downsamples CPU data every hour", + "every": "1h", + "scriptID": "SCRIPT_ID", + "scriptParameters": + { + "rangeStart": "-1h", + "bucket": "telegraf", + "filterField": "cpu-total" + } + } ``` #### Limitations: @@ -2415,8 +2417,8 @@ Use this endpoint to create a scheduled task that runs a Flux script. - [Common tasks]({{% INFLUXDB_DOCS_URL %}}/process-data/common-tasks/) - [Task configuration options]({{% INFLUXDB_DOCS_URL %}}/process-data/task-options/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiPostTasksRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiPostTasksRequest */ func (a *TasksApiService) PostTasks(ctx _context.Context) ApiPostTasksRequest { return ApiPostTasksRequest{ @@ -2611,8 +2613,8 @@ func (r ApiPostTasksIDRunsRequest) ExecuteWithHttpInfo() (Run, *_nethttp.Respons } /* - * PostTasksIDRuns Start a task run, overriding the schedule - * Schedules a task run to start immediately, ignoring scheduled runs. + - PostTasksIDRuns Start a task run, overriding the schedule + - Schedules a task run to start immediately, ignoring scheduled runs. Use this endpoint to manually start a task run. Scheduled runs will continue to run as scheduled. @@ -2621,9 +2623,9 @@ This may result in concurrently running tasks. To _retry_ a previous run (and avoid creating a new run), use the [`POST /api/v2/tasks/{taskID}/runs/{runID}/retry` endpoint](#operation/PostTasksIDRunsIDRetry). - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param taskID - * @return ApiPostTasksIDRunsRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param taskID + - @return ApiPostTasksIDRunsRequest */ func (a *TasksApiService) PostTasksIDRuns(ctx _context.Context, taskID string) ApiPostTasksIDRunsRequest { return ApiPostTasksIDRunsRequest{ @@ -2815,8 +2817,9 @@ func (r ApiPostTasksIDRunsIDRetryRequest) ExecuteWithHttpInfo() (Run, *_nethttp. } /* - * PostTasksIDRunsIDRetry Retry a task run - * Queues a [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task) run to + - PostTasksIDRunsIDRetry Retry a task run + - Queues a [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task) run to + retry and returns the scheduled run. To manually start a _new_ task run, use the @@ -2826,10 +2829,10 @@ To manually start a _new_ task run, use the - The task must be _active_ (`status: "active"`). - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param taskID A [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task) ID. Specifies the task to retry. - * @param runID A [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task) run ID. Specifies the task run to retry. To find a task run ID, use the [`GET /api/v2/tasks/{taskID}/runs` endpoint](#operation/GetTasksIDRuns) to list task runs. - * @return ApiPostTasksIDRunsIDRetryRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param taskID A [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task) ID. Specifies the task to retry. + - @param runID A [task]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#task) run ID. Specifies the task run to retry. To find a task run ID, use the [`GET /api/v2/tasks/{taskID}/runs` endpoint](#operation/GetTasksIDRuns) to list task runs. + - @return ApiPostTasksIDRunsIDRetryRequest */ func (a *TasksApiService) PostTasksIDRunsIDRetry(ctx _context.Context, taskID string, runID string) ApiPostTasksIDRunsIDRetryRequest { return ApiPostTasksIDRunsIDRetryRequest{ diff --git a/api/api_users.gen.go b/api/api_users.gen.go index 0d72c970..307457fa 100644 --- a/api/api_users.gen.go +++ b/api/api_users.gen.go @@ -313,8 +313,8 @@ func (r ApiDeleteUsersIDRequest) ExecuteWithHttpInfo() (*_nethttp.Response, erro } /* - * DeleteUsersID Delete a user - * Deletes a [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user). + - DeleteUsersID Delete a user + - Deletes a [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user). #### Required permissions @@ -328,9 +328,9 @@ func (r ApiDeleteUsersIDRequest) ExecuteWithHttpInfo() (*_nethttp.Response, erro - [Manage users]({{% INFLUXDB_DOCS_URL %}}/organizations/users/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param userID A user ID. Specifies the [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user) to delete. - * @return ApiDeleteUsersIDRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param userID A user ID. Specifies the [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user) to delete. + - @return ApiDeleteUsersIDRequest */ func (a *UsersApiService) DeleteUsersID(ctx _context.Context, userID string) ApiDeleteUsersIDRequest { return ApiDeleteUsersIDRequest{ @@ -527,8 +527,9 @@ func (r ApiGetUsersRequest) ExecuteWithHttpInfo() (Users, *_nethttp.Response, er } /* - * GetUsers List users - * Retrieves a list of [users]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user). + - GetUsers List users + - Retrieves a list of [users]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user). + Default limit is `20`. To limit which users are returned, pass query parameters in your request. @@ -542,8 +543,8 @@ To limit which users are returned, pass query parameters in your request. *`USER_ID`* is the ID of the user that you want to retrieve. - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiGetUsersRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiGetUsersRequest */ func (a *UsersApiService) GetUsers(ctx _context.Context) ApiGetUsersRequest { return ApiGetUsersRequest{ @@ -739,16 +740,16 @@ func (r ApiGetUsersIDRequest) ExecuteWithHttpInfo() (UserResponse, *_nethttp.Res } /* - * GetUsersID Retrieve a user - * Retrieves a [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user). + - GetUsersID Retrieve a user + - Retrieves a [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user). #### Related guides - [Manage users]({{% INFLUXDB_DOCS_URL %}}/organizations/users/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param userID A user ID. Retrieves the specified [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user). - * @return ApiGetUsersIDRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param userID A user ID. Retrieves the specified [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user). + - @return ApiGetUsersIDRequest */ func (a *UsersApiService) GetUsersID(ctx _context.Context, userID string) ApiGetUsersIDRequest { return ApiGetUsersIDRequest{ @@ -918,8 +919,8 @@ func (r ApiPatchUsersIDRequest) ExecuteWithHttpInfo() (UserResponse, *_nethttp.R } /* - * PatchUsersID Update a user - * Updates a [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user) and returns the user. + - PatchUsersID Update a user + - Updates a [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user) and returns the user. #### Required permissions @@ -933,9 +934,9 @@ func (r ApiPatchUsersIDRequest) ExecuteWithHttpInfo() (UserResponse, *_nethttp.R - [Manage users]({{% INFLUXDB_DOCS_URL %}}/organizations/users/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param userID A user ID. Specifies the [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user) to update. - * @return ApiPatchUsersIDRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param userID A user ID. Specifies the [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user) to update. + - @return ApiPatchUsersIDRequest */ func (a *UsersApiService) PatchUsersID(ctx _context.Context, userID string) ApiPatchUsersIDRequest { return ApiPatchUsersIDRequest{ @@ -1112,8 +1113,9 @@ func (r ApiPostUsersRequest) ExecuteWithHttpInfo() (UserResponse, *_nethttp.Resp } /* - * PostUsers Create a user - * Creates a [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user) that can access InfluxDB. + - PostUsers Create a user + - Creates a [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user) that can access InfluxDB. + Returns the user. Use this endpoint to create a user that can sign in to start a user session @@ -1126,10 +1128,10 @@ through one of the following interfaces: This endpoint represents the first two steps in a four-step process to allow a user to authenticate with a username and password, and then access data in an organization: - 1. Create a user: send a `POST` request to `POST /api/v2/users`. `name` is required. - 2. Extract the user ID (`id`) value from the API response for _step 1_. - 3. Create an authorization (and API token) for the user: send a `POST` request to [`POST /api/v2/authorizations`](#operation/PostAuthorizations), passing the user ID (`id`) from _step 2_. - 4. Create a password for the user: send a `POST` request to [`POST /api/v2/users/USER_ID/password`](#operation/PostUsersIDPassword), passing the user ID from _step 2_. + 1. Create a user: send a `POST` request to `POST /api/v2/users`. `name` is required. + 2. Extract the user ID (`id`) value from the API response for _step 1_. + 3. Create an authorization (and API token) for the user: send a `POST` request to [`POST /api/v2/authorizations`](#operation/PostAuthorizations), passing the user ID (`id`) from _step 2_. + 4. Create a password for the user: send a `POST` request to [`POST /api/v2/users/USER_ID/password`](#operation/PostUsersIDPassword), passing the user ID from _step 2_. #### Required permissions @@ -1142,8 +1144,8 @@ to authenticate with a username and password, and then access data in an organiz - [Create a user](https://docs.influxdata.com/influxdb/latest/users/create-user/) - [Create an API token scoped to a user](https://docs.influxdata.com/influxdb/latest/security/tokens/create-token/#create-a-token-scoped-to-a-user) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiPostUsersRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiPostUsersRequest */ func (a *UsersApiService) PostUsers(ctx _context.Context) ApiPostUsersRequest { return ApiPostUsersRequest{ @@ -1338,22 +1340,22 @@ func (r ApiPostUsersIDPasswordRequest) ExecuteWithHttpInfo() (*_nethttp.Response } /* - * PostUsersIDPassword Update a password - * Updates a user password. + - PostUsersIDPassword Update a password + - Updates a user password. #### InfluxDB Cloud -- Doesn't allow you to manage user passwords through the API. - Use the InfluxDB Cloud user interface (UI) to update a password. + - Doesn't allow you to manage user passwords through the API. + Use the InfluxDB Cloud user interface (UI) to update a password. #### Related guides - [InfluxDB Cloud - Change your password](https://docs.influxdata.com/influxdb/cloud/account-management/change-password/) - [InfluxDB OSS - Change your password](https://docs.influxdata.com/influxdb/latest/users/change-password/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param userID The ID of the user to set the password for. - * @return ApiPostUsersIDPasswordRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param userID The ID of the user to set the password for. + - @return ApiPostUsersIDPasswordRequest */ func (a *UsersApiService) PostUsersIDPassword(ctx _context.Context, userID string) ApiPostUsersIDPasswordRequest { return ApiPostUsersIDPasswordRequest{ @@ -1517,8 +1519,8 @@ func (r ApiPutUsersIDPasswordRequest) ExecuteWithHttpInfo() (*_nethttp.Response, } /* - * PutUsersIDPassword Update a password - * Updates a user password. + - PutUsersIDPassword Update a password + - Updates a user password. Use this endpoint to let a user authenticate with [Basic authentication credentials](#section/Authentication/BasicAuthentication) @@ -1526,17 +1528,17 @@ and set a new password. #### InfluxDB Cloud -- Doesn't allow you to manage user passwords through the API. - Use the InfluxDB Cloud user interface (UI) to update a password. + - Doesn't allow you to manage user passwords through the API. + Use the InfluxDB Cloud user interface (UI) to update a password. #### Related guides - [InfluxDB Cloud - Change your password](https://docs.influxdata.com/influxdb/cloud/account-management/change-password/) - [InfluxDB OSS - Change your password](https://docs.influxdata.com/influxdb/latest/users/change-password/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param userID The ID of the user to set the password for. - * @return ApiPutUsersIDPasswordRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param userID The ID of the user to set the password for. + - @return ApiPutUsersIDPasswordRequest */ func (a *UsersApiService) PutUsersIDPassword(ctx _context.Context, userID string) ApiPutUsersIDPasswordRequest { return ApiPutUsersIDPasswordRequest{ diff --git a/api/api_write.gen.go b/api/api_write.gen.go index 1f80861f..73d1351b 100644 --- a/api/api_write.gen.go +++ b/api/api_write.gen.go @@ -193,8 +193,8 @@ func (r ApiPostWriteRequest) ExecuteWithHttpInfo() (*_nethttp.Response, error) { } /* - * PostWrite Write data - * Writes data to a bucket. + - PostWrite Write data + - Writes data to a bucket. Use this endpoint to send data in [line protocol]({{% INFLUXDB_DOCS_URL %}}/reference/syntax/line-protocol/) format to InfluxDB. @@ -202,27 +202,29 @@ Use this endpoint to send data in [line protocol]({{% INFLUXDB_DOCS_URL %}}/refe - Does the following when you send a write request: - 1. Validates the request and queues the write. - 2. If queued, responds with _success_ (HTTP `2xx` status code); _error_ otherwise. - 3. Handles the delete asynchronously and reaches eventual consistency. + 1. Validates the request and queues the write. - To ensure that InfluxDB Cloud handles writes and deletes in the order you request them, - wait for a success response (HTTP `2xx` status code) before you send the next request. + 2. If queued, responds with _success_ (HTTP `2xx` status code); _error_ otherwise. - Because writes and deletes are asynchronous, your change might not yet be readable - when you receive the response. + 3. Handles the delete asynchronously and reaches eventual consistency. + + To ensure that InfluxDB Cloud handles writes and deletes in the order you request them, + wait for a success response (HTTP `2xx` status code) before you send the next request. + + Because writes and deletes are asynchronous, your change might not yet be readable + when you receive the response. #### InfluxDB OSS -- Validates the request and handles the write synchronously. -- If all points were written successfully, responds with HTTP `2xx` status code; - otherwise, returns the first line that failed. + - Validates the request and handles the write synchronously. + - If all points were written successfully, responds with HTTP `2xx` status code; + otherwise, returns the first line that failed. #### Required permissions - `write-buckets` or `write-bucket BUCKET_ID`. - *`BUCKET_ID`* is the ID of the destination bucket. + *`BUCKET_ID`* is the ID of the destination bucket. #### Rate limits (with InfluxDB Cloud) @@ -235,8 +237,8 @@ For more information, see [limits and adjustable quotas](https://docs.influxdata - [Optimize writes to InfluxDB]({{% INFLUXDB_DOCS_URL %}}/write-data/best-practices/optimize-writes/) - [Troubleshoot issues writing data]({{% INFLUXDB_DOCS_URL %}}/write-data/troubleshoot/) - * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @return ApiPostWriteRequest + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @return ApiPostWriteRequest */ func (a *WriteApiService) PostWrite(ctx _context.Context) ApiPostWriteRequest { return ApiPostWriteRequest{ diff --git a/scripts/ci/download-goreleaser.sh b/scripts/ci/download-goreleaser.sh index fa366dcf..407508af 100755 --- a/scripts/ci/download-goreleaser.sh +++ b/scripts/ci/download-goreleaser.sh @@ -1,406 +1,25 @@ -#!/bin/sh -set -e - -################################ NOTE ################################ -# To avoid piping a `curl` call into `sh`, this was downloaded from: # -# https://install.goreleaser.com/github.com/goreleaser/goreleaser.sh # -# on May 21, 2021. The only modification made was to append `-` # -# to the name of the generated binary. # -###################################################################### - -# Code generated by godownloader on 2019-12-25T12:47:14Z. DO NOT EDIT. -# - -usage() { - this=$1 - cat </dev/null -} -echoerr() { - echo "$@" 1>&2 -} -log_prefix() { - echo "$0" -} -_logp=6 -log_set_priority() { - _logp="$1" -} -log_priority() { - if test -z "$1"; then - echo "$_logp" - return - fi - [ "$1" -le "$_logp" ] -} -log_tag() { - case $1 in - 0) echo "emerg" ;; - 1) echo "alert" ;; - 2) echo "crit" ;; - 3) echo "err" ;; - 4) echo "warning" ;; - 5) echo "notice" ;; - 6) echo "info" ;; - 7) echo "debug" ;; - *) echo "$1" ;; - esac -} -log_debug() { - log_priority 7 || return 0 - echoerr "$(log_prefix)" "$(log_tag 7)" "$@" -} -log_info() { - log_priority 6 || return 0 - echoerr "$(log_prefix)" "$(log_tag 6)" "$@" -} -log_err() { - log_priority 3 || return 0 - echoerr "$(log_prefix)" "$(log_tag 3)" "$@" -} -log_crit() { - log_priority 2 || return 0 - echoerr "$(log_prefix)" "$(log_tag 2)" "$@" -} -uname_os() { - os=$(uname -s | tr '[:upper:]' '[:lower:]') - case "$os" in - cygwin_nt*) os="windows" ;; - mingw*) os="windows" ;; - msys_nt*) os="windows" ;; - esac - echo "$os" -} -uname_arch() { - arch=$(uname -m) - case $arch in - x86_64) arch="amd64" ;; - x86) arch="386" ;; - i686) arch="386" ;; - i386) arch="386" ;; - aarch64) arch="arm64" ;; - armv5*) arch="armv5" ;; - armv6*) arch="armv6" ;; - armv7*) arch="armv7" ;; - esac - echo ${arch} -} -uname_os_check() { - os=$(uname_os) - case "$os" in - darwin) return 0 ;; - dragonfly) return 0 ;; - freebsd) return 0 ;; - linux) return 0 ;; - android) return 0 ;; - nacl) return 0 ;; - netbsd) return 0 ;; - openbsd) return 0 ;; - plan9) return 0 ;; - solaris) return 0 ;; - windows) return 0 ;; - esac - log_crit "uname_os_check '$(uname -s)' got converted to '$os' which is not a GOOS value. Please file bug at https://github.com/client9/shlib" - return 1 -} -uname_arch_check() { - arch=$(uname_arch) - case "$arch" in - 386) return 0 ;; - amd64) return 0 ;; - arm64) return 0 ;; - armv5) return 0 ;; - armv6) return 0 ;; - armv7) return 0 ;; - ppc64) return 0 ;; - ppc64le) return 0 ;; - mips) return 0 ;; - mipsle) return 0 ;; - mips64) return 0 ;; - mips64le) return 0 ;; - s390x) return 0 ;; - amd64p32) return 0 ;; - esac - log_crit "uname_arch_check '$(uname -m)' got converted to '$arch' which is not a GOARCH value. Please file bug report at https://github.com/client9/shlib" - return 1 -} -untar() { - tarball=$1 - case "${tarball}" in - *.tar.gz | *.tgz) tar --no-same-owner -xzf "${tarball}" ;; - *.tar) tar --no-same-owner -xf "${tarball}" ;; - *.zip) unzip "${tarball}" ;; - *) - log_err "untar unknown archive format for ${tarball}" - return 1 - ;; - esac -} -http_download_curl() { - local_file=$1 - source_url=$2 - header=$3 - if [ -z "$header" ]; then - code=$(curl -w '%{http_code}' -sL -o "$local_file" "$source_url") - else - code=$(curl -w '%{http_code}' -sL -H "$header" -o "$local_file" "$source_url") - fi - if [ "$code" != "200" ]; then - log_debug "http_download_curl received HTTP status $code" - return 1 - fi - return 0 -} -http_download_wget() { - local_file=$1 - source_url=$2 - header=$3 - if [ -z "$header" ]; then - wget -q -O "$local_file" "$source_url" - else - wget -q --header "$header" -O "$local_file" "$source_url" - fi -} -http_download() { - log_debug "http_download $2" - if is_command curl; then - http_download_curl "$@" - return - elif is_command wget; then - http_download_wget "$@" - return - fi - log_crit "http_download unable to find wget or curl" - return 1 -} -http_copy() { - tmp=$(mktemp) - http_download "${tmp}" "$1" "$2" || return 1 - body=$(cat "$tmp") - rm -f "${tmp}" - echo "$body" -} -github_release() { - owner_repo=$1 - version=$2 - test -z "$version" && version="latest" - giturl="https://github.com/${owner_repo}/releases/${version}" - json=$(http_copy "$giturl" "Accept:application/json") - test -z "$json" && return 1 - version=$(echo "$json" | tr -s '\n' ' ' | sed 's/.*"tag_name":"//' | sed 's/".*//') - test -z "$version" && return 1 - echo "$version" -} -hash_sha256() { - TARGET=${1:-/dev/stdin} - if is_command gsha256sum; then - hash=$(gsha256sum "$TARGET") || return 1 - echo "$hash" | cut -d ' ' -f 1 - elif is_command sha256sum; then - hash=$(sha256sum "$TARGET") || return 1 - echo "$hash" | cut -d ' ' -f 1 - elif is_command shasum; then - hash=$(shasum -a 256 "$TARGET" 2>/dev/null) || return 1 - echo "$hash" | cut -d ' ' -f 1 - elif is_command openssl; then - hash=$(openssl -dst openssl dgst -sha256 "$TARGET") || return 1 - echo "$hash" | cut -d ' ' -f a - else - log_crit "hash_sha256 unable to find command to compute sha-256 hash" - return 1 - fi -} -hash_sha256_verify() { - TARGET=$1 - checksums=$2 - if [ -z "$checksums" ]; then - log_err "hash_sha256_verify checksum file not specified in arg2" - return 1 - fi - BASENAME=${TARGET##*/} - want=$(grep "${BASENAME}" "${checksums}" 2>/dev/null | tr '\t' ' ' | cut -d ' ' -f 1) - if [ -z "$want" ]; then - log_err "hash_sha256_verify unable to find checksum for '${TARGET}' in '${checksums}'" - return 1 - fi - got=$(hash_sha256 "$TARGET") - if [ "$want" != "$got" ]; then - log_err "hash_sha256_verify checksum for '$TARGET' did not verify ${want} vs $got" - return 1 - fi -} -cat /dev/null <&2 ; exit 1 + ;; +esac + +curl -LO "https://github.com/goreleaser/goreleaser/releases/download/${1}/goreleaser_Linux_x86_64.tar.gz" + +printf '%s goreleaser_Linux_x86_64.tar.gz' "${CHECKSUM}" | sha256sum --check + +tar -xf goreleaser_Linux_x86_64.tar.gz -C "${GOPATH}/bin" diff --git a/scripts/ci/install-go.sh b/scripts/ci/install-go.sh index b0d446cc..f0465034 100755 --- a/scripts/ci/install-go.sh +++ b/scripts/ci/install-go.sh @@ -1,22 +1,22 @@ #!/usr/bin/env bash set -eo pipefail -declare -r GO_VERSION=1.18.3 +declare -r GO_VERSION=1.19.4 # Hashes are from the table at https://golang.org/dl/ function go_hash () { case $1 in linux_amd64) - echo 956f8507b302ab0bb747613695cdae10af99bbd39a90cae522b7c0302cc27245 + echo c9c08f783325c4cf840a94333159cc937f05f75d36a8b307951d5bd959cf2ab8 ;; linux_arm64) - echo beacbe1441bee4d7978b900136d1d6a71d150f0a9bb77e9d50c822065623a35a + echo 9df122d6baf6f2275270306b92af3b09d7973fb1259257e284dba33c0db14f1b ;; mac) - echo a23a24c5528671d444328a36a98056902f699a5a211b6ad5db29ca0c012e0085 + echo 44894862d996eec96ef2a39878e4e1fce4d05423fc18bdc1cbba745ebfa41253 ;; windows) - echo 9c46023f3ad0300fcfd1e62f2b6c2dfd9667b1f2f5c7a720b14b792af831f071 + echo ada490e188bfb57c7388da7c5eba7565390992b6496204d30e710d37755956b0 ;; esac }