docs: clarify that bare secret/publishable auth matches only the 'default' key - #109
Merged
Conversation
…ault' key Promote the skimmable default-key footnotes in docs/auth-modes.md to prominent callouts that state explicitly that bare auth: 'secret' / 'publishable' matches ONLY the key named 'default' in the key set, with no fallback to named keys. Also name the 'default' key in the README publishable-key example comment. Docs-only; no code behaviour change. Source-of-truth logic remains keyName ?? 'default' in src/core/verify-credentials.ts.
commit: |
kallebysantos
approved these changes
Jul 27, 2026
tomaspozo
approved these changes
Jul 27, 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
4 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.
Requested by Katerina Skroumpelou, Kalleby Santos, Tomás Pozo · Slack thread
Before / After
Users keep getting tripped up by how bare
auth: 'secret'/auth: 'publishable'resolves keys.Before:
docs/auth-modes.mdwas stated as a skimmable, footnote-style line under each mode ("By default,secretmode validates against the"default"key…"), easy to miss.README.mdpublishable-key example comment said the request is validated "against a publishable key", implying any key would match.After:
secret/publishablematches only the key nameddefaultin the key set, with no fallback to named keys — so if every key in the set is named, baresecret/publishablenever matches. Each callout points tosecret:<name>/publishable:<name>for a named key andsecret:*/publishable:*to accept any key, keeping the existing cross-reference to the "Named key syntax" section.README.mdexample comment now names the'default'publishable key explicitly.How
docs/auth-modes.md: promoted the two default-key footnote lines to bold-led blockquote callouts (matching the file's existing blockquote house style — the docs do not use> [!IMPORTANT]-type admonitions).README.md: fixed the publishable-key example comment to name the'default'key.The source-of-truth logic is unchanged:
keyName ?? 'default'insrc/core/verify-credentials.ts(bare mode resolves to the literal key nameddefault; there is no fallback to named keys).Docs-only — no code behaviour change.
Generated by Claude Code