feat(v2): document /ready readiness gates in OpenAPI spec#7286
Open
jstirnaman wants to merge 2 commits into
Open
feat(v2): document /ready readiness gates in OpenAPI spec#7286jstirnaman wants to merge 2 commits into
jstirnaman wants to merge 2 commits into
Conversation
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.
Contributor
📦 PR Preview — Preview Bot
Preview pages neededThis PR changes layout/asset files but doesn't specify which pages to preview. To generate a preview, add documentation URLs to your PR description, for example: Then re-run the workflow or push a new commit. |
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Updates the InfluxDB OSS v2 OpenAPI spec to document the new
/readyreadiness-gate behavior introduced in influxdata/influxdb#27370:/ready: add a503response (instance still starting) →Readyschema.Readyschema: addstartingto thestatusenum and a failing-onlychecksarray (reusesHealthCheck)./health+HealthCheck: unchanged — already complete.Why
The published v2 API reference generates
/readyfrom this spec, and the spec currently documents only a200/"ready"response with no503, nochecks, and no gate model. #27370 changes that behavior.release:pending— #27370 is merged tomain-2.xbut unreleased (v2 docs track 2.9.1). Merging this before the 2.x release that ships #27370 would document behavior users don't have yet.Upstream follow-up
The canonical source is
influxdata/openapi. This same change should land there, or it will be overwritten on the nextgetswagger.shregen.Validation
@redocly/cli lintidentical to baseline (2 errors, 2469 warnings — all pre-existing, zero introduced).Related