Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix: API ref - content encoding header descriptions. (#3378)

pull/3109/head^2
Jason Stirnaman 2021-11-19 12:44:29 -06:00 committed by GitHub
parent 06731b2883
commit 6210d25dfe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 90 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
api-docs/cloud/ref.yml
View File

@ -5981,7 +5981,7 @@ components:
For more information and examples, see the following:
- [`/authorizations`](#tag/Authorizations) endpoint.
- [Use tokens in API requests](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/#authentication).
- [Authorize API requests](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/#authentication).
- [Manage API tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens).
- [Assign a token to a specific user](https://docs.influxdata.com/influxdb/cloud/security/tokens/create-token).
scheme: token
@ -9625,14 +9625,13 @@ paths:
headers:
Content-Encoding:
description: >-
The Content-Encoding entity header is used to compress the
media-type. When present, its value indicates which encodings
were applied to the entity-body
Lists any encodings (usually compression algorithms) that have
been applied to the response payload.
schema:
default: identity
description: >-
Specifies that the response in the body is encoded with gzip
or not encoded with identity.
The content coding. `gzip` for compressed data or `identity`
for unmodified, uncompressed data.
enum:
- gzip
- identity
@ -9709,16 +9708,15 @@ paths:
parameters:
- $ref: '#/components/parameters/TraceSpan'
- description: >-
The Accept-Encoding request HTTP header advertises which content
encoding, usually a compression algorithm, the client is able to
understand.
Indicates the content encoding (usually a compression algorithm)
that the client can understand.
in: header
name: Accept-Encoding
schema:
default: identity
description: >-
Specifies that the query response in the body should be encoded
with gzip or not encoded with identity.
The content coding. Use `gzip` for compressed data or `identity`
for unmodified, uncompressed data.
enum:
- gzip
- identity
@ -9777,14 +9775,13 @@ paths:
headers:
Content-Encoding:
description: >-
The Content-Encoding entity header is used to compress the
media-type. When present, its value indicates which encodings
were applied to the entity-body
Lists any encodings (usually compression algorithms) that have
been applied to the response payload.
schema:
default: identity
description: >-
Specifies that the response in the body is encoded with gzip
or not encoded with identity.
description: >
The content coding: `gzip` for compressed data or `identity`
for unmodified, uncompressed data.
enum:
- gzip
- identity
@ -12130,21 +12127,29 @@ paths:
format.
For more information and examples, see [Write data with the InfluxDB
For more information and examples, see the following:
- [Write data with the InfluxDB
API](https://docs.influxdata.com/influxdb/cloud/write-data/developer-tools/api).
- [Optimize writes to
InfluxDB](https://docs.influxdata.com/influxdb/cloud/write-data/best-practices/optimize-writes/).
operationId: PostWrite
parameters:
- $ref: '#/components/parameters/TraceSpan'
- description: >-
When present, the header value tells the database that compression
is applied to the line protocol in the request body.
- description: >
The value tells InfluxDB what compression is applied to the line
protocol in the request payload.
To make an API request with a GZIP payload, send `Content-Encoding:
gzip` as a request header.
in: header
name: Content-Encoding
schema:
default: identity
description: >-
The header value specifies that the line protocol in the request
body is encoded with gzip or not encoded with identity.
The content coding. Use `gzip` for compressed data or `identity`
for unmodified, uncompressed data.
enum:
- gzip
- identity
@ -12370,7 +12375,7 @@ tags:
For more information and examples, see the following:
- [Use tokens in API requests](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/#authentication).
- [Authorize API requests](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/#authentication).
- [Manage API tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens).
- [Assign a token to a specific user](https://docs.influxdata.com/influxdb/cloud/security/tokens/create-token).
name: Authorizations

111
api-docs/v2.1/ref.yml
View File

@ -5926,7 +5926,7 @@ components:
For more information and examples, see the following:
- [`/authorizations`](#tag/Authorizations) endpoint.
- [Use tokens in API requests](https://docs.influxdata.com/influxdb/v2.1/api-guide/api_intro/#authentication).
- [Authorize API requests](https://docs.influxdata.com/influxdb/v2.1/api-guide/api_intro/#authentication).
- [Manage API tokens](https://docs.influxdata.com/influxdb/v2.1/security/tokens).
- [Assign a token to a specific user](https://docs.influxdata.com/influxdb/v2.1/security/tokens/create-token).
scheme: token
@ -6120,16 +6120,15 @@ paths:
parameters:
- $ref: '#/components/parameters/TraceSpan'
- description: >-
The Accept-Encoding request HTTP header advertises which content
encoding, usually a compression algorithm, the client is able to
understand.
Indicates the content encoding (usually a compression algorithm)
that the client can understand.
in: header
name: Accept-Encoding
schema:
default: identity
description: >-
Specifies that the query response in the body should be encoded
with gzip or not encoded with identity.
The content coding. Use `gzip` for compressed data or `identity`
for unmodified, uncompressed data.
enum:
- gzip
- identity
@ -6144,14 +6143,13 @@ paths:
headers:
Content-Encoding:
description: >-
The Content-Encoding entity header is used to compress the
media-type. When present, its value indicates which encodings
were applied to the entity-body
Lists any encodings (usually compression algorithms) that have
been applied to the response payload.
schema:
default: identity
description: >-
Specifies that the response in the body is encoded with gzip
or not encoded with identity.
description: >
The content coding: `gzip` for compressed data or `identity`
for unmodified, uncompressed data.
enum:
- gzip
- identity
@ -6168,16 +6166,15 @@ paths:
parameters:
- $ref: '#/components/parameters/TraceSpan'
- description: >-
The Accept-Encoding request HTTP header advertises which content
encoding, usually a compression algorithm, the client is able to
understand.
Indicates the content encoding (usually a compression algorithm)
that the client can understand.
in: header
name: Accept-Encoding
schema:
default: identity
description: >-
Specifies that the query response in the body should be encoded
with gzip or not encoded with identity.
The content coding. Use `gzip` for compressed data or `identity`
for unmodified, uncompressed data.
enum:
- gzip
- identity
@ -6206,14 +6203,13 @@ paths:
headers:
Content-Encoding:
description: >-
The Content-Encoding entity header is used to compress the
media-type. When present, its value indicates which encodings
were applied to the entity-body
Lists any encodings (usually compression algorithms) that have
been applied to the response payload.
schema:
default: identity
description: >-
Specifies that the response in the body is encoded with gzip
or not encoded with identity.
description: >
The content coding: `gzip` for compressed data or `identity`
for unmodified, uncompressed data.
enum:
- gzip
- identity
@ -9605,16 +9601,15 @@ paths:
parameters:
- $ref: '#/components/parameters/TraceSpan'
- description: >-
The Accept-Encoding request HTTP header advertises which content
encoding, usually a compression algorithm, the client is able to
understand.
Indicates the content encoding (usually a compression algorithm)
that the client can understand.
in: header
name: Accept-Encoding
schema:
default: identity
description: >-
Specifies that the query response in the body should be encoded
with gzip or not encoded with identity.
The content coding. Use `gzip` for compressed data or `identity`
for unmodified, uncompressed data.
enum:
- gzip
- identity
@ -9673,14 +9668,13 @@ paths:
headers:
Content-Encoding:
description: >-
The Content-Encoding entity header is used to compress the
media-type. When present, its value indicates which encodings
were applied to the entity-body
Lists any encodings (usually compression algorithms) that have
been applied to the response payload.
schema:
default: identity
description: >-
Specifies that the response in the body is encoded with gzip
or not encoded with identity.
description: >
The content coding: `gzip` for compressed data or `identity`
for unmodified, uncompressed data.
enum:
- gzip
- identity
@ -9951,16 +9945,19 @@ paths:
operationId: PostRestoreKV
parameters:
- $ref: '#/components/parameters/TraceSpan'
- description: >-
When present, its value indicates to the database that compression
is applied to the line-protocol body.
- description: >
The value tells InfluxDB what compression is applied to the line
protocol in the request payload.
To make an API request with a GZIP payload, send `Content-Encoding:
gzip` as a request header.
in: header
name: Content-Encoding
schema:
default: identity
description: >-
Specifies that the line protocol in the body is encoded with gzip
or not encoded with identity.
The content coding. Use `gzip` for compressed data or `identity`
for unmodified, uncompressed data.
enum:
- gzip
- identity
@ -10006,9 +10003,12 @@ paths:
operationId: PostRestoreShardId
parameters:
- $ref: '#/components/parameters/TraceSpan'
- description: >-
When present, its value indicates to the database that compression
is applied to the line-protocol body.
- description: >
The value tells InfluxDB what compression is applied to the line
protocol in the request payload.
To make an API request with a GZIP payload, send `Content-Encoding:
gzip` as a request header.
in: header
name: Content-Encoding
schema:
@ -10055,9 +10055,12 @@ paths:
operationId: PostRestoreSQL
parameters:
- $ref: '#/components/parameters/TraceSpan'
- description: >-
When present, its value indicates to the database that compression
is applied to the line-protocol body.
- description: >
The value tells InfluxDB what compression is applied to the line
protocol in the request payload.
To make an API request with a GZIP payload, send `Content-Encoding:
gzip` as a request header.
in: header
name: Content-Encoding
schema:
@ -12733,14 +12736,22 @@ paths:
format.
For more information and examples, see [Write data with the InfluxDB
For more information and examples, see the following:
- [Write data with the InfluxDB
API](https://docs.influxdata.com/influxdb/v2.1/write-data/developer-tools/api).
- [Optimize writes to
InfluxDB](https://docs.influxdata.com/influxdb/v2.1/write-data/best-practices/optimize-writes/).
operationId: PostWrite
parameters:
- $ref: '#/components/parameters/TraceSpan'
- description: >-
When present, the header value tells the database that compression
is applied to the line protocol in the request body.
- description: >
The value tells InfluxDB what compression is applied to the line
protocol in the request payload.
To make an API request with a GZIP payload, send `Content-Encoding:
gzip` as a request header.
in: header
name: Content-Encoding
schema:
@ -12953,7 +12964,7 @@ tags:
For more information and examples, see the following:
- [Use tokens in API requests](https://docs.influxdata.com/influxdb/v2.1/api-guide/api_intro/#authentication).
- [Authorize API requests](https://docs.influxdata.com/influxdb/v2.1/api-guide/api_intro/#authentication).
- [Manage API tokens](https://docs.influxdata.com/influxdb/v2.1/security/tokens).
- [Assign a token to a specific user](https://docs.influxdata.com/influxdb/v2.1/security/tokens/create-token).
name: Authorizations