Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Update /ready and /health schemas for v2.10

Open
  • Is something wrong?
#659 1 comment 0 reactions 2 assignees View on GitHub

@devanbenz is already working on this.

Since Oct 9, 2026.

  • #661 by @jstirnaman — open

Assessment

This issue has not been assessed yet.

Description

Summary

Two contract changes are needed for InfluxDB OSS v2.10 and InfluxDB Cloud 2:

  1. The /ready and /health schemas don't describe the v2.10 responses.
  2. The Cloud Routes schema is missing two keys that Cloud returns.

I tested influxdata/influxdb main-2.x at 310ee146d9 (built locally) and a production InfluxDB Cloud 2 (TSM) org on 2026-10-08.

1. /ready and /health schemas are out of date

Problem

src/common/schemas/Ready.yml and src/common/paths/ready.yml haven't changed since 2021-03.
main-2.x returns fields and states that neither contract describes.
HEALTH_READY.md in main-2.x documents the same behavior.

influxdata/docs-v2#7286 added some of these changes by editing the OSS spec in docs-v2 directly.
The next sync from this repo would overwrite them, so the change belongs here.

Verification

/ready during startup returns 503:

{"status":"starting","started":"2026-10-08T17:54:06.861243-05:00","up":"48.001208ms",
 "uptime":{"value":0.048001208,"unit":"seconds"},
 "checks":[{"name":"shards","status":"fail","message":"waiting for shard enumeration",
            "progress":{"completed":0,"total":0,"unit":"shards"}}, ...]}

/ready after startup returns 200 with status, started, up, and uptime, and no checks.

/health returns 200 with a failures object in the shards check, plus version and commit:

{"name":"influxdb","status":"pass","message":"healthy",
 "checks":[{"name":"shards","status":"pass","failures":{"count":0,"unit":"shards"}}, ...],
 "version":"dev","commit":"none"}

After a failed startup, /health returns 503 with status: fail, and the failing check's message contains the raw error.
With --startup-error-linger, both endpoints keep serving for the linger window before influxd exits.

With --health-auth-mode=required, the status code stays the same for every caller.
Only a caller with an operator token receives check messages, measure groups, version, and commit.
Every other caller receives check names and statuses only.
I tested with no token, a read-only token, an invalid token, and an operator token.

Suggested solution

Update the common /ready and /health schemas and paths to cover:

  • The 503 response on /ready, with status: starting and only the failing checks in checks.
  • uptime on /ready, as {"value": <seconds>, "unit": "seconds"}.
  • The measure-group objects on checks, such as progress and failures.
  • version and commit on /health.
  • A description note: --health-auth-mode and --hardening-enabled reduce the response body for callers without operator permissions, and never change the status code.

After the change ships, docs-v2 closes influxdata/docs-v2#7286 and picks up the change through a normal sync.

Dominant language
Shell
Stars
18
Forks
9
Avg merge
2d 18h
Merged PRs (30d)
1

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from influxdata/openapi

All issues in influxdata/openapi

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.