docs: Add Accept header requirement, TTY note, and startup 503 clarification for containers#2412
Open
jacinpoz wants to merge 1 commit into
Open
docs: Add Accept header requirement, TTY note, and startup 503 clarification for containers#2412jacinpoz wants to merge 1 commit into
jacinpoz wants to merge 1 commit into
Conversation
- Add info block: Genesis router requires Accept: application/json on all HTTP requests; requests without it return 406 - Add info block: -it (TTY) flag is required for Genesis startup script - Clarify that /health/status returning 503 during startup is normal - Fix healthchecks section heading capitalisation - Clarify health endpoint response body is a JSON array Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
jacinpoz
requested review from
jay-taylerson,
kievitsp,
matteematt,
patrickoneill-genesis and
skawian
as code owners
harryjhornby
approved these changes
May 12, 2026
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
2 participants
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.
ATTENTION! YOU SHOULD BRANCH FROM PREPROD WHEN YOU UPDATE
Thank you for contributing to the documentation.
Have you done a trial build to check all new or changed links?
Yes — the changes only add :::info admonition blocks and plain text; no new links were introduced.
Is there anything else you would like us to know?
These changes come from hands-on findings while smoke-testing the Genesis Docker image end-to-end with DPL:
Accept: application/jsonrequired on all router requests — the Genesis router returns 406 without this header. Most HTTP clients (curl) send a compatible Accept header by default, but code-level clients (Java HttpURLConnection, etc.) do not. Added an info block in the Running section with a curl example.-it(TTY) is required — the Genesis startup script behaves incorrectly without a pseudo-TTY. Clarified that-itis not optional, with notes for Docker Compose (tty: true) and Kubernetes (use health probes instead)./health/statusreturns 503 while processes are initialising. Added a note to prevent users treating this as a hard failure, with guidance oninitialDelaySecondsor a startup probe in Kubernetes.Please check the internal contributions guide for the most important guidance on updating the documentation.