docs: add a narrative API Keys guide - #3
Closed
islandbitcoin wants to merge 1 commit into
Closed
Conversation
Adds an 'API Keys' section to the docs overview (src/index.html, mirrored to public/): what API keys are (fk_<keyId>_<secret>, hash-only storage, shown once), creating one with apiKeyCreate, authenticating via the X-API-KEY header, the deny-by-default scope table, per-key rate limits (TOO_MANY_REQUESTS + retryAfterSeconds), and listing/rotating/revoking. Matches the existing section styling (code-samples, sidebar link, notice box) and adds a scope-table style.
Contributor
Author
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
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.
Adds a hand-written API Keys section to the docs overview (
docs.flashapp.me), matching the existing landing-page style (code samples, sidebar link,.noticebox).Covers, for an integrator:
fk_<keyId>_<secret>format, hash-only storage, and the shown-once secret.apiKeyCreate(from a user session — keys can't manage keys).X-API-KEYheader (notAuthorization), with a curl example.read_user…admin,write_*impliesread_*,adminimplies all) and that login/2FA/key-management are never key-accessible.TOO_MANY_REQUESTSGraphQL error withretryAfterSeconds.apiKeys/apiKeyRotate/apiKeyRevoke.Content is
src/index.html(the source), mirrored intopublic/index.htmlso it's correct even if a deploy build doesn't regenerate. The auto-generated schema reference will pick up theapiKey*types once the feature reaches the production API the docs introspect.🤖 Generated with Claude Code