From db777aa6a22eeb2771a8677009851e6d76b65143 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 1 Jun 2026 15:11:22 -0500 Subject: [PATCH] feat(v2): document /ready readiness gates in OpenAPI spec Add a 503 response to /ready and extend the Ready schema with the `starting` status value and a failing-only `checks` array (reusing HealthCheck), reflecting the readiness-gate behavior introduced in influxdata/influxdb#27370. Do not merge until the 2.x release that ships #27370. The same change should also land upstream in influxdata/openapi or it will be overwritten on the next getswagger.sh regen. --- .../influxdb/v2/influxdb-oss-v2-openapi.yaml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/api-docs/influxdb/v2/influxdb-oss-v2-openapi.yaml b/api-docs/influxdb/v2/influxdb-oss-v2-openapi.yaml index 9f3a9baf43..e38bf7ef69 100644 --- a/api-docs/influxdb/v2/influxdb-oss-v2-openapi.yaml +++ b/api-docs/influxdb/v2/influxdb-oss-v2-openapi.yaml @@ -7892,6 +7892,15 @@ paths: schema: $ref: '#/components/schemas/Ready' description: The instance is ready + '503': + content: + application/json: + schema: + $ref: '#/components/schemas/Ready' + description: | + The instance is still starting and isn't ready yet. + One or more readiness checks haven't passed. + The `checks` property of the response body contains only the failing checks. default: $ref: '#/components/responses/GeneralServerError' description: Unexpected error @@ -16885,6 +16894,13 @@ components: type: object Ready: properties: + checks: + description: | + Readiness checks that haven't passed yet. + Present only in a `503` response and contains only the failing checks. + items: + $ref: '#/components/schemas/HealthCheck' + type: array started: example: '2019-03-13T10:09:33.891196-04:00' format: date-time @@ -16892,6 +16908,7 @@ components: status: enum: - ready + - starting type: string up: example: 14m45.911966424s