docs(readme): endpoint table reflects the full surface#95
Merged
Conversation
Three gaps in the README endpoint table after the audit cycle: 1. **`GET /metrics`** wasn't listed at all. Added with a note on the optional `METRICS_BEARER_TOKEN` gate. 2. **The 13 `POST /v1/<entity>/bulk` endpoints** were invisible to anyone reading just the README. Added one row covering the pattern (500-entry cap, transactional all-or-nothing) — the per-entity body shape is in the OpenAPI spec / Swagger UI. 3. **Cross-cutting headers** had no documentation: - `Idempotency-Key` (24h dedup window on POSTs) - `Link` (RFC 5988 pagination) - `X-Request-Id` (trace correlator) - `RateLimit-*` (RFC standard rate-limit signals) New section right after the table describes each. 4. **`migration` field on `/healthz`** body is mentioned in the updated /healthz row. No code changes; documentation only. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Summary
GET /metricsadded to the endpoint table.POST /v1/<entity>/bulkendpoints summarized in one row./healthzrow updated to mention the newmigrationfield.Test plan
This code proudly made in Nebraska. GO BIG RED! 🌽 https://xkcd.com/2347/