docs(readme): add the missing /v1/whoami row to the endpoint table#164
Merged
Conversation
The Endpoints table in README.md listed every /v1/* domain
endpoint plus /healthz, /metrics, /docs, and /openapi.json, but
missed `/v1/whoami` — the identity-probe endpoint that returns
`{authenticated, isMaster, companyId}` for the calling authKey.
The route exists in `app/routers/router.js` (line 82) and in the
OpenAPI spec (`app/config/openapi.js:388`), so SDK clients reading
the spec found it; readers of the README didn't.
Add a one-line entry between `/openapi.json` and `/v1/customer/:id`
that calls out the distinct auth contract — header MUST be
present (403 if missing) but the key need NOT resolve (200 with
`authenticated: false` for unknown keys). That's the discriminator
that makes whoami useful as a wiring-check vs. inferring from a
domain endpoint's 4xx.
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.
Closes #163.
Summary
README's Endpoints table covered every
/v1/*and meta route except/v1/whoami. The endpoint exists inapp/routers/router.js:82and is documented in OpenAPI, but readers of the README didn't see it. Whoami's distinct auth contract — header MUST be present, but the key need NOT resolve — is what makes it useful as a SDK wiring-check, so the row explicitly calls that out.Test plan
npm run lint— cleannpm test— 614 passed, 15 skipped (unchanged; doc-only)Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/