Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions api-docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -317,12 +317,13 @@ in each product's `api-docs/` directory.
Each product directory can contain overlay files that the `post-process-specs.ts`
script applies to the bundled spec before article generation:

| Overlay | Location | Behavior |
| --------------------- | ------------------------------- | ---------------------------------------------------------------------------------------- |
| `content/info.yml` | `{product}/content/info.yml` | Merges each field into `spec.info`, preserving fields not in the overlay |
| `content/servers.yml` | `{product}/content/servers.yml` | Replaces `spec.servers` entirely |
| `content/page.yml` | `{product}/content/page.yml` | Sets the API landing page `description` and optional `body_extra` (e.g., callout blocks) |
| `tags.yml` | Colocated with spec | Renames tags, sets descriptions and `x-related`, drops unsupported tags |
| Overlay | Location | Behavior |
| --------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `content/info.yml` | `{product}/content/info.yml` | Merges each field into `spec.info`, preserving fields not in the overlay |
| `content/servers.yml` | `{product}/content/servers.yml` | Replaces `spec.servers` entirely |
| `content/page.yml` | `{product}/content/page.yml` | Sets the API landing page `description` and optional `body_extra` (e.g., callout blocks) |
| `content/exclude.yml` | `{product}/content/exclude.yml` | Removes schema properties the product doesn't return (`schemaProperties: {Schema: [prop, ...]}`). Denylist: list only properties verified absent on a live instance |
| `tags.yml` | Colocated with spec | Renames tags, sets descriptions and `x-related`, drops unsupported tags |

For example, to customize the Info section for the Cloud Serverless API reference, edit
`influxdb3/cloud-serverless/content/info.yml`.
Expand Down Expand Up @@ -468,11 +469,12 @@ The post-processor looks for content files in two locations, in order:
For products with multiple APIs (e.g., Cloud Dedicated has both data and
management APIs), the spec-specific directory takes precedence.

| Overlay | Behavior |
| ------------- | ---------------------------------------------------------------------------------------- |
| `info.yml` | Merges each field into `spec.info`, preserving fields not in the overlay |
| `servers.yml` | Replaces `spec.servers` entirely |
| `tags.yml` | Colocated with spec (not in `content/`). Renames tags, sets descriptions and `x-related` |
| Overlay | Behavior |
| ------------- | ------------------------------------------------------------------------------------------- |
| `info.yml` | Merges each field into `spec.info`, preserving fields not in the overlay |
| `servers.yml` | Replaces `spec.servers` entirely |
| `exclude.yml` | Removes listed schema properties. To remove whole endpoints, use `drop: true` in `tags.yml` |
| `tags.yml` | Colocated with spec (not in `content/`). Renames tags, sets descriptions and `x-related` |

#### Reviewing tags across products

Expand Down
20 changes: 20 additions & 0 deletions api-docs/influxdb/cloud/content/exclude.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Schema properties that the upstream influxdata/openapi contract lists for
# InfluxDB Cloud, but that Cloud doesn't return. post-process-specs.ts removes
# them from the published spec. This is a denylist: list only properties
# verified absent on a live Cloud instance.
#
# To remove a whole endpoint, set `drop: true` on its tag in ../tags.yml.

schemaProperties:
# GET /api/v2 on Cloud 2 (verified 2026-10-08) doesn't return these keys.
# backup, restore, plugins, scrapers, and swagger arrive with
# influxdata/openapi#658; Cloud serves telegraf plugins as telegraf.plugins.
Routes:
- backup
- plugins
- restore
- scrapers
- setup
- sources
- swagger
- system
99 changes: 89 additions & 10 deletions api-docs/influxdb/cloud/influxdb-cloud-v2-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14349,14 +14349,24 @@ components:
- type
type: object
HealthCheck:
additionalProperties:
$ref: '#/components/schemas/HealthCheckMeasure'
description: |
A health check.
A check can also report measure groups, such as `progress` or `failures`.
Each key other than `name`, `status`, `message`, and `checks` whose value
is an object is a measure group.
properties:
checks:
items:
$ref: '#/components/schemas/HealthCheck'
type: array
commit:
description: Build commit. Returned only at the top level.
type: string
message:
description: |
Status detail. For a failing check, may contain the raw error text.
type: string
name:
type: string
Expand All @@ -14366,11 +14376,29 @@ components:
- fail
type: string
version:
description: Build version. Returned only at the top level.
type: string
required:
- name
- status
type: object
HealthCheckMeasure:
additionalProperties:
type: number
description: |
A measure group: one or more numeric values that share a unit.
Durations are float seconds with `unit: seconds`.
example:
completed: 94
total: 200
unit: shards
properties:
unit:
example: shards
type: string
required:
- unit
type: object
HeatmapViewProperties:
properties:
adaptiveZoomHide:
Expand Down Expand Up @@ -16282,17 +16310,29 @@ components:
type: object
Ready:
properties:
checks:
description: |
Ready gates that haven't passed.
Omitted when `status` is `ready`.
items:
$ref: '#/components/schemas/HealthCheck'
type: array
started:
example: '2019-03-13T10:09:33.891196-04:00'
format: date-time
type: string
status:
enum:
- ready
- starting
type: string
up:
example: 14m45.911966424s
type: string
uptime:
allOf:
- $ref: '#/components/schemas/HealthCheckMeasure'
description: Time since `started`, in float seconds.
type: object
RegexpLiteral:
description: Expressions begin and end with `/` and are regular expressions with syntax accepted by RE2
Expand Down Expand Up @@ -16482,12 +16522,21 @@ components:
authorizations:
format: uri
type: string
backup:
format: uri
type: string
buckets:
format: uri
type: string
checks:
format: uri
type: string
dashboards:
format: uri
type: string
delete:
format: uri
type: string
external:
properties:
statusFeed:
Expand All @@ -16497,12 +16546,24 @@ components:
flags:
format: uri
type: string
labels:
format: uri
type: string
me:
format: uri
type: string
notificationEndpoints:
format: uri
type: string
notificationRules:
format: uri
type: string
orgs:
format: uri
type: string
plugins:
format: uri
type: string
query:
properties:
analyze:
Expand All @@ -16518,6 +16579,12 @@ components:
format: uri
type: string
type: object
restore:
format: uri
type: string
scrapers:
format: uri
type: string
setup:
format: uri
type: string
Expand All @@ -16530,6 +16597,9 @@ components:
sources:
format: uri
type: string
swagger:
format: uri
type: string
system:
properties:
debug:
Expand All @@ -16541,6 +16611,9 @@ components:
metrics:
format: uri
type: string
ready:
format: uri
type: string
type: object
tasks:
format: uri
Expand Down Expand Up @@ -17871,12 +17944,15 @@ components:
properties:
defaultValue:
description: Default value that will be provided for the reference when no value is provided
nullable: true
oneOf:
- type: string
- type: integer
- type: number
- type: boolean
- nullable: true
type: string
- nullable: true
type: integer
- nullable: true
type: number
- nullable: true
type: boolean
envRefKey:
description: Key identified as environment reference and is the key identified in the template
type: string
Expand All @@ -17885,12 +17961,15 @@ components:
type: string
value:
description: Value provided to fulfill reference
nullable: true
oneOf:
- type: string
- type: integer
- type: number
- type: boolean
- nullable: true
type: string
- nullable: true
type: integer
- nullable: true
type: number
- nullable: true
type: boolean
required:
- resourceField
- envRefKey
Expand Down
11 changes: 10 additions & 1 deletion api-docs/influxdb/cloud/tags.yml
Original file line number Diff line number Diff line change
Expand Up @@ -240,9 +240,18 @@ tags:
Security and access endpoints:
description: |
Endpoints for managing authentication and access control in InfluxDB Cloud.
# GET /api/v2/setup returns {"allowed": false} on Cloud 2 (verified
# 2026-10-08), so the endpoints stay documented with this caveat.
Setup:
description: |
Configure an initial InfluxDB Cloud instance, including creating the initial user, organization, and bucket.
Check whether an InfluxDB instance allows initial setup.

InfluxDB Cloud doesn't support initial setup.
Every InfluxDB Cloud account already has a user and an organization,
so `GET /api/v2/setup` always returns `{"allowed": false}`,
and the `POST` setup endpoints don't apply to InfluxDB Cloud.
To set up an InfluxDB OSS 2.x instance, see the
[InfluxDB OSS v2 setup endpoints](/influxdb/v2/api/setup/).
Signin:
description: |
Create a user session by signing in with username and password credentials.
Expand Down
Loading
Loading