chore(api): update v2 products specs and article data

- Update cloud-v2 and oss-v2 OpenAPI ref.yml specs
- Regenerate article data for both v2 products
claude/api-code-samples-plan-MEkQO
Jason Stirnaman 2026-02-03 20:12:01 -06:00
parent 1bc9960a48
commit 6d87f34ee2
6 changed files with 9945 additions and 1156 deletions

View File

@ -99,7 +99,6 @@ tags:
x-traitTag: true
- name: Config
- name: Dashboards
- name: Data I/O endpoints
- description: |
The InfluxDB 1.x data model includes [databases](/influxdb/cloud/reference/glossary/#database)
and [retention policies](/influxdb/cloud/reference/glossary/#retention-policy-rp).
@ -208,7 +207,7 @@ tags:
- name: Ping
- description: |
Retrieve data, analyze queries, and get query suggestions.
name: Query
name: Query data
- description: |
See the [**API Quick Start**](/influxdb/cloud/api-guide/api_intro/)
to get up and running authenticating with tokens, writing to buckets, and querying data.
@ -326,7 +325,7 @@ tags:
- name: Views
- description: |
Write time series data to [buckets](/influxdb/cloud/reference/glossary/#bucket).
name: Write
name: Write data
paths:
/api/v2:
get:
@ -4008,7 +4007,6 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Delete data
tags:
- Data I/O endpoints
- Delete
x-codeSamples:
- label: cURL
@ -6186,8 +6184,7 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Query data
tags:
- Data I/O endpoints
- Query
- Query data
x-codeSamples:
- label: cURL
lang: Shell
@ -6332,7 +6329,7 @@ paths:
type: string
summary: Analyze a Flux query
tags:
- Query
- Query data
x-codeSamples:
- label: 'cURL: Analyze a Flux query'
lang: Shell
@ -6777,7 +6774,7 @@ paths:
description: Internal server error.
summary: Generate a query Abstract Syntax Tree (AST)
tags:
- Query
- Query data
x-codeSamples:
- label: 'cURL: Analyze and generate AST for the query'
lang: Shell
@ -7441,7 +7438,7 @@ paths:
description: Internal server error.
summary: List Flux query suggestions
tags:
- Query
- Query data
x-codeSamples:
- label: cURL
lang: Shell
@ -7513,7 +7510,7 @@ paths:
The value passed for _`name`_ may have been misspelled.
summary: Retrieve a query suggestion for a branching suggestion
tags:
- Query
- Query data
x-codeSamples:
- label: cURL
lang: Shell
@ -7639,7 +7636,6 @@ paths:
description: Unexpected error.
summary: List scripts
tags:
- Data I/O endpoints
- Invokable Scripts
x-codeSamples:
- label: 'cURL: retrieves the first 100 scripts.'
@ -7835,7 +7831,6 @@ paths:
description: Internal server error.
summary: Retrieve a script
tags:
- Data I/O endpoints
- Invokable Scripts
patch:
description: |
@ -8048,7 +8043,6 @@ paths:
description: Unexpected error.
summary: Invoke a script
tags:
- Data I/O endpoints
- Invokable Scripts
x-codeSamples:
- label: cURL
@ -8935,7 +8929,6 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: List all tasks
tags:
- Data I/O endpoints
- Tasks
x-codeSamples:
- label: 'cURL: all tasks, basic output'
@ -9054,7 +9047,6 @@ paths:
description: Unexpected error
summary: Create a task
tags:
- Data I/O endpoints
- Tasks
x-codeSamples:
- label: 'cURL: create a Flux script task'
@ -9161,7 +9153,6 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Retrieve a task
tags:
- Data I/O endpoints
- Tasks
patch:
description: |
@ -9803,7 +9794,6 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Start a task run, overriding the schedule
tags:
- Data I/O endpoints
- Tasks
/api/v2/tasks/{taskID}/runs/{runID}:
delete:
@ -11832,8 +11822,7 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Write data
tags:
- Data I/O endpoints
- Write
- Write data
/legacy/authorizations:
get:
operationId: GetLegacyAuthorizations
@ -19069,6 +19058,36 @@ components:
in: header
name: Authorization
type: apiKey
QuerystringAuthentication:
description: |
Use the query string authentication scheme with InfluxDB v1-compatible API operations.
Pass your InfluxDB Cloud email address and API token as query parameters using `u` for username and `p` for password (API token).
### Syntax
`?u=EMAIL_ADDRESS&p=INFLUX_API_TOKEN`
### Example
```sh
curl --get "INFLUX_URL/query" \
--data-urlencode "u=EMAIL_ADDRESS" \
--data-urlencode "p=INFLUX_API_TOKEN" \
--data-urlencode "q=SHOW DATABASES"
```
Replace the following:
- *`INFLUX_URL`*: your InfluxDB Cloud URL
- *`EMAIL_ADDRESS`*: your InfluxDB Cloud email address
- *`INFLUX_API_TOKEN`*: your [InfluxDB API token](/influxdb/cloud/reference/glossary/#token)
> [!Warning]
> Query string authentication exposes your credentials in the URL and server logs.
> Use [Token authentication](#section/Authentication/TokenAuthentication) for production environments.
in: query
name: u
type: apiKey
x-tagGroups:
- name: Using the InfluxDB HTTP API
tags:
@ -19099,7 +19118,7 @@ x-tagGroups:
- NotificationRules
- Organizations
- Ping
- Query
- Query data
- Resources
- Routes
- Rules
@ -19115,4 +19134,4 @@ x-tagGroups:
- Users
- Variables
- Views
- Write
- Write data

View File

@ -100,7 +100,6 @@ tags:
- [Manage v1-compatible users and permissions](#tag/Authorizations-(v1-compatible))
- name: Config
- name: Dashboards
- name: Data I/O endpoints
- description: |
The InfluxDB 1.x data model includes [databases](/influxdb/v2/reference/glossary/#database)
and [retention policies](/influxdb/v2/reference/glossary/#retention-policy-rp).
@ -200,7 +199,7 @@ tags:
- name: Ping
- description: |
Retrieve data, analyze queries, and get query suggestions.
name: Query
name: Query data
- name: Query data (v1-compatible)
- description: |
See the [**API Quick Start**](/influxdb/v2/api-guide/api_intro/)
@ -321,7 +320,7 @@ tags:
- name: Views
- description: |
Write time series data to [buckets](/influxdb/v2/reference/glossary/#bucket).
name: Write
name: Write data
- name: Write data (v1-compatible)
paths:
/api/v2:
@ -4490,7 +4489,6 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Delete data
tags:
- Data I/O endpoints
- Delete
x-codeSamples:
- label: cURL
@ -6690,8 +6688,7 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Query data
tags:
- Data I/O endpoints
- Query
- Query data
x-codeSamples:
- label: cURL
lang: Shell
@ -6836,7 +6833,7 @@ paths:
type: string
summary: Analyze a Flux query
tags:
- Query
- Query data
x-codeSamples:
- label: 'cURL: Analyze a Flux query'
lang: Shell
@ -7281,7 +7278,7 @@ paths:
description: Internal server error.
summary: Generate a query Abstract Syntax Tree (AST)
tags:
- Query
- Query data
x-codeSamples:
- label: 'cURL: Analyze and generate AST for the query'
lang: Shell
@ -7945,7 +7942,7 @@ paths:
description: Internal server error.
summary: List Flux query suggestions
tags:
- Query
- Query data
x-codeSamples:
- label: cURL
lang: Shell
@ -8017,7 +8014,7 @@ paths:
The value passed for _`name`_ may have been misspelled.
summary: Retrieve a query suggestion for a branching suggestion
tags:
- Query
- Query data
x-codeSamples:
- label: cURL
lang: Shell
@ -9930,7 +9927,6 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: List tasks
tags:
- Data I/O endpoints
- Tasks
x-codeSamples:
- label: 'cURL: all tasks, basic output'
@ -10001,7 +9997,6 @@ paths:
description: Unexpected error
summary: Create a task
tags:
- Data I/O endpoints
- Tasks
x-codeSamples:
- label: 'cURL: create a task'
@ -10086,7 +10081,6 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Retrieve a task
tags:
- Data I/O endpoints
- Tasks
patch:
description: |
@ -10680,7 +10674,6 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Start a task run, overriding the schedule
tags:
- Data I/O endpoints
- Tasks
/api/v2/tasks/{taskID}/runs/{runID}:
delete:
@ -12809,8 +12802,7 @@ paths:
$ref: '#/components/responses/GeneralServerError'
summary: Write data
tags:
- Data I/O endpoints
- Write
- Write data
/legacy/authorizations:
get:
operationId: GetLegacyAuthorizations
@ -20173,6 +20165,36 @@ components:
in: header
name: Authorization
type: apiKey
QuerystringAuthentication:
description: |
Use the query string authentication scheme with InfluxDB v1-compatible API operations.
Pass your InfluxDB username and API token as query parameters using `u` for username and `p` for password (API token).
### Syntax
`?u=USERNAME&p=INFLUX_API_TOKEN`
### Example
```sh
curl --get "INFLUX_URL/query" \
--data-urlencode "u=USERNAME" \
--data-urlencode "p=INFLUX_API_TOKEN" \
--data-urlencode "q=SHOW DATABASES"
```
Replace the following:
- *`INFLUX_URL`*: your InfluxDB URL
- *`USERNAME`*: your InfluxDB username
- *`INFLUX_API_TOKEN`*: your [InfluxDB API token](/influxdb/v2/reference/glossary/#token)
> [!Warning]
> Query string authentication exposes your credentials in the URL and server logs.
> Use [Token authentication](#section/Authentication/TokenAuthentication) for production environments.
in: query
name: u
type: apiKey
x-tagGroups:
- name: Using the InfluxDB HTTP API
tags:
@ -20204,7 +20226,7 @@ x-tagGroups:
- NotificationRules
- Organizations
- Ping
- Query
- Query data
- Query data (v1-compatible)
- Ready
- RemoteConnections
@ -20226,5 +20248,5 @@ x-tagGroups:
- Users
- Variables
- Views
- Write
- Write data
- Write data (v1-compatible)

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff