diff --git a/api-docs/enterprise_influxdb/v1/tags.yml b/api-docs/enterprise_influxdb/v1/tags.yml index 1af098039..ed992e88f 100644 --- a/api-docs/enterprise_influxdb/v1/tags.yml +++ b/api-docs/enterprise_influxdb/v1/tags.yml @@ -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 diff --git a/api-docs/influxdb/cloud/tags.yml b/api-docs/influxdb/cloud/tags.yml index ccf1aa6b2..95c1c4025 100644 --- a/api-docs/influxdb/cloud/tags.yml +++ b/api-docs/influxdb/cloud/tags.yml @@ -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: > diff --git a/api-docs/influxdb/v1/tags.yml b/api-docs/influxdb/v1/tags.yml index 7485e36f6..1acc39e59 100644 --- a/api-docs/influxdb/v1/tags.yml +++ b/api-docs/influxdb/v1/tags.yml @@ -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 diff --git a/api-docs/influxdb/v2/influxdb-oss-v2-openapi.yaml b/api-docs/influxdb/v2/influxdb-oss-v2-openapi.yaml index 322c55c96..63555155e 100644 --- a/api-docs/influxdb/v2/influxdb-oss-v2-openapi.yaml +++ b/api-docs/influxdb/v2/influxdb-oss-v2-openapi.yaml @@ -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 diff --git a/api-docs/influxdb/v2/tags.yml b/api-docs/influxdb/v2/tags.yml index aa3360529..8f7492a43 100644 --- a/api-docs/influxdb/v2/tags.yml +++ b/api-docs/influxdb/v2/tags.yml @@ -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: > diff --git a/api-docs/influxdb3/cloud-dedicated/influxdb3-cloud-dedicated-openapi.yaml b/api-docs/influxdb3/cloud-dedicated/influxdb3-cloud-dedicated-openapi.yaml index b67149b3d..7e26f8a4c 100644 --- a/api-docs/influxdb3/cloud-dedicated/influxdb3-cloud-dedicated-openapi.yaml +++ b/api-docs/influxdb3/cloud-dedicated/influxdb3-cloud-dedicated-openapi.yaml @@ -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: diff --git a/api-docs/influxdb3/cloud-dedicated/management/tags.yml b/api-docs/influxdb3/cloud-dedicated/management/tags.yml index 966500c73..8b72ce8ce 100644 --- a/api-docs/influxdb3/cloud-dedicated/management/tags.yml +++ b/api-docs/influxdb3/cloud-dedicated/management/tags.yml @@ -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: > diff --git a/api-docs/influxdb3/cloud-dedicated/tags.yml b/api-docs/influxdb3/cloud-dedicated/tags.yml index de1727203..e46469b51 100644 --- a/api-docs/influxdb3/cloud-dedicated/tags.yml +++ b/api-docs/influxdb3/cloud-dedicated/tags.yml @@ -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. diff --git a/api-docs/influxdb3/cloud-serverless/tags.yml b/api-docs/influxdb3/cloud-serverless/tags.yml index 185c8b9e5..2c7fa309c 100644 --- a/api-docs/influxdb3/cloud-serverless/tags.yml +++ b/api-docs/influxdb3/cloud-serverless/tags.yml @@ -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: > diff --git a/api-docs/influxdb3/clustered/influxdb3-clustered-openapi.yaml b/api-docs/influxdb3/clustered/influxdb3-clustered-openapi.yaml index b7da2862c..371f78c1b 100644 --- a/api-docs/influxdb3/clustered/influxdb3-clustered-openapi.yaml +++ b/api-docs/influxdb3/clustered/influxdb3-clustered-openapi.yaml @@ -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: diff --git a/api-docs/influxdb3/clustered/management/tags.yml b/api-docs/influxdb3/clustered/management/tags.yml index f09cd809e..8093f98f0 100644 --- a/api-docs/influxdb3/clustered/management/tags.yml +++ b/api-docs/influxdb3/clustered/management/tags.yml @@ -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: > diff --git a/api-docs/influxdb3/clustered/tags.yml b/api-docs/influxdb3/clustered/tags.yml index 0d68fd444..13a38b452 100644 --- a/api-docs/influxdb3/clustered/tags.yml +++ b/api-docs/influxdb3/clustered/tags.yml @@ -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. diff --git a/api-docs/influxdb3/core/tags.yml b/api-docs/influxdb3/core/tags.yml index a48fff391..c4c0b9033 100644 --- a/api-docs/influxdb3/core/tags.yml +++ b/api-docs/influxdb3/core/tags.yml @@ -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: > diff --git a/api-docs/influxdb3/enterprise/tags.yml b/api-docs/influxdb3/enterprise/tags.yml index b7282bcac..8c79de737 100644 --- a/api-docs/influxdb3/enterprise/tags.yml +++ b/api-docs/influxdb3/enterprise/tags.yml @@ -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: > diff --git a/api-docs/scripts/post-process-specs.ts b/api-docs/scripts/post-process-specs.ts index 3473f5eaa..29e3bffd8 100644 --- a/api-docs/scripts/post-process-specs.ts +++ b/api-docs/scripts/post-process-specs.ts @@ -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']; }