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

feat(api-docs): add externalDocs to tags, strip absolute URLs, fix link pipeline 

- Add standard OpenAPI `externalDocs` field to all tags.yml files that
  have `x-related` entries (uses first link as the primary doc link)
- Convert `externalDocs` to `{title, href}` objects in related links
  instead of bare URL strings
- Strip `https://docs.influxdata.com` from description/summary fields
  in `transformDocLinks()` so Hugo pages use relative paths
- Fix article generation reading from absolutified download spec instead
  of the Hugo spec with relative links (new `hugoSpecPath` output)
- Add `externalDocs.url` support to `absolutifyLinks()` for downloads
clean-squash
Jason Stirnaman 2026-03-16 15:34:43 -05:00
parent 83800428e6
commit bbe513e0c5
15 changed files with 1393 additions and 1277 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
api-docs/enterprise_influxdb/v1/tags.yml
View File

@ -1,40 +1,24 @@
tags:
System Information:
description: >
Check server status, health, and version information for an InfluxDB
Enterprise v1 instance.
description: |
Check server status, health, and version information for an InfluxDB Enterprise v1 instance.
Query:
description: >
Query data using InfluxQL via the `/query` endpoint, supporting both read
queries (SELECT, SHOW) and management queries (CREATE, DROP, ALTER).
description: |
Query data using InfluxQL via the `/query` endpoint, supporting both read queries (SELECT, SHOW) and management queries (CREATE, DROP, ALTER).
Write:
description: >
Write time series data to InfluxDB Enterprise v1 in line protocol format
using the `/write` endpoint.
description: |
Write time series data to InfluxDB Enterprise v1 in line protocol format using the `/write` endpoint.
## Enterprise cluster parameters
- **Write Consistency**: Control write consistency across cluster nodes
Debug:
description: >
Access debugging and profiling endpoints for troubleshooting and
performance analysis of an InfluxDB Enterprise v1 instance.
description: |
Access debugging and profiling endpoints for troubleshooting and performance analysis of an InfluxDB Enterprise v1 instance.
Buckets (v2 compatible):
description: >
Manage databases as buckets using InfluxDB v2-compatible endpoints.
Provides forward compatibility with InfluxDB 2.x client libraries
and InfluxDB Enterprise 1.8+.
description: |
Manage databases as buckets using InfluxDB v2-compatible endpoints. Provides forward compatibility with InfluxDB 2.x client libraries and InfluxDB Enterprise 1.8+.
Delete (v2 compatible):
description: >
Delete data using InfluxDB v2-compatible predicate expressions.
Provides forward compatibility with InfluxDB 2.x client libraries
and InfluxDB Enterprise 1.8+.
description: |
Delete data using InfluxDB v2-compatible predicate expressions. Provides forward compatibility with InfluxDB 2.x client libraries and InfluxDB Enterprise 1.8+.
Authentication:
x-traitTag: true
description: |
@ -49,6 +33,9 @@ tags:
- [Query string authentication](#section/Authentication/QueryAuth)
- [Token authentication](#section/Authentication/TokenAuth)
<!-- ReDoc-Inject: <security-definitions> -->
externalDocs:
description: Configure authentication
url: /enterprise_influxdb/v1/administration/configure/security/authentication/
x-related:
- title: Configure authentication
href: /enterprise_influxdb/v1/administration/configure/security/authentication/

248
api-docs/influxdb/cloud/tags.yml
View File

@ -8,183 +8,140 @@ tags:
- [Basic authentication](#section/Authentication/BasicAuthentication)
- [Querystring authentication](#section/Authentication/QuerystringAuthentication)
<!-- ReDoc-Inject: <security-definitions> -->
Authorizations (API tokens):
description: >
Create and manage API token authorizations that grant read and write
permissions to InfluxDB Cloud organization resources.
description: |
Create and manage API token authorizations that grant read and write permissions to InfluxDB Cloud organization resources.
externalDocs:
description: Manage API tokens
url: /influxdb/cloud/security/tokens/
x-related:
- title: Manage API tokens
href: /influxdb/cloud/security/tokens/
Bucket Schemas:
description: >
Manage explicit schemas for InfluxDB Cloud buckets to enforce column
names and data types for measurement data.
description: |
Manage explicit schemas for InfluxDB Cloud buckets to enforce column names and data types for measurement data.
Buckets:
description: >
Create and manage named storage locations (buckets) in InfluxDB Cloud,
each with a configurable retention period.
description: |
Create and manage named storage locations (buckets) in InfluxDB Cloud, each with a configurable retention period.
externalDocs:
description: Manage buckets
url: /influxdb/cloud/organizations/buckets/
x-related:
- title: Manage buckets
href: /influxdb/cloud/organizations/buckets/
Cells:
description: >
description: |
Manage cells within InfluxDB Cloud dashboards.
Checks:
description: >
Create and manage monitoring checks that query data on a schedule and
generate notification statuses in InfluxDB Cloud.
description: |
Create and manage monitoring checks that query data on a schedule and generate notification statuses in InfluxDB Cloud.
Common parameters:
x-traitTag: true
description: >
Common query parameters used by InfluxDB Cloud API endpoints, including
`bucket`, `bucketID`, `org`, and `orgID`.
description: |
Common query parameters used by InfluxDB Cloud API endpoints, including `bucket`, `bucketID`, `org`, and `orgID`.
Config:
description: >
description: |
Retrieve configuration information for an InfluxDB Cloud instance.
Dashboards:
description: >
description: |
Create and manage dashboards in InfluxDB Cloud.
DBRPs:
description: >
Manage database and retention policy (DBRP) mappings that route InfluxDB
v1-compatible requests to InfluxDB Cloud buckets.
description: |
Manage database and retention policy (DBRP) mappings that route InfluxDB v1-compatible requests to InfluxDB Cloud buckets.
externalDocs:
description: Database and retention policy mapping
url: /influxdb/cloud/reference/api/influxdb-1x/dbrp/
x-related:
- title: Database and retention policy mapping
href: /influxdb/cloud/reference/api/influxdb-1x/dbrp/
Delete:
description: >
Delete time series data from an InfluxDB Cloud bucket by specifying a
time range and optional tag predicate.
description: |
Delete time series data from an InfluxDB Cloud bucket by specifying a time range and optional tag predicate.
Headers:
x-traitTag: true
description: >
Standard HTTP request headers used by InfluxDB Cloud API endpoints,
including `Accept`, `Authorization`, `Content-Length`, and `Content-Type`.
description: |
Standard HTTP request headers used by InfluxDB Cloud API endpoints, including `Accept`, `Authorization`, `Content-Length`, and `Content-Type`.
Invokable Scripts:
description: >
Store, manage, and execute custom Flux scripts in InfluxDB Cloud.
Scripts accept runtime parameters and can be invoked via dedicated
endpoints.
description: |
Store, manage, and execute custom Flux scripts in InfluxDB Cloud. Scripts accept runtime parameters and can be invoked via dedicated endpoints.
Labels:
description: >
Create and manage labels for organizing InfluxDB Cloud resources such as
dashboards, tasks, and buckets.
description: |
Create and manage labels for organizing InfluxDB Cloud resources such as dashboards, tasks, and buckets.
Legacy Authorizations:
description: >
description: |
Manage legacy (v1-compatible) authorization credentials in InfluxDB Cloud.
Legacy Query:
description: >
Query data using InfluxQL via the v1-compatible `/query` endpoint in
InfluxDB Cloud.
description: |
Query data using InfluxQL via the v1-compatible `/query` endpoint in InfluxDB Cloud.
Legacy Write:
description: >
description: |
Write data using the v1-compatible `/write` endpoint in InfluxDB Cloud.
Limits:
description: >
description: |
Retrieve rate limits and usage quotas for an InfluxDB Cloud organization.
NotificationEndpoints:
description: >
Create and manage notification endpoints that receive alert notifications
from InfluxDB Cloud monitoring checks.
description: |
Create and manage notification endpoints that receive alert notifications from InfluxDB Cloud monitoring checks.
NotificationRules:
description: >
Create and manage notification rules that define when and how InfluxDB
Cloud sends notifications to configured endpoints.
description: |
Create and manage notification rules that define when and how InfluxDB Cloud sends notifications to configured endpoints.
Organizations:
description: >
View and manage InfluxDB Cloud organizations, which are workspaces that
group users, buckets, and resources.
description: |
View and manage InfluxDB Cloud organizations, which are workspaces that group users, buckets, and resources.
externalDocs:
description: View and manage organizations
url: /influxdb/cloud/organizations/
x-related:
- title: View and manage organizations
href: /influxdb/cloud/organizations/
Pagination:
x-traitTag: true
description: >
Query parameters for paginating results from list operations in the
InfluxDB Cloud API.
description: |
Query parameters for paginating results from list operations in the InfluxDB Cloud API.
Ping:
description: >
description: |
Check the availability of the InfluxDB Cloud instance.
Query data:
description: >
Retrieve data, analyze queries, and get query suggestions using the
InfluxDB Cloud query API.
description: |
Retrieve data, analyze queries, and get query suggestions using the InfluxDB Cloud query API.
externalDocs:
description: Query data
url: /influxdb/cloud/query-data/
x-related:
- title: Query data
href: /influxdb/cloud/query-data/
Quick start:
x-traitTag: true
description: >
Get started authenticating, writing, and querying data with the InfluxDB
Cloud API.
description: |
Get started authenticating, writing, and querying data with the InfluxDB Cloud API.
Resources:
description: >
Retrieve a list of top-level resource types available in the InfluxDB
Cloud API.
description: |
Retrieve a list of top-level resource types available in the InfluxDB Cloud API.
Response codes:
x-traitTag: true
description: >
Standard HTTP status codes returned by InfluxDB Cloud API endpoints and
their meanings.
description: |
Standard HTTP status codes returned by InfluxDB Cloud API endpoints and their meanings.
Routes:
description: >
description: |
Retrieve top-level routes for the InfluxDB Cloud API.
Rules:
description: >
description: |
Manage notification rules in InfluxDB Cloud.
Secrets:
description: >
Create and manage secrets (key-value pairs) for use in InfluxDB Cloud
Flux scripts and tasks.
description: |
Create and manage secrets (key-value pairs) for use in InfluxDB Cloud Flux scripts and tasks.
Security and access endpoints:
description: >
Endpoints for managing authentication and access control in InfluxDB
Cloud.
description: |
Endpoints for managing authentication and access control in InfluxDB Cloud.
Setup:
description: >
Configure an initial InfluxDB Cloud instance, including creating the
initial user, organization, and bucket.
description: |
Configure an initial InfluxDB Cloud instance, including creating the initial user, organization, and bucket.
Signin:
description: >
Create a user session by signing in with username and password
credentials.
description: |
Create a user session by signing in with username and password credentials.
Signout:
description: >
description: |
End a user session by signing out.
Supported operations:
x-traitTag: true
description: |
@ -197,62 +154,57 @@ tags:
| **Read** | `GET` | Retrieve a resource or list resources. |
| **Update** | `PUT`, `PATCH` | Replace or modify an existing resource. |
| **Delete** | `DELETE` | Remove a resource. |
System information endpoints:
description: >
Endpoints for retrieving system-level information about the InfluxDB
Cloud instance.
description: |
Endpoints for retrieving system-level information about the InfluxDB Cloud instance.
Tasks:
description: >
Schedule and manage Flux tasks that process and transform data on a
recurring basis in InfluxDB Cloud.
description: |
Schedule and manage Flux tasks that process and transform data on a recurring basis in InfluxDB Cloud.
externalDocs:
description: Get started with tasks
url: /influxdb/cloud/process-data/get-started/
x-related:
- title: Get started with tasks
href: /influxdb/cloud/process-data/get-started/
Telegraf Plugins:
description: >
Retrieve available Telegraf plugin configuration templates for use with
InfluxDB Cloud.
description: |
Retrieve available Telegraf plugin configuration templates for use with InfluxDB Cloud.
Telegrafs:
description: >
Create and manage Telegraf agent configurations that collect and write
data to InfluxDB Cloud.
description: |
Create and manage Telegraf agent configurations that collect and write data to InfluxDB Cloud.
Templates:
description: >
Export and apply InfluxDB templates, and manage template stacks for
InfluxDB Cloud.
description: |
Export and apply InfluxDB templates, and manage template stacks for InfluxDB Cloud.
externalDocs:
description: InfluxDB templates
url: /influxdb/cloud/influxdb-templates/
x-related:
- title: InfluxDB templates
href: /influxdb/cloud/influxdb-templates/
Usage:
description: >
Retrieve usage metrics and cardinality data for an InfluxDB Cloud
organization.
description: |
Retrieve usage metrics and cardinality data for an InfluxDB Cloud organization.
Users:
description: >
description: |
View specific users that are members of your InfluxDB Cloud organization.
externalDocs:
description: Manage users
url: /influxdb/cloud/organizations/users/
x-related:
- title: Manage users
href: /influxdb/cloud/organizations/users/
Variables:
description: >
description: |
Create and manage variables for use in InfluxDB Cloud dashboards.
Views:
description: >
description: |
Manage cell views within InfluxDB Cloud dashboards.
Write data:
description: >
Write time series data to InfluxDB Cloud buckets in line protocol format
using the `/api/v2/write` endpoint.
description: |
Write time series data to InfluxDB Cloud buckets in line protocol format using the `/api/v2/write` endpoint.
externalDocs:
description: Write data
url: /influxdb/cloud/write-data/
x-related:
- title: Write data
href: /influxdb/cloud/write-data/

41
api-docs/influxdb/v1/tags.yml
View File

@ -1,36 +1,22 @@
tags:
System Information:
description: >
Check server status, health, and version information for an InfluxDB
v1 instance.
description: |
Check server status, health, and version information for an InfluxDB v1 instance.
Query:
description: >
Query data using InfluxQL via the `/query` endpoint, supporting both read
queries (SELECT, SHOW) and management queries (CREATE, DROP, ALTER).
description: |
Query data using InfluxQL via the `/query` endpoint, supporting both read queries (SELECT, SHOW) and management queries (CREATE, DROP, ALTER).
Write:
description: >
Write time series data to InfluxDB v1 in line protocol format using the
`/write` endpoint.
description: |
Write time series data to InfluxDB v1 in line protocol format using the `/write` endpoint.
Debug:
description: >
Access debugging and profiling endpoints for troubleshooting and
performance analysis of an InfluxDB v1 instance.
description: |
Access debugging and profiling endpoints for troubleshooting and performance analysis of an InfluxDB v1 instance.
Buckets (v2 compatible):
description: >
Manage databases as buckets using InfluxDB v2-compatible endpoints.
Provides forward compatibility with InfluxDB 2.x client libraries
and InfluxDB 1.8+.
description: |
Manage databases as buckets using InfluxDB v2-compatible endpoints. Provides forward compatibility with InfluxDB 2.x client libraries and InfluxDB 1.8+.
Delete (v2 compatible):
description: >
Delete data using InfluxDB v2-compatible predicate expressions.
Provides forward compatibility with InfluxDB 2.x client libraries
and InfluxDB 1.8+.
description: |
Delete data using InfluxDB v2-compatible predicate expressions. Provides forward compatibility with InfluxDB 2.x client libraries and InfluxDB 1.8+.
Authentication:
x-traitTag: true
description: |
@ -45,6 +31,9 @@ tags:
- [Query string authentication](#section/Authentication/QueryAuth)
- [Token authentication](#section/Authentication/TokenAuth)
<!-- ReDoc-Inject: <security-definitions> -->
externalDocs:
description: Manage authentication and authorization
url: /influxdb/v1/administration/authentication_and_authorization/
x-related:
- title: Manage authentication and authorization
href: /influxdb/v1/administration/authentication_and_authorization/

293
api-docs/influxdb/v2/tags.yml
View File

@ -8,221 +8,168 @@ tags:
- [Basic authentication](#section/Authentication/BasicAuthentication)
- [Querystring authentication](#section/Authentication/QuerystringAuthentication)
<!-- ReDoc-Inject: <security-definitions> -->
Authorizations (API tokens):
description: >
Create and manage API token authorizations that grant read and write
permissions to InfluxDB OSS v2 organization resources.
description: |
Create and manage API token authorizations that grant read and write permissions to InfluxDB OSS v2 organization resources.
externalDocs:
description: Manage API tokens
url: /influxdb/v2/security/tokens/
x-related:
- title: Manage API tokens
href: /influxdb/v2/security/tokens/
Authorizations (v1-compatible):
description: >
description: |
Manage v1-compatible legacy authorization credentials in InfluxDB OSS v2.
Backup:
description: >
Back up InfluxDB OSS v2 data, including time series data and metadata,
for use in restore operations.
description: |
Back up InfluxDB OSS v2 data, including time series data and metadata, for use in restore operations.
Buckets:
description: >
Create and manage named storage locations (buckets) in InfluxDB OSS v2,
each with a configurable retention period.
description: |
Create and manage named storage locations (buckets) in InfluxDB OSS v2, each with a configurable retention period.
externalDocs:
description: Manage buckets
url: /influxdb/v2/organizations/buckets/
x-related:
- title: Manage buckets
href: /influxdb/v2/organizations/buckets/
Cells:
description: >
description: |
Manage cells within InfluxDB OSS v2 dashboards.
Checks:
description: >
Create and manage monitoring checks that query data on a schedule and
generate notification statuses in InfluxDB OSS v2.
description: |
Create and manage monitoring checks that query data on a schedule and generate notification statuses in InfluxDB OSS v2.
Common parameters:
x-traitTag: true
description: >
Common query parameters used by InfluxDB OSS v2 API endpoints, including
`bucket`, `bucketID`, `org`, and `orgID`.
description: |
Common query parameters used by InfluxDB OSS v2 API endpoints, including `bucket`, `bucketID`, `org`, and `orgID`.
Compatibility endpoints:
x-traitTag: true
description: >
InfluxDB v1-compatible API endpoints for backward compatibility with
InfluxDB 1.x clients, tools, and integrations such as Grafana and
Telegraf.
description: |
InfluxDB v1-compatible API endpoints for backward compatibility with InfluxDB 1.x clients, tools, and integrations such as Grafana and Telegraf.
Config:
description: >
description: |
Retrieve configuration information for an InfluxDB OSS v2 instance.
Dashboards:
description: >
description: |
Create and manage dashboards in InfluxDB OSS v2.
DBRPs:
description: >
Manage database and retention policy (DBRP) mappings that route InfluxDB
v1-compatible requests to InfluxDB OSS v2 buckets.
description: |
Manage database and retention policy (DBRP) mappings that route InfluxDB v1-compatible requests to InfluxDB OSS v2 buckets.
externalDocs:
description: Database and retention policy mapping
url: /influxdb/v2/reference/api/influxdb-1x/dbrp/
x-related:
- title: Database and retention policy mapping
href: /influxdb/v2/reference/api/influxdb-1x/dbrp/
Debug:
description: >
Generate Go runtime profiling and trace reports for troubleshooting and
performance analysis of an InfluxDB OSS v2 instance.
description: |
Generate Go runtime profiling and trace reports for troubleshooting and performance analysis of an InfluxDB OSS v2 instance.
Delete:
description: >
Delete time series data from an InfluxDB OSS v2 bucket by specifying a
time range and optional tag predicate.
description: |
Delete time series data from an InfluxDB OSS v2 bucket by specifying a time range and optional tag predicate.
Headers:
x-traitTag: true
description: >
Standard HTTP request headers used by InfluxDB OSS v2 API endpoints,
including `Accept`, `Authorization`, `Content-Length`, and `Content-Type`.
description: |
Standard HTTP request headers used by InfluxDB OSS v2 API endpoints, including `Accept`, `Authorization`, `Content-Length`, and `Content-Type`.
Health:
description: >
description: |
Check the health and readiness of an InfluxDB OSS v2 instance.
Labels:
description: >
Create and manage labels for organizing InfluxDB OSS v2 resources such as
dashboards, tasks, and buckets.
description: |
Create and manage labels for organizing InfluxDB OSS v2 resources such as dashboards, tasks, and buckets.
Metrics:
description: >
Retrieve internal metrics for an InfluxDB OSS v2 instance in Prometheus
exposition format.
description: |
Retrieve internal metrics for an InfluxDB OSS v2 instance in Prometheus exposition format.
NotificationEndpoints:
description: >
Create and manage notification endpoints that receive alert notifications
from InfluxDB OSS v2 monitoring checks.
description: |
Create and manage notification endpoints that receive alert notifications from InfluxDB OSS v2 monitoring checks.
NotificationRules:
description: >
Create and manage notification rules that define when and how InfluxDB
OSS v2 sends notifications to configured endpoints.
description: |
Create and manage notification rules that define when and how InfluxDB OSS v2 sends notifications to configured endpoints.
Organizations:
description: >
Create and manage InfluxDB OSS v2 organizations, which are workspaces
that group users, buckets, and resources.
description: |
Create and manage InfluxDB OSS v2 organizations, which are workspaces that group users, buckets, and resources.
externalDocs:
description: Manage organizations
url: /influxdb/v2/organizations/
x-related:
- title: Manage organizations
href: /influxdb/v2/organizations/
Pagination:
x-traitTag: true
description: >
Query parameters for paginating results from list operations in the
InfluxDB OSS v2 API.
description: |
Query parameters for paginating results from list operations in the InfluxDB OSS v2 API.
Ping:
description: >
description: |
Check the availability of an InfluxDB OSS v2 instance.
Query data:
description: >
Retrieve data, analyze queries, and get query suggestions using the
InfluxDB OSS v2 query API.
description: |
Retrieve data, analyze queries, and get query suggestions using the InfluxDB OSS v2 query API.
externalDocs:
description: Query data
url: /influxdb/v2/query-data/
x-related:
- title: Query data
href: /influxdb/v2/query-data/
Query data (v1-compatible):
description: >
Query data in InfluxDB OSS v2 using InfluxQL via the v1-compatible
`/query` endpoint.
description: |
Query data in InfluxDB OSS v2 using InfluxQL via the v1-compatible `/query` endpoint.
Quick start:
x-traitTag: true
description: >
Get started authenticating, writing, and querying data with the InfluxDB
OSS v2 API.
description: |
Get started authenticating, writing, and querying data with the InfluxDB OSS v2 API.
Ready:
description: >
description: |
Check whether an InfluxDB OSS v2 instance is ready to accept requests.
RemoteConnections:
description: >
Create and manage remote InfluxDB connections for replicating data from
an InfluxDB OSS v2 instance to a remote InfluxDB instance.
description: |
Create and manage remote InfluxDB connections for replicating data from an InfluxDB OSS v2 instance to a remote InfluxDB instance.
Replications:
description: >
Create and manage replication streams that copy data from an InfluxDB
OSS v2 bucket to a remote InfluxDB instance.
description: |
Create and manage replication streams that copy data from an InfluxDB OSS v2 bucket to a remote InfluxDB instance.
Resources:
description: >
Retrieve a list of top-level resource types available in the InfluxDB
OSS v2 API.
description: |
Retrieve a list of top-level resource types available in the InfluxDB OSS v2 API.
Response codes:
x-traitTag: true
description: >
Standard HTTP status codes returned by InfluxDB OSS v2 API endpoints and
their meanings.
description: |
Standard HTTP status codes returned by InfluxDB OSS v2 API endpoints and their meanings.
Restore:
description: >
Restore InfluxDB OSS v2 data from a backup, including time series data
and metadata.
description: |
Restore InfluxDB OSS v2 data from a backup, including time series data and metadata.
Routes:
description: >
description: |
Retrieve top-level routes for the InfluxDB OSS v2 API.
Rules:
description: >
description: |
Manage notification rules in InfluxDB OSS v2.
Scraper Targets:
description: >
Create and manage Prometheus scraper targets that collect metrics and
write them to InfluxDB OSS v2 buckets.
description: |
Create and manage Prometheus scraper targets that collect metrics and write them to InfluxDB OSS v2 buckets.
Secrets:
description: >
Create and manage secrets (key-value pairs) for use in InfluxDB OSS v2
Flux scripts and tasks.
description: |
Create and manage secrets (key-value pairs) for use in InfluxDB OSS v2 Flux scripts and tasks.
Security and access endpoints:
description: >
Endpoints for managing authentication and access control in InfluxDB
OSS v2.
description: |
Endpoints for managing authentication and access control in InfluxDB OSS v2.
Setup:
description: >
Configure a new InfluxDB OSS v2 instance, including creating the initial
user, organization, bucket, and API token.
description: |
Configure a new InfluxDB OSS v2 instance, including creating the initial user, organization, bucket, and API token.
externalDocs:
description: Set up InfluxDB
url: /influxdb/v2/get-started/
x-related:
- title: Set up InfluxDB
href: /influxdb/v2/get-started/
Signin:
description: >
Create a user session by signing in with username and password
credentials.
description: |
Create a user session by signing in with username and password credentials.
Signout:
description: >
description: |
End a user session by signing out.
Sources:
description: >
description: |
Manage data sources configured in InfluxDB OSS v2.
Supported operations:
x-traitTag: true
description: |
@ -235,63 +182,57 @@ tags:
| **Read** | `GET` | Retrieve a resource or list resources. |
| **Update** | `PUT`, `PATCH` | Replace or modify an existing resource. |
| **Delete** | `DELETE` | Remove a resource. |
System information endpoints:
description: >
Endpoints for retrieving system-level information about the InfluxDB
OSS v2 instance.
description: |
Endpoints for retrieving system-level information about the InfluxDB OSS v2 instance.
Tasks:
description: >
Schedule and manage Flux tasks that process and transform data on a
recurring basis in InfluxDB OSS v2.
description: |
Schedule and manage Flux tasks that process and transform data on a recurring basis in InfluxDB OSS v2.
externalDocs:
description: Get started with tasks
url: /influxdb/v2/process-data/get-started/
x-related:
- title: Get started with tasks
href: /influxdb/v2/process-data/get-started/
Telegraf Plugins:
description: >
Retrieve available Telegraf plugin configuration templates for use with
InfluxDB OSS v2.
description: |
Retrieve available Telegraf plugin configuration templates for use with InfluxDB OSS v2.
Telegrafs:
description: >
Create and manage Telegraf agent configurations that collect and write
data to InfluxDB OSS v2.
description: |
Create and manage Telegraf agent configurations that collect and write data to InfluxDB OSS v2.
Templates:
description: >
Export and apply InfluxDB templates, and manage template stacks for
InfluxDB OSS v2.
description: |
Export and apply InfluxDB templates, and manage template stacks for InfluxDB OSS v2.
externalDocs:
description: InfluxDB templates
url: /influxdb/v2/influxdb-templates/
x-related:
- title: InfluxDB templates
href: /influxdb/v2/influxdb-templates/
Users:
description: >
Create and manage users that have access to InfluxDB OSS v2 organizations
and resources.
description: |
Create and manage users that have access to InfluxDB OSS v2 organizations and resources.
externalDocs:
description: Manage users
url: /influxdb/v2/users/
x-related:
- title: Manage users
href: /influxdb/v2/users/
Variables:
description: >
description: |
Create and manage variables for use in InfluxDB OSS v2 dashboards.
Views:
description: >
description: |
Manage cell views within InfluxDB OSS v2 dashboards.
Write data:
description: >
Write time series data to InfluxDB OSS v2 buckets in line protocol format
using the `/api/v2/write` endpoint.
description: |
Write time series data to InfluxDB OSS v2 buckets in line protocol format using the `/api/v2/write` endpoint.
externalDocs:
description: Write data
url: /influxdb/v2/write-data/
x-related:
- title: Write data
href: /influxdb/v2/write-data/
Write data (v1-compatible):
description: >
Write data to InfluxDB OSS v2 using the v1-compatible `/write` endpoint
with line protocol.
description: |
Write data to InfluxDB OSS v2 using the v1-compatible `/write` endpoint with line protocol.

35
api-docs/influxdb3/cloud-dedicated/management/tags.yml
View File

@ -1,8 +1,10 @@
tags:
Database tokens:
description: >
Create and manage database tokens that authorize read and write access to
InfluxDB 3 Cloud Dedicated databases.
description: |
Create and manage database tokens that authorize read and write access to InfluxDB 3 Cloud Dedicated databases.
externalDocs:
description: Manage database tokens
url: /influxdb3/cloud-dedicated/admin/tokens/database/
x-related:
- title: Manage database tokens
href: /influxdb3/cloud-dedicated/admin/tokens/database/
@ -10,11 +12,12 @@ tags:
href: /influxdb3/cloud-dedicated/admin/tokens/database/delete/
- title: Authenticate Telegraf using tokens in your OS secret store
href: https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os
Databases:
description: >
Create and manage databases in an InfluxDB 3 Cloud Dedicated cluster,
including setting retention periods and custom partition templates.
description: |
Create and manage databases in an InfluxDB 3 Cloud Dedicated cluster, including setting retention periods and custom partition templates.
externalDocs:
description: Manage databases
url: /influxdb3/cloud-dedicated/admin/databases/
x-related:
- title: Manage databases
href: /influxdb3/cloud-dedicated/admin/databases/
@ -22,22 +25,24 @@ tags:
href: /influxdb3/cloud-dedicated/admin/custom-partitions/
- title: Partition templates
href: /influxdb3/cloud-dedicated/admin/custom-partitions/partition-templates/
Quick start:
x-traitTag: true
description: >
Get started creating a database, issuing tokens, and writing data with
the InfluxDB 3 Cloud Dedicated Management API.
description: |
Get started creating a database, issuing tokens, and writing data with the InfluxDB 3 Cloud Dedicated Management API.
externalDocs:
description: Get started with Cloud Dedicated
url: /influxdb3/cloud-dedicated/get-started/
x-related:
- title: Get started with Cloud Dedicated
href: /influxdb3/cloud-dedicated/get-started/
- title: Set up your cluster
href: /influxdb3/cloud-dedicated/get-started/setup/
Tables:
description: >
Manage tables in an InfluxDB 3 Cloud Dedicated database, including
creating tables with custom column schemas.
description: |
Manage tables in an InfluxDB 3 Cloud Dedicated database, including creating tables with custom column schemas.
externalDocs:
description: Manage tables
url: /influxdb3/cloud-dedicated/admin/tables/
x-related:
- title: Manage tables
href: /influxdb3/cloud-dedicated/admin/tables/

61
api-docs/influxdb3/cloud-dedicated/tags.yml
View File

@ -26,6 +26,9 @@ tags:
### InfluxDB v1 compatibility
The HTTP API [`/write` endpoint](#operation/PostLegacyWrite) and [`/query` endpoint](#operation/GetLegacyQuery) work with InfluxDB 1.x username/password [authentication schemes](#section/Authentication/) and existing InfluxDB 1.x tools and code.
externalDocs:
description: Get started querying InfluxDB
url: /influxdb3/cloud-dedicated/get-started/query/
x-related:
- title: Get started querying InfluxDB
href: /influxdb3/cloud-dedicated/get-started/query/
@ -35,7 +38,6 @@ tags:
href: /influxdb3/cloud-dedicated/guides/api-compatibility/v2/
- title: Use the v1 HTTP API with Cloud Dedicated
href: /influxdb3/cloud-dedicated/guides/api-compatibility/v1/
Authentication:
x-traitTag: true
description: |
@ -46,63 +48,50 @@ tags:
- [Basic authentication](#section/Authentication/BasicAuthentication)
- [Querystring authentication](#section/Authentication/QuerystringAuthentication)
<!-- ReDoc-Inject: <security-definitions> -->
Common parameters:
x-traitTag: true
description: >
Common query parameters used by InfluxDB 3 Cloud Dedicated API endpoints,
including the required `database` or `db` parameter.
description: |
Common query parameters used by InfluxDB 3 Cloud Dedicated API endpoints, including the required `database` or `db` parameter.
Headers:
x-traitTag: true
description: >
Standard HTTP request headers used by InfluxDB 3 Cloud Dedicated API
endpoints, including `Accept`, `Authorization`, `Content-Length`, and
`Content-Type`.
description: |
Standard HTTP request headers used by InfluxDB 3 Cloud Dedicated API endpoints, including `Accept`, `Authorization`, `Content-Length`, and `Content-Type`.
Ping:
description: >
description: |
Check the availability of the InfluxDB 3 Cloud Dedicated instance.
Query data:
description: >
Query data stored in InfluxDB 3 Cloud Dedicated using InfluxQL via the
v1-compatible `/query` endpoint. Use Flight+gRPC for SQL or InfluxQL
queries with Arrow format output.
description: |
Query data stored in InfluxDB 3 Cloud Dedicated using InfluxQL via the v1-compatible `/query` endpoint. Use Flight+gRPC for SQL or InfluxQL queries with Arrow format output.
externalDocs:
description: Get started querying InfluxDB
url: /influxdb3/cloud-dedicated/get-started/query/
x-related:
- title: Get started querying InfluxDB
href: /influxdb3/cloud-dedicated/get-started/query/
- title: Execute queries
href: /influxdb3/cloud-dedicated/query-data/execute-queries/
Quick start:
x-traitTag: true
description: >
Get started authenticating, creating a database, and writing and querying
data with the InfluxDB 3 Cloud Dedicated API.
description: |
Get started authenticating, creating a database, and writing and querying data with the InfluxDB 3 Cloud Dedicated API.
Response codes:
x-traitTag: true
description: >
Standard HTTP status codes returned by InfluxDB 3 Cloud Dedicated API
endpoints and their meanings.
description: |
Standard HTTP status codes returned by InfluxDB 3 Cloud Dedicated API endpoints and their meanings.
System information endpoints:
x-traitTag: true
description: >
Endpoints for retrieving system-level information about the InfluxDB 3
Cloud Dedicated instance.
description: |
Endpoints for retrieving system-level information about the InfluxDB 3 Cloud Dedicated instance.
Usage:
x-traitTag: true
description: >
description: |
Retrieve usage metrics for an InfluxDB 3 Cloud Dedicated instance.
Write data:
description: >
Write time series data to InfluxDB 3 Cloud Dedicated databases using the
v2-compatible `/api/v2/write` endpoint or the v1-compatible `/write`
endpoint with line protocol.
description: |
Write time series data to InfluxDB 3 Cloud Dedicated databases using the v2-compatible `/api/v2/write` endpoint or the v1-compatible `/write` endpoint with line protocol.
externalDocs:
description: Write data
url: /influxdb3/cloud-dedicated/write-data/
x-related:
- title: Write data
href: /influxdb3/cloud-dedicated/write-data/

334
api-docs/influxdb3/cloud-serverless/tags.yml
View File

@ -41,6 +41,9 @@ tags:
### InfluxDB v1 compatibility
The `/write` and `/query` endpoints work with InfluxDB 1.x username/password authentication and existing InfluxDB 1.x tools and code.
externalDocs:
description: Write data
url: /influxdb3/cloud-serverless/write-data/
x-related:
- title: Write data
href: /influxdb3/cloud-serverless/write-data/
@ -54,7 +57,6 @@ tags:
href: /influxdb3/cloud-serverless/guides/api-compatibility/v2/
- title: Use the v1 HTTP API with Cloud Serverless
href: /influxdb3/cloud-serverless/guides/api-compatibility/v1/
Authentication:
x-traitTag: true
description: |
@ -62,249 +64,150 @@ tags:
- Token authentication
- Basic authentication
Authorizations (API tokens):
description: >
Create and manage API token authorizations that grant read and write
permissions to InfluxDB 3 Cloud Serverless organization resources.
description: |
Create and manage API token authorizations that grant read and write permissions to InfluxDB 3 Cloud Serverless organization resources.
externalDocs:
description: Manage API tokens
url: /influxdb3/cloud-serverless/security/tokens/
x-related:
- title: Manage API tokens
href: /influxdb3/cloud-serverless/security/tokens/
Bucket Schemas:
description: >
Manage explicit schemas for InfluxDB 3 Cloud Serverless buckets to
enforce column names and data types.
description: |
Manage explicit schemas for InfluxDB 3 Cloud Serverless buckets to enforce column names and data types.
Buckets:
description: >
Create and manage named storage locations (buckets) in InfluxDB 3 Cloud
Serverless, each with a configurable retention period.
description: |
Create and manage named storage locations (buckets) in InfluxDB 3 Cloud Serverless, each with a configurable retention period.
externalDocs:
description: Manage buckets
url: /influxdb3/cloud-serverless/admin/buckets/
x-related:
- title: Manage buckets
href: /influxdb3/cloud-serverless/admin/buckets/
Cells:
x-traitTag: true
description: >
Manage cells within dashboards.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Manage cells within dashboards. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Checks:
x-traitTag: true
description: >
Create and manage monitoring checks that query data and generate
notification statuses.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Create and manage monitoring checks that query data and generate notification statuses. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Common parameters:
x-traitTag: true
description: >
Common query parameters used by InfluxDB 3 Cloud Serverless API
endpoints, including `bucket`, `bucketID`, `org`, and `orgID`.
description: |
Common query parameters used by InfluxDB 3 Cloud Serverless API endpoints, including `bucket`, `bucketID`, `org`, and `orgID`.
Config:
x-traitTag: true
description: >
Retrieve configuration information for an InfluxDB instance.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Retrieve configuration information for an InfluxDB instance. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Dashboards:
x-traitTag: true
description: >
Create and manage dashboards.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Create and manage dashboards. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
DBRPs:
x-traitTag: true
description: >
Manage database and retention policy (DBRP) mappings.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Manage database and retention policy (DBRP) mappings. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Delete:
x-traitTag: true
description: >
Delete time series data from a bucket by specifying a time range and
optional predicate.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Delete time series data from a bucket by specifying a time range and optional predicate. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Headers:
x-traitTag: true
description: >
Standard HTTP request headers used by InfluxDB 3 Cloud Serverless API
endpoints, including `Accept`, `Authorization`, `Content-Length`, and
`Content-Type`.
description: |
Standard HTTP request headers used by InfluxDB 3 Cloud Serverless API endpoints, including `Accept`, `Authorization`, `Content-Length`, and `Content-Type`.
Invokable Scripts:
x-traitTag: true
description: >
Store, manage, and execute custom Flux scripts.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Store, manage, and execute custom Flux scripts. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Labels:
x-traitTag: true
description: >
Create and manage labels for organizing resources.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Create and manage labels for organizing resources. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Legacy Authorizations:
x-traitTag: true
description: >
Manage legacy (v1-compatible) authorization credentials.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Manage legacy (v1-compatible) authorization credentials. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Limits:
description: >
Retrieve rate limits and usage quotas for an InfluxDB 3 Cloud Serverless
organization.
description: |
Retrieve rate limits and usage quotas for an InfluxDB 3 Cloud Serverless organization.
NotificationEndpoints:
x-traitTag: true
description: >
Create and manage notification endpoints that receive alert notifications.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Create and manage notification endpoints that receive alert notifications. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
NotificationRules:
x-traitTag: true
description: >
Create and manage notification rules that define when and how
notifications are sent to endpoints.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Create and manage notification rules that define when and how notifications are sent to endpoints. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Organizations:
description: >
View and manage InfluxDB 3 Cloud Serverless organizations, which are
workspaces that group users, buckets, and resources.
description: |
View and manage InfluxDB 3 Cloud Serverless organizations, which are workspaces that group users, buckets, and resources.
externalDocs:
description: View and manage organizations
url: /influxdb3/cloud-serverless/admin/
x-related:
- title: View and manage organizations
href: /influxdb3/cloud-serverless/admin/
Pagination:
x-traitTag: true
description: >
Query parameters for paginating results from list operations in the
InfluxDB 3 Cloud Serverless API.
description: |
Query parameters for paginating results from list operations in the InfluxDB 3 Cloud Serverless API.
Ping:
x-traitTag: true
description: >
Check the availability of an InfluxDB instance.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Check the availability of an InfluxDB instance. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Query data:
description: >
Query data stored in InfluxDB 3 Cloud Serverless using InfluxQL via the
v1-compatible `/query` endpoint, or using SQL and InfluxQL via
Flight+gRPC clients.
description: |
Query data stored in InfluxDB 3 Cloud Serverless using InfluxQL via the v1-compatible `/query` endpoint, or using SQL and InfluxQL via Flight+gRPC clients.
externalDocs:
description: Get started querying InfluxDB
url: /influxdb3/cloud-serverless/get-started/query/
x-related:
- title: Get started querying InfluxDB
href: /influxdb3/cloud-serverless/get-started/query/
- title: Execute queries
href: /influxdb3/cloud-serverless/query-data/execute-queries/
Quick start:
x-traitTag: true
description: >
Get started writing and querying data with the InfluxDB 3 Cloud
Serverless API.
description: |
Get started writing and querying data with the InfluxDB 3 Cloud Serverless API.
Resources:
x-traitTag: true
description: >
Retrieve a list of top-level resource types available in the API.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Retrieve a list of top-level resource types available in the API. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Response codes:
x-traitTag: true
description: >
Standard HTTP status codes returned by InfluxDB 3 Cloud Serverless API
endpoints and their meanings.
description: |
Standard HTTP status codes returned by InfluxDB 3 Cloud Serverless API endpoints and their meanings.
Routes:
x-traitTag: true
description: >
Retrieve top-level routes for the InfluxDB API.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Retrieve top-level routes for the InfluxDB API. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Rules:
x-traitTag: true
description: >
Manage notification rules.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Manage notification rules. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Secrets:
x-traitTag: true
description: >
Create and manage secrets (key-value pairs) for use in Flux scripts
and tasks.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Create and manage secrets (key-value pairs) for use in Flux scripts and tasks. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Security and access endpoints:
x-traitTag: true
description: >
Endpoints for managing authentication and access control.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Endpoints for managing authentication and access control. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Setup:
x-traitTag: true
description: >
Configure an initial InfluxDB instance, including creating the initial
user, organization, and bucket.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Configure an initial InfluxDB instance, including creating the initial user, organization, and bucket. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Signin:
x-traitTag: true
description: >
Create a user session by signing in with username and password
credentials.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Create a user session by signing in with username and password credentials. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Signout:
x-traitTag: true
description: >
End a user session by signing out.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
End a user session by signing out. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Supported operations:
x-traitTag: true
description: |
@ -317,84 +220,47 @@ tags:
| **Read** | `GET` | Retrieve a resource or list resources. |
| **Update** | `PUT`, `PATCH` | Replace or modify an existing resource. |
| **Delete** | `DELETE` | Remove a resource. |
System information endpoints:
x-traitTag: true
description: >
Endpoints for retrieving system-level information about an InfluxDB
instance.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Endpoints for retrieving system-level information about an InfluxDB instance. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Tasks:
x-traitTag: true
description: >
Schedule and manage Flux tasks that process and transform data on a
recurring basis.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Schedule and manage Flux tasks that process and transform data on a recurring basis. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Telegraf Plugins:
x-traitTag: true
description: >
Retrieve available Telegraf plugin configuration templates.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Retrieve available Telegraf plugin configuration templates. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Telegrafs:
x-traitTag: true
description: >
Create and manage Telegraf agent configurations that collect and write
data to InfluxDB.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Create and manage Telegraf agent configurations that collect and write data to InfluxDB. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Templates:
x-traitTag: true
description: >
Export and apply InfluxDB templates, and manage template stacks.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Export and apply InfluxDB templates, and manage template stacks. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Usage:
description: >
Retrieve usage metrics and cardinality data for an InfluxDB 3 Cloud
Serverless organization.
description: |
Retrieve usage metrics and cardinality data for an InfluxDB 3 Cloud Serverless organization.
Users:
x-traitTag: true
description: >
View specific users that are members of your organization.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
View specific users that are members of your organization. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Variables:
x-traitTag: true
description: >
Create and manage variables for use in dashboards.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Create and manage variables for use in dashboards. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Views:
x-traitTag: true
description: >
Manage cell views within dashboards.
This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is
not supported or recommended for use with InfluxDB Cloud Serverless
(powered by the InfluxDB 3 storage engine).
description: |
Manage cell views within dashboards. This is an InfluxDB Cloud (TSM) endpoint that may be accessible but is not supported or recommended for use with InfluxDB Cloud Serverless (powered by the InfluxDB 3 storage engine).
Write data:
description: >
Write time series data to InfluxDB 3 Cloud Serverless buckets using the
v2-compatible `/api/v2/write` endpoint or the v1-compatible `/write`
endpoint with line protocol.
description: |
Write time series data to InfluxDB 3 Cloud Serverless buckets using the v2-compatible `/api/v2/write` endpoint or the v1-compatible `/write` endpoint with line protocol.
externalDocs:
description: Write data
url: /influxdb3/cloud-serverless/write-data/
x-related:
- title: Write data
href: /influxdb3/cloud-serverless/write-data/

35
api-docs/influxdb3/clustered/management/tags.yml
View File

@ -1,8 +1,10 @@
tags:
Database tokens:
description: >
Create and manage database tokens that authorize read and write access to
InfluxDB 3 Clustered databases.
description: |
Create and manage database tokens that authorize read and write access to InfluxDB 3 Clustered databases.
externalDocs:
description: Manage database tokens
url: /influxdb3/clustered/admin/tokens/database/
x-related:
- title: Manage database tokens
href: /influxdb3/clustered/admin/tokens/database/
@ -10,30 +12,33 @@ tags:
href: /influxdb3/clustered/admin/tokens/database/delete/
- title: Authenticate Telegraf using tokens in your OS secret store
href: https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os
Databases:
description: >
Create and manage databases in an InfluxDB 3 Clustered cluster, including
setting retention periods and custom partition templates.
description: |
Create and manage databases in an InfluxDB 3 Clustered cluster, including setting retention periods and custom partition templates.
externalDocs:
description: Manage databases
url: /influxdb3/clustered/admin/databases/
x-related:
- title: Manage databases
href: /influxdb3/clustered/admin/databases/
- title: Custom partitions
href: /influxdb3/clustered/admin/custom-partitions/
Quick start:
x-traitTag: true
description: >
Get started creating a database, issuing tokens, and writing data with
the InfluxDB 3 Clustered Management API.
description: |
Get started creating a database, issuing tokens, and writing data with the InfluxDB 3 Clustered Management API.
externalDocs:
description: Get started with Clustered
url: /influxdb3/clustered/get-started/
x-related:
- title: Get started with Clustered
href: /influxdb3/clustered/get-started/
Tables:
description: >
Manage tables in an InfluxDB 3 Clustered database, including creating
tables with custom column schemas.
description: |
Manage tables in an InfluxDB 3 Clustered database, including creating tables with custom column schemas.
externalDocs:
description: Manage tables
url: /influxdb3/clustered/admin/tables/
x-related:
- title: Manage tables
href: /influxdb3/clustered/admin/tables/

60
api-docs/influxdb3/clustered/tags.yml
View File

@ -26,6 +26,9 @@ tags:
### InfluxDB v1 compatibility
The HTTP API [`/write` endpoint](#operation/PostLegacyWrite) and [`/query` endpoint](#operation/GetLegacyQuery) work with InfluxDB 1.x username/password [authentication schemes](#section/Authentication/) and existing InfluxDB 1.x tools and code.
externalDocs:
description: Get started querying InfluxDB
url: /influxdb3/clustered/get-started/query/
x-related:
- title: Get started querying InfluxDB
href: /influxdb3/clustered/get-started/query/
@ -35,7 +38,6 @@ tags:
href: /influxdb3/clustered/guides/api-compatibility/v2/
- title: Use the v1 HTTP API with Clustered
href: /influxdb3/clustered/guides/api-compatibility/v1/
Authentication:
x-traitTag: true
description: |
@ -46,62 +48,50 @@ tags:
- [Basic authentication](#section/Authentication/BasicAuthentication)
- [Querystring authentication](#section/Authentication/QuerystringAuthentication)
<!-- ReDoc-Inject: <security-definitions> -->
Common parameters:
x-traitTag: true
description: >
Common query parameters used by InfluxDB 3 Clustered API endpoints,
including the required `database` or `db` parameter.
description: |
Common query parameters used by InfluxDB 3 Clustered API endpoints, including the required `database` or `db` parameter.
Headers:
x-traitTag: true
description: >
Standard HTTP request headers used by InfluxDB 3 Clustered API endpoints,
including `Accept`, `Authorization`, `Content-Length`, and `Content-Type`.
description: |
Standard HTTP request headers used by InfluxDB 3 Clustered API endpoints, including `Accept`, `Authorization`, `Content-Length`, and `Content-Type`.
Ping:
description: >
description: |
Check the availability of an InfluxDB 3 Clustered instance.
Query data:
description: >
Query data stored in InfluxDB 3 Clustered using InfluxQL via the
v1-compatible `/query` endpoint. Use Flight+gRPC for SQL or InfluxQL
queries with Arrow format output.
description: |
Query data stored in InfluxDB 3 Clustered using InfluxQL via the v1-compatible `/query` endpoint. Use Flight+gRPC for SQL or InfluxQL queries with Arrow format output.
externalDocs:
description: Get started querying InfluxDB
url: /influxdb3/clustered/get-started/query/
x-related:
- title: Get started querying InfluxDB
href: /influxdb3/clustered/get-started/query/
- title: Execute queries
href: /influxdb3/clustered/query-data/execute-queries/
Quick start:
x-traitTag: true
description: >
Get started authenticating, creating a database, and writing and querying
data with the InfluxDB 3 Clustered API.
description: |
Get started authenticating, creating a database, and writing and querying data with the InfluxDB 3 Clustered API.
Response codes:
x-traitTag: true
description: >
Standard HTTP status codes returned by InfluxDB 3 Clustered API endpoints
and their meanings.
description: |
Standard HTTP status codes returned by InfluxDB 3 Clustered API endpoints and their meanings.
System information endpoints:
x-traitTag: true
description: >
Endpoints for retrieving system-level information about the InfluxDB 3
Clustered instance.
description: |
Endpoints for retrieving system-level information about the InfluxDB 3 Clustered instance.
Usage:
x-traitTag: true
description: >
description: |
Retrieve usage metrics for an InfluxDB 3 Clustered instance.
Write data:
description: >
Write time series data to InfluxDB 3 Clustered databases using the
v2-compatible `/api/v2/write` endpoint or the v1-compatible `/write`
endpoint with line protocol.
description: |
Write time series data to InfluxDB 3 Clustered databases using the v2-compatible `/api/v2/write` endpoint or the v1-compatible `/write` endpoint with line protocol.
externalDocs:
description: Write data
url: /influxdb3/clustered/write-data/
x-related:
- title: Write data
href: /influxdb3/clustered/write-data/

52
api-docs/influxdb3/core/tags.yml
View File

@ -9,7 +9,6 @@ tags:
- [Basic authentication](#section/Authentication/BasicAuthentication)
- [Querystring authentication](#section/Authentication/QuerystringAuthentication)
<!-- ReDoc-Inject: <security-definitions> -->
Cache distinct values:
description: |
The Distinct Value Cache (DVC) lets you cache distinct
@ -21,10 +20,12 @@ tags:
values to cache, the maximum number of distinct value combinations to cache, and
the maximum age of cached values. A DVC is associated with a table, which can
have multiple DVCs.
externalDocs:
description: Manage the Distinct Value Cache
url: /influxdb3/core/admin/distinct-value-cache/
x-related:
- title: Manage the Distinct Value Cache
href: /influxdb3/core/admin/distinct-value-cache/
Cache last value:
description: |
The Last Value Cache (LVC) lets you cache the most recent
@ -37,10 +38,12 @@ tags:
what fields to cache, what tags to use to identify each series, and the
number of values to cache for each unique series.
An LVC is associated with a table, which can have multiple LVCs.
externalDocs:
description: Manage the Last Value Cache
url: /influxdb3/core/admin/last-value-cache/
x-related:
- title: Manage the Last Value Cache
href: /influxdb3/core/admin/last-value-cache/
Migrate from InfluxDB v1 or v2:
x-traitTag: true
description: |
@ -55,14 +58,15 @@ tags:
- [Migrate from InfluxDB v2](/influxdb3/core/guides/migrate/influxdb-2x/) - For users migrating from InfluxDB 2.x or Cloud
- [Use compatibility APIs to write data](/influxdb3/core/write-data/http-api/compatibility-apis/) - v1 and v2 write endpoints
- [Use the v1 HTTP query API](/influxdb3/core/query-data/execute-queries/influxdb-v1-api/) - InfluxQL queries via HTTP
Database:
description: >
description: |
Create, list, and delete databases in InfluxDB 3 Core.
externalDocs:
description: Manage databases
url: /influxdb3/core/admin/databases/
x-related:
- title: Manage databases
href: /influxdb3/core/admin/databases/
Headers and parameters:
x-traitTag: true
description: |
@ -89,24 +93,27 @@ tags:
| `Authorization` | string | The [authorization scheme and credential](/influxdb/version/api/authentication/). |
| `Content-Length` | integer | The size of the entity-body, in bytes. |
| `Content-Type` | string | The format of the data in the request body. |
Processing engine:
description: |
Manage Processing engine triggers, test plugins, and send requests to trigger On Request plugins.
InfluxDB 3 Core provides the InfluxDB 3 processing engine, an embedded Python VM that can dynamically load and trigger Python plugins in response to events in your database.
Use Processing engine plugins and triggers to run code and perform tasks for different database events.
externalDocs:
description: Processing engine and Python plugins
url: /influxdb3/core/processing-engine/
x-related:
- title: Processing engine and Python plugins
href: /influxdb3/core/processing-engine/
Query data:
description: >
description: |
Query data stored in InfluxDB 3 Core using SQL or InfluxQL.
externalDocs:
description: Query data
url: /influxdb3/core/query-data/
x-related:
- title: Query data
href: /influxdb3/core/query-data/
Quick start:
x-traitTag: true
description: |
@ -152,27 +159,27 @@ tags:
```
For more information about using InfluxDB 3 Core, see the [Get started](/influxdb3/core/get-started/) guide.
Server information:
description: >
Retrieve server metrics, health status, and version information for
InfluxDB 3 Core.
description: |
Retrieve server metrics, health status, and version information for InfluxDB 3 Core.
Table:
description: >
description: |
Manage table schemas in an InfluxDB 3 Core database.
externalDocs:
description: Manage tables
url: /influxdb3/core/admin/tables/
x-related:
- title: Manage tables
href: /influxdb3/core/admin/tables/
Auth token:
description: >
Create and manage tokens used for authenticating and authorizing access
to InfluxDB 3 Core resources.
description: |
Create and manage tokens used for authenticating and authorizing access to InfluxDB 3 Core resources.
externalDocs:
description: Manage tokens
url: /influxdb3/core/admin/tokens/
x-related:
- title: Manage tokens
href: /influxdb3/core/admin/tokens/
Write data:
description: |
Write data to InfluxDB 3 Core using line protocol format.
@ -194,6 +201,9 @@ tags:
| **Default** | Nanosecond | Nanosecond | **Auto** (guessed) |
All timestamps are stored internally as nanoseconds.
externalDocs:
description: Write data using HTTP APIs
url: /influxdb3/core/write-data/http-api/
x-related:
- title: Write data using HTTP APIs
href: /influxdb3/core/write-data/http-api/

47
api-docs/influxdb3/enterprise/tags.yml
View File

@ -9,7 +9,6 @@ tags:
- [Basic authentication](#section/Authentication/BasicAuthentication)
- [Querystring authentication](#section/Authentication/QuerystringAuthentication)
<!-- ReDoc-Inject: <security-definitions> -->
Cache data:
description: |
Manage the in-memory cache.
@ -38,19 +37,23 @@ tags:
what fields to cache, what tags to use to identify each series, and the
number of values to cache for each unique series.
An LVC is associated with a table, which can have multiple LVCs.
externalDocs:
description: Manage the Distinct Value Cache
url: /influxdb3/enterprise/admin/distinct-value-cache/
x-related:
- title: Manage the Distinct Value Cache
href: /influxdb3/enterprise/admin/distinct-value-cache/
- title: Manage the Last Value Cache
href: /influxdb3/enterprise/admin/last-value-cache/
Database:
description: >
description: |
Create, list, and delete databases in InfluxDB 3 Enterprise.
externalDocs:
description: Manage databases
url: /influxdb3/enterprise/admin/databases/
x-related:
- title: Manage databases
href: /influxdb3/enterprise/admin/databases/
Headers and parameters:
x-traitTag: true
description: |
@ -77,24 +80,27 @@ tags:
| `Authorization` | string | The authorization scheme and credential. |
| `Content-Length` | integer | The size of the entity-body, in bytes. |
| `Content-Type` | string | The format of the data in the request body. |
Processing engine:
description: |
Manage Processing engine triggers, test plugins, and send requests to trigger On Request plugins.
InfluxDB 3 Enterprise provides the InfluxDB 3 processing engine, an embedded Python VM that can dynamically load and trigger Python plugins in response to events in your database.
Use Processing engine plugins and triggers to run code and perform tasks for different database events.
externalDocs:
description: Processing engine and Python plugins
url: /influxdb3/enterprise/processing-engine/
x-related:
- title: Processing engine and Python plugins
href: /influxdb3/enterprise/processing-engine/
Query data:
description: >
description: |
Query data stored in InfluxDB 3 Enterprise using SQL or InfluxQL.
externalDocs:
description: Query data
url: /influxdb3/enterprise/query-data/
x-related:
- title: Query data
href: /influxdb3/enterprise/query-data/
Quick start:
x-traitTag: true
description: |
@ -140,27 +146,27 @@ tags:
```
For more information, see the [Get started](/influxdb3/enterprise/get-started/) guide.
Server information:
description: >
Retrieve server metrics, health status, and version information for
InfluxDB 3 Enterprise.
description: |
Retrieve server metrics, health status, and version information for InfluxDB 3 Enterprise.
Table:
description: >
description: |
Manage table schemas in an InfluxDB 3 Enterprise database.
externalDocs:
description: Manage tables
url: /influxdb3/enterprise/admin/tables/
x-related:
- title: Manage tables
href: /influxdb3/enterprise/admin/tables/
Token:
description: >
Create and manage tokens used for authenticating and authorizing access
to InfluxDB 3 Enterprise resources.
description: |
Create and manage tokens used for authenticating and authorizing access to InfluxDB 3 Enterprise resources.
externalDocs:
description: Manage tokens
url: /influxdb3/enterprise/admin/tokens/
x-related:
- title: Manage tokens
href: /influxdb3/enterprise/admin/tokens/
Write data:
description: |
Write data to InfluxDB 3 Enterprise using line protocol format.
@ -182,6 +188,9 @@ tags:
| **Default** | Nanosecond | Nanosecond | **Auto** (guessed) |
All timestamps are stored internally as nanoseconds.
externalDocs:
description: Write data using HTTP APIs
url: /influxdb3/enterprise/write-data/http-api/
x-related:
- title: Write data using HTTP APIs
href: /influxdb3/enterprise/write-data/http-api/

1355
api-docs/scripts/dist/generate-openapi-articles.js vendored
View File

File diff suppressed because it is too large Load Diff

12
api-docs/scripts/dist/openapi-paths-to-hugo-data/index.js vendored
View File

@ -731,9 +731,12 @@ function createArticleDataForTag(openapi, operations, tagMeta) {
if (tagMeta?.['x-influxdatadocs-related']) {
tagMeta['x-influxdatadocs-related'].forEach(addRelated);
}
// Tag-level externalDocs (legacy single link)
// Tag-level externalDocs (standard OpenAPI field — single link)
if (tagMeta?.externalDocs?.url) {
addRelated(tagMeta.externalDocs.url);
addRelated({
title: tagMeta.externalDocs.description || tagMeta.externalDocs.url,
href: tagMeta.externalDocs.url,
});
}
// Operation-level related links
operations.forEach((op) => {
@ -744,7 +747,10 @@ function createArticleDataForTag(openapi, operations, tagMeta) {
op.related.forEach(addRelated);
}
if (op.externalDocs?.url) {
addRelated(op.externalDocs.url);
addRelated({
title: op.externalDocs.description || op.externalDocs.url,
href: op.externalDocs.url,
});
}
});
if (relatedItems.length > 0) {

42
api-docs/scripts/generate-openapi-articles.ts
View File

@ -1054,6 +1054,9 @@ const MARKDOWN_FIELDS = new Set(['description', 'summary']);
/** Link placeholder pattern */
const LINK_PATTERN = /\/influxdb\/version\//g;
/** Absolute docs site URLs → relative paths for Hugo rendering */
const DOCS_HOST_PATTERN = /https?:\/\/docs\.influxdata\.com(\/[^\s)'"]*)/g;
/** Base URL for absolutifying links in downloadable specs */
const DOCS_BASE_URL = 'https://docs.influxdata.com';
@ -1080,7 +1083,13 @@ function deriveProductPath(specPath: string): string {
/**
* Transform documentation links in OpenAPI spec markdown fields.
* Replaces `/influxdb/version/` with the actual product path.
*
* 1. Replaces `/influxdb/version/` placeholder with the actual product path.
* 2. Strips `https://docs.influxdata.com` host from absolute internal URLs,
* converting them to relative paths for Hugo rendering.
*
* Only processes `description` and `summary` fields (MARKDOWN_FIELDS).
* Non-markdown fields like `servers[].url` are preserved as-is.
*
* @param spec - Parsed OpenAPI spec object
* @param productPath - Target path (e.g., '/influxdb3/core')
@ -1090,9 +1099,15 @@ function transformDocLinks(
spec: Record<string, unknown>,
productPath: string
): Record<string, unknown> {
function transformString(value: string): string {
return value
.replace(LINK_PATTERN, `${productPath}/`)
.replace(DOCS_HOST_PATTERN, '$1');
}
function transformValue(value: unknown): unknown {
if (typeof value === 'string') {
return value.replace(LINK_PATTERN, `${productPath}/`);
return transformString(value);
}
if (Array.isArray(value)) {
return value.map(transformValue);
@ -1109,7 +1124,7 @@ function transformDocLinks(
const result: Record<string, unknown> = {};
for (const [key, value] of Object.entries(obj)) {
if (MARKDOWN_FIELDS.has(key) && typeof value === 'string') {
result[key] = value.replace(LINK_PATTERN, `${productPath}/`);
result[key] = transformString(value);
} else if (value !== null && typeof value === 'object') {
result[key] = transformValue(value);
} else {
@ -1154,6 +1169,14 @@ function absolutifyLinks(
) {
return `${baseUrl}${value}`;
}
// externalDocs.url — standard OpenAPI field
if (
key === 'url' &&
parent?.description &&
value.startsWith('/')
) {
return `${baseUrl}${value}`;
}
return value;
}
if (Array.isArray(value)) {
@ -1276,6 +1299,7 @@ function processSpecFile(
): {
staticSpecPath: string;
staticJsonSpecPath: string;
hugoSpecPath: string;
articlesPath: string;
} | null {
const yaml = require('js-yaml');
@ -1333,6 +1357,10 @@ function processSpecFile(
}
}
// Write Hugo spec (relative links) for article generation and templates
const hugoSpecPath = staticSpecPath.replace(/\.yml$/, '-hugo.yml');
fs.writeFileSync(hugoSpecPath, yaml.dump(transformedSpec));
// Absolutify links for downloadable specs (relative paths → full URLs)
const downloadSpec = absolutifyLinks(transformedSpec, DOCS_BASE_URL);
@ -1346,7 +1374,7 @@ function processSpecFile(
);
console.log(`✓ Generated JSON spec at ${staticJsonSpecPath}`);
return { staticSpecPath, staticJsonSpecPath, articlesPath };
return { staticSpecPath, staticJsonSpecPath, hugoSpecPath, articlesPath };
} catch (specError) {
console.warn(`⚠️ Could not process spec: ${specError}`);
return null;
@ -1444,16 +1472,16 @@ function processProduct(productKey: string, config: ProductConfig): void {
`\n📋 Generating tag-based data for ${specConfig.displayName || specSlug}...`
);
openapiPathsToHugo.generateHugoDataByTag({
specFile: result.staticSpecPath,
specFile: result.hugoSpecPath,
dataOutPath: staticTagsPath,
articleOutPath: result.articlesPath,
includePaths: true,
});
// Generate path-specific specs
// Generate path-specific specs (use Hugo spec with relative links)
const specPathsPath = path.join(staticPathsPath, specSlug);
const pathSpecFiles = openapiPathsToHugo.generatePathSpecificSpecs(
result.staticSpecPath,
result.hugoSpecPath,
specPathsPath
);

12
api-docs/scripts/openapi-paths-to-hugo-data/index.ts
View File

@ -1159,9 +1159,12 @@ function createArticleDataForTag(
(tagMeta['x-influxdatadocs-related'] as string[]).forEach(addRelated);
}
// Tag-level externalDocs (legacy single link)
// Tag-level externalDocs (standard OpenAPI field — single link)
if (tagMeta?.externalDocs?.url) {
addRelated(tagMeta.externalDocs.url);
addRelated({
title: tagMeta.externalDocs.description || tagMeta.externalDocs.url,
href: tagMeta.externalDocs.url,
});
}
// Operation-level related links
@ -1173,7 +1176,10 @@ function createArticleDataForTag(
op.related.forEach(addRelated);
}
if (op.externalDocs?.url) {
addRelated(op.externalDocs.url);
addRelated({
title: op.externalDocs.description || op.externalDocs.url,
href: op.externalDocs.url,
});
}
});