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

fix(api-docs): add x-traitTag support to post-processor and tags.yml 

Add x-traitTag to TagConfig interface so the post-processor propagates
it from tags.yml into specs. Mark all supplementary documentation tags
(Authentication, Quick start, Headers, Usage, etc.) with x-traitTag: true
so Redoc renders them as documentation sections with descriptions rather
than empty operation groups. Also exclude root .config.yml from the
Redoc HTML generation find command.
pull/6942/head
Jason Stirnaman 2026-03-11 17:46:32 -05:00
parent 577494616e
commit 62bd023616
15 changed files with 58 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -27,8 +27,8 @@ tags:
authentication scheme with v1 credentials.
Authentication:
x-traitTag: true
description: >
Authenticate API requests to InfluxDB Enterprise v1 using basic
authentication, query string credentials, or the v2-compatible token
scheme.
# x-traitTag: true — informational tag, no operations

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

@ -1,9 +1,9 @@
tags:
Authentication:
x-traitTag: true
description: >
Authenticate API requests to InfluxDB Cloud using API tokens with token,
basic, or querystring authentication schemes.
# x-traitTag: true — informational tag, no operations
Authorizations (API tokens):
description: >
@ -36,10 +36,10 @@ tags:
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`.
# x-traitTag: true — informational tag, no operations
Config:
description: >
@ -63,10 +63,10 @@ tags:
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`.
# x-traitTag: true — informational tag, no operations
Invokable Scripts:
description: >
@ -115,10 +115,10 @@ tags:
href: /influxdb/cloud/organizations/
Pagination:
x-traitTag: true
description: >
Query parameters for paginating results from list operations in the
InfluxDB Cloud API.
# x-traitTag: true — informational tag, no operations
Ping:
description: >
@ -133,10 +133,10 @@ tags:
href: /influxdb/cloud/query-data/
Quick start:
x-traitTag: true
description: >
Get started authenticating, writing, and querying data with the InfluxDB
Cloud API.
# x-traitTag: true — informational tag, no operations
Resources:
description: >
@ -144,10 +144,10 @@ tags:
Cloud API.
Response codes:
x-traitTag: true
description: >
Standard HTTP status codes returned by InfluxDB Cloud API endpoints and
their meanings.
# x-traitTag: true — informational tag, no operations
Routes:
description: >
@ -182,10 +182,10 @@ tags:
End a user session by signing out.
Supported operations:
x-traitTag: true
description: >
Overview of the common CRUD operations supported by the InfluxDB Cloud
API.
# x-traitTag: true — informational tag, no operations
System information endpoints:
description: >

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

@ -26,7 +26,7 @@ tags:
scheme with v1 credentials.
Authentication:
x-traitTag: true
description: >
Authenticate API requests to InfluxDB v1 using basic authentication,
query string credentials, or the v2-compatible token scheme.
# x-traitTag: true — informational tag, no operations

1
api-docs/influxdb/v2/influxdb-oss-v2-openapi.yaml
View File

@ -48,6 +48,7 @@ tags:
x-traitTag: true
- name: Compatibility endpoints
description: InfluxDB v1-compatible API endpoints for backward compatibility with InfluxDB 1.x clients, tools, and integrations such as Grafana and Telegraf.
x-traitTag: true
- name: Config
description: Retrieve configuration information for an InfluxDB OSS v2 instance.
- name: Dashboards

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

@ -1,9 +1,9 @@
tags:
Authentication:
x-traitTag: true
description: >
Authenticate API requests to InfluxDB OSS v2 using API tokens with
token, basic, or querystring authentication schemes.
# x-traitTag: true — informational tag, no operations
Authorizations (API tokens):
description: >
@ -40,12 +40,13 @@ tags:
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`.
# x-traitTag: true — informational tag, no operations
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
@ -78,10 +79,10 @@ tags:
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`.
# x-traitTag: true — informational tag, no operations
Health:
description: >
@ -116,10 +117,10 @@ tags:
href: /influxdb/v2/organizations/
Pagination:
x-traitTag: true
description: >
Query parameters for paginating results from list operations in the
InfluxDB OSS v2 API.
# x-traitTag: true — informational tag, no operations
Ping:
description: >
@ -139,10 +140,10 @@ tags:
`/query` endpoint.
Quick start:
x-traitTag: true
description: >
Get started authenticating, writing, and querying data with the InfluxDB
OSS v2 API.
# x-traitTag: true — informational tag, no operations
Ready:
description: >
@ -164,10 +165,10 @@ tags:
OSS v2 API.
Response codes:
x-traitTag: true
description: >
Standard HTTP status codes returned by InfluxDB OSS v2 API endpoints and
their meanings.
# x-traitTag: true — informational tag, no operations
Restore:
description: >
@ -219,10 +220,10 @@ tags:
Manage data sources configured in InfluxDB OSS v2.
Supported operations:
x-traitTag: true
description: >
Overview of the common CRUD operations supported by the InfluxDB OSS v2
API.
# x-traitTag: true — informational tag, no operations
System information endpoints:
description: >

2
api-docs/influxdb3/cloud-dedicated/influxdb3-cloud-dedicated-openapi.yaml
View File

@ -65,8 +65,10 @@ tags:
x-traitTag: true
- name: System information endpoints
description: Endpoints for retrieving system-level information about the InfluxDB 3 Cloud Dedicated instance.
x-traitTag: true
- name: Usage
description: Retrieve usage metrics for an InfluxDB 3 Cloud Dedicated instance.
x-traitTag: true
- 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.
name: Write data
x-related:

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

@ -24,6 +24,7 @@ tags:
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.
@ -32,7 +33,6 @@ tags:
href: /influxdb3/cloud-dedicated/get-started/
- title: Set up your cluster
href: /influxdb3/cloud-dedicated/get-started/setup/
# x-traitTag: true — informational tag, no operations
Tables:
description: >

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

@ -1,28 +1,28 @@
tags:
API compatibility:
x-traitTag: true
description: >
Overview of the InfluxDB v1 and v2 compatible write and query endpoints
available in InfluxDB 3 Cloud Dedicated.
# x-traitTag: true — informational tag, no operations
Authentication:
x-traitTag: true
description: >
Authenticate API requests to InfluxDB 3 Cloud Dedicated using database
tokens with bearer, token, basic, or querystring authentication schemes.
# x-traitTag: true — informational tag, no operations
Common parameters:
x-traitTag: true
description: >
Common query parameters used by InfluxDB 3 Cloud Dedicated API endpoints,
including the required `database` or `db` parameter.
# x-traitTag: true — informational tag, no operations
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`.
# x-traitTag: true — informational tag, no operations
Ping:
description: >
@ -40,23 +40,25 @@ tags:
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.
# x-traitTag: true — informational tag, no operations
Response codes:
x-traitTag: true
description: >
Standard HTTP status codes returned by InfluxDB 3 Cloud Dedicated API
endpoints and their meanings.
# x-traitTag: true — informational tag, no operations
System information endpoints:
x-traitTag: true
description: >
Endpoints for retrieving system-level information about the InfluxDB 3
Cloud Dedicated instance.
Usage:
x-traitTag: true
description: >
Retrieve usage metrics for an InfluxDB 3 Cloud Dedicated instance.

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

@ -1,15 +1,15 @@
tags:
API compatibility:
x-traitTag: true
description: >
Overview of the InfluxDB v1 and v2 compatible write and query endpoints
available in InfluxDB 3 Cloud Serverless.
# x-traitTag: true — informational tag, no operations
Authentication:
x-traitTag: true
description: >
Authenticate API requests to InfluxDB 3 Cloud Serverless using API tokens
with token, basic, or querystring authentication schemes.
# x-traitTag: true — informational tag, no operations
Authorizations (API tokens):
description: >
@ -42,10 +42,10 @@ tags:
notification statuses in InfluxDB 3 Cloud Serverless.
Common parameters:
x-traitTag: true
description: >
Common query parameters used by InfluxDB 3 Cloud Serverless API
endpoints, including `bucket`, `bucketID`, `org`, and `orgID`.
# x-traitTag: true — informational tag, no operations
Config:
description: >
@ -70,11 +70,11 @@ tags:
specifying a time range and optional predicate.
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`.
# x-traitTag: true — informational tag, no operations
Invokable Scripts:
description: >
@ -116,10 +116,10 @@ tags:
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.
# x-traitTag: true — informational tag, no operations
Ping:
description: >
@ -137,10 +137,10 @@ tags:
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.
# x-traitTag: true — informational tag, no operations
Resources:
description: >
@ -148,10 +148,10 @@ tags:
Cloud Serverless API.
Response codes:
x-traitTag: true
description: >
Standard HTTP status codes returned by InfluxDB 3 Cloud Serverless API
endpoints and their meanings.
# x-traitTag: true — informational tag, no operations
Routes:
description: >
@ -186,10 +186,10 @@ tags:
End a user session by signing out.
Supported operations:
x-traitTag: true
description: >
Overview of the common CRUD operations supported by the InfluxDB 3 Cloud
Serverless API.
# x-traitTag: true — informational tag, no operations
System information endpoints:
description: >

2
api-docs/influxdb3/clustered/influxdb3-clustered-openapi.yaml
View File

@ -65,8 +65,10 @@ tags:
x-traitTag: true
- name: System information endpoints
description: Endpoints for retrieving system-level information about the InfluxDB 3 Clustered instance.
x-traitTag: true
- name: Usage
description: Retrieve usage metrics for an InfluxDB 3 Clustered instance.
x-traitTag: true
- 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.
name: Write data
x-related:

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

@ -22,13 +22,13 @@ tags:
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.
x-related:
- title: Get started with Clustered
href: /influxdb3/clustered/get-started/
# x-traitTag: true — informational tag, no operations
Tables:
description: >

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

@ -1,27 +1,27 @@
tags:
API compatibility:
x-traitTag: true
description: >
Overview of the InfluxDB v1 and v2 compatible write and query endpoints
available in InfluxDB 3 Clustered.
# x-traitTag: true — informational tag, no operations
Authentication:
x-traitTag: true
description: >
Authenticate API requests to InfluxDB 3 Clustered using database tokens
with bearer, token, basic, or querystring authentication schemes.
# x-traitTag: true — informational tag, no operations
Common parameters:
x-traitTag: true
description: >
Common query parameters used by InfluxDB 3 Clustered API endpoints,
including the required `database` or `db` parameter.
# x-traitTag: true — informational tag, no operations
Headers:
x-traitTag: true
description: >
Standard HTTP request headers used by InfluxDB 3 Clustered API endpoints,
including `Accept`, `Authorization`, `Content-Length`, and `Content-Type`.
# x-traitTag: true — informational tag, no operations
Ping:
description: >
@ -39,23 +39,25 @@ tags:
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.
# x-traitTag: true — informational tag, no operations
Response codes:
x-traitTag: true
description: >
Standard HTTP status codes returned by InfluxDB 3 Clustered API endpoints
and their meanings.
# x-traitTag: true — informational tag, no operations
System information endpoints:
x-traitTag: true
description: >
Endpoints for retrieving system-level information about the InfluxDB 3
Clustered instance.
Usage:
x-traitTag: true
description: >
Retrieve usage metrics for an InfluxDB 3 Clustered instance.

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

@ -1,10 +1,10 @@
tags:
Authentication:
x-traitTag: true
description: >
Authenticate API requests using bearer tokens, token scheme, basic
authentication, or querystring credentials.
See the Security Schemes section for details on each method.
# x-traitTag: true — informational tag, no operations
Cache distinct values:
description: >
@ -25,10 +25,10 @@ tags:
href: /influxdb3/core/admin/last-value-cache/
Migrate from InfluxDB v1 or v2:
x-traitTag: true
description: >
Reference information for migrating existing InfluxDB v1 or v2 workloads
to InfluxDB 3 Core using compatibility endpoints.
# x-traitTag: true — informational tag, no operations
Database:
description: >
@ -38,10 +38,10 @@ tags:
href: /influxdb3/core/admin/databases/
Headers and parameters:
x-traitTag: true
description: >
Common HTTP request headers and query parameters used by InfluxDB 3 Core
API endpoints.
# x-traitTag: true — informational tag, no operations
Processing engine:
description: >
@ -60,10 +60,10 @@ tags:
href: /influxdb3/core/query-data/
Quick start:
x-traitTag: true
description: >
Get started authenticating, writing, and querying data with the
InfluxDB 3 Core API.
# x-traitTag: true — informational tag, no operations
Server information:
description: >

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

@ -1,10 +1,10 @@
tags:
Authentication:
x-traitTag: true
description: >
Authenticate API requests using bearer tokens, token scheme, basic
authentication, or querystring credentials.
See the Security Schemes section for details on each method.
# x-traitTag: true — informational tag, no operations
Cache data:
description: >
@ -25,10 +25,10 @@ tags:
href: /influxdb3/enterprise/admin/databases/
Headers and parameters:
x-traitTag: true
description: >
Common HTTP request headers and query parameters used by InfluxDB 3
Enterprise API endpoints.
# x-traitTag: true — informational tag, no operations
Processing engine:
description: >
@ -47,10 +47,10 @@ tags:
href: /influxdb3/enterprise/query-data/
Quick start:
x-traitTag: true
description: >
Get started authenticating, writing, and querying data with the
InfluxDB 3 Enterprise API.
# x-traitTag: true — informational tag, no operations
Server information:
description: >

3
api-docs/scripts/post-process-specs.ts
View File

@ -34,6 +34,7 @@ interface RelatedLink {
interface TagConfig {
rename?: string;
description?: string;
'x-traitTag'?: boolean;
'x-related'?: RelatedLink[];
}
@ -322,6 +323,8 @@ function applyTagConfig(
if (cfg.description !== undefined)
tagObj.description = cfg.description.trim();
if (cfg['x-traitTag'] !== undefined)
tagObj['x-traitTag'] = cfg['x-traitTag'];
if (cfg['x-related'] !== undefined) tagObj['x-related'] = cfg['x-related'];
}