Repository navigation
docs: correct the API Keys page and API reference - #111
Merged
Merged
Conversation
The API Keys page claimed keys are shown once, used an endpoint that does not exist in its examples, and listed permissions no endpoint checks. The API reference still said every key expires after 30 days, which stopped being true when non-expiring keys shipped, and that the portal cannot grant Protect permissions, which it now can.
✅ Deploy Preview for peaceful-pothos-9e62ce ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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.
Fixes the API docs where they say things the product doesn't do. Answers prosopo/captcha-private#4486.
API Keys page
/api-keys/getreturns it. The page now says so./v1/prosopo/provider/admin/rules, which doesn't exist. They now callPOST /access-control/get.getSuggestion,getSuggestions,applySuggestions,updateApiKeyandverifyfrom the permission tables. No endpoint checks them. The page now notes that the dialog still offers the first four and that they do nothing.verify" advice for an example that works.updateProtectSettings,ingestClientEvents), which the portal dialog now offers.0does the same.API reference
guides/data-fetching.mdxwithastro/docs#5076 shipped. It now says omittingexpiresIn, or sending0, gives a non-expiring key.ingestClientEventspermission.Testing: docs only.
astro buildpasses, Prettier is clean, and the new anchors (#api-keys,#client-events) render. Every statement was checked againstcaptcha-privatemain (createApiKey.ts,apiKeys.ts,ApiKeyCard.tsx,CreateApiKeyModal.tsx,serverless.yml, the Protect ingest handlers).