Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

chore(api-ref): Uplift API reference docs: #5595

Draft
wants to merge 14 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ node_modules
.hugo_build.lock
/content/influxdb/*/api/**/*.html
/api-docs/redoc-static.html*
/data/api*
/content/influxdb/*/api/**
.vscode/*
.idea
**/config.toml
Expand Down
1 change: 1 addition & 0 deletions api-docs/.spectral.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
extends: ["spectral:oas", "spectral:asyncapi", "spectral:arazzo"]
12 changes: 1 addition & 11 deletions api-docs/cloud-dedicated/management/openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,7 @@ info:
url: https://opensource.org/licenses/MIT
version: ''
servers:
- url: https://{baseurl}/api/v0
description: InfluxDB Cloud Dedicated Management API URL
variables:
baseurl:
enum:
- console.influxdata.com
default: console.influxdata.com
description: InfluxDB Cloud Dedicated Console URL
- url: /
security:
- bearerAuthManagementToken: []
bearerAuthJwt: []
Expand All @@ -37,8 +30,6 @@ tags:
See how to [create a management token](/influxdb/cloud-dedicated/admin/tokens/management/).

By default, management tokens in InfluxDB v3 are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your InfluxDB cluster. However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB cluster and do not require human interaction with your identity provider.


- name: Database tokens
description: Manage database read/write tokens for a cluster
- name: Databases
Expand Down Expand Up @@ -1020,7 +1011,6 @@ paths:
For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os).

If you lose a token, [delete the token from InfluxDB](/influxdb/cloud-dedicated/admin/tokens/database/delete/) and create a new one.

parameters:
- name: accountId
in: path
Expand Down
22 changes: 11 additions & 11 deletions api-docs/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ tags:

<!-- ReDoc-Inject: <security-definitions> -->
x-traitTag: true
- name: Ping
- name: Query
- name: Write
paths:
Expand Down Expand Up @@ -244,7 +245,7 @@ paths:
get:
description: |
Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.

The response is a HTTP `204` status code to inform you the querier is available.

For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
Expand Down Expand Up @@ -282,15 +283,14 @@ paths:
head:
description: |
Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.

The response is a HTTP `204` status code to inform you the querier is available.

For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.

To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write).

This endpoint doesn't require authentication.

operationId: HeadPing
responses:
'204':
Expand Down Expand Up @@ -357,9 +357,9 @@ components:
properties:
results:
description: |
A resultset object that contains the `statement_id` and the `series` array.
A resultset object that contains the `statement_id` and the `series` array.

Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
items:
properties:
error:
Expand Down Expand Up @@ -408,12 +408,12 @@ components:
type: integer
type: object
oneOf:
- required:
- statement_id
- error
- required:
- statement_id
- series
- required:
- statement_id
- error
- required:
- statement_id
- series
type: array
type: object
InfluxQLCSVResponse:
Expand Down
29 changes: 11 additions & 18 deletions api-docs/cloud-dedicated/v2/ref.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,7 @@ info:
summary: The InfluxDB v2 HTTP API for InfluxDB Cloud Dedicated provides a v2-compatible programmatic interface for writing data stored in an InfluxDB Cloud Dedicated database.
version: ''
servers:
- url: https://{baseurl}
description: InfluxDB Cloud Dedicated API URL
variables:
baseurl:
enum:
- cluster-id.a.influxdb.io
default: cluster-id.a.influxdb.io
description: InfluxDB Cloud Dedicated URL
- url: /
security:
- BearerAuthentication: []
- TokenAuthentication: []
Expand Down Expand Up @@ -150,7 +143,7 @@ paths:
get:
description: |
Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.

The response is a HTTP `204` status code to inform you the querier is available.

For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
Expand Down Expand Up @@ -188,7 +181,7 @@ paths:
head:
description: |
Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.

The response is a HTTP `204` status code to inform you the querier is available.

For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
Expand Down Expand Up @@ -1243,9 +1236,9 @@ components:
properties:
results:
description: |
A resultset object that contains the `statement_id` and the `series` array.
A resultset object that contains the `statement_id` and the `series` array.

Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
items:
properties:
error:
Expand Down Expand Up @@ -1294,12 +1287,12 @@ components:
type: integer
type: object
oneOf:
- required:
- statement_id
- error
- required:
- statement_id
- series
- required:
- statement_id
- error
- required:
- statement_id
- series
type: array
type: object
IntegerLiteral:
Expand Down
16 changes: 8 additions & 8 deletions api-docs/cloud-serverless/v1-compatibility/swaggerV1Compat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -280,9 +280,9 @@ components:
properties:
results:
description: |
A resultset object that contains the `statement_id` and the `series` array.
A resultset object that contains the `statement_id` and the `series` array.

Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
items:
properties:
error:
Expand Down Expand Up @@ -331,12 +331,12 @@ components:
type: integer
type: object
oneOf:
- required:
- statement_id
- error
- required:
- statement_id
- series
- required:
- statement_id
- error
- required:
- statement_id
- series
type: array
type: object
InfluxQLCSVResponse:
Expand Down
25 changes: 9 additions & 16 deletions api-docs/cloud-serverless/v2/ref.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,7 @@ info:
The InfluxDB v2 HTTP API for InfluxDB Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB Cloud Serverless bucket.
version: ''
servers:
- url: https://{baseurl}
description: InfluxDB Cloud Serverless API URL
variables:
baseurl:
enum:
- us-east-1-1.aws.cloud2.influxdata.com
default: us-east-1-1.aws.cloud2.influxdata.com
description: InfluxDB Cloud Serverless URL
- url: /
security:
- TokenAuthentication: []
tags:
Expand Down Expand Up @@ -10280,9 +10273,9 @@ components:
properties:
results:
description: |
A resultset object that contains the `statement_id` and the `series` array.
A resultset object that contains the `statement_id` and the `series` array.

Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
items:
properties:
error:
Expand Down Expand Up @@ -10331,12 +10324,12 @@ components:
type: integer
type: object
oneOf:
- required:
- statement_id
- error
- required:
- statement_id
- series
- required:
- statement_id
- error
- required:
- statement_id
- series
type: array
type: object
IntegerLiteral:
Expand Down
16 changes: 8 additions & 8 deletions api-docs/cloud/v1-compatibility/swaggerV1Compat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -276,9 +276,9 @@ components:
properties:
results:
description: |
A resultset object that contains the `statement_id` and the `series` array.
A resultset object that contains the `statement_id` and the `series` array.

Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
items:
properties:
error:
Expand Down Expand Up @@ -327,12 +327,12 @@ components:
type: integer
type: object
oneOf:
- required:
- statement_id
- error
- required:
- statement_id
- series
- required:
- statement_id
- error
- required:
- statement_id
- series
type: array
type: object
InfluxQLCSVResponse:
Expand Down
25 changes: 9 additions & 16 deletions api-docs/cloud/v2/ref.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,7 @@ info:
url: https://opensource.org/licenses/MIT
summary: The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2.
servers:
- url: https://{baseurl}
description: InfluxDB Cloud API URL
variables:
baseurl:
enum:
- us-east-1-1.aws.cloud2.influxdata.com
default: us-east-1-1.aws.cloud2.influxdata.com
description: InfluxDB Cloud URL
- url: /
security:
- TokenAuthentication: []
tags:
Expand Down Expand Up @@ -14600,9 +14593,9 @@ components:
properties:
results:
description: |
A resultset object that contains the `statement_id` and the `series` array.
A resultset object that contains the `statement_id` and the `series` array.

Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
items:
properties:
error:
Expand Down Expand Up @@ -14651,12 +14644,12 @@ components:
type: integer
type: object
oneOf:
- required:
- statement_id
- error
- required:
- statement_id
- series
- required:
- statement_id
- error
- required:
- statement_id
- series
type: array
type: object
IntegerLiteral:
Expand Down
16 changes: 8 additions & 8 deletions api-docs/clustered/v1-compatibility/swaggerV1Compat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -280,9 +280,9 @@ components:
properties:
results:
description: |
A resultset object that contains the `statement_id` and the `series` array.
A resultset object that contains the `statement_id` and the `series` array.

Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
items:
properties:
error:
Expand Down Expand Up @@ -331,12 +331,12 @@ components:
type: integer
type: object
oneOf:
- required:
- statement_id
- error
- required:
- statement_id
- series
- required:
- statement_id
- error
- required:
- statement_id
- series
type: array
type: object
InfluxQLCSVResponse:
Expand Down
Loading