feat: add API key management (Ory Talos) to the Ory Network docs#2661
Draft
aeneasr wants to merge 2 commits into
Draft
feat: add API key management (Ory Talos) to the Ory Network docs#2661aeneasr wants to merge 2 commits into
aeneasr wants to merge 2 commits into
Conversation
Make API key management discoverable and usable for Ory Network readers: - Network intro, quickstart, and configuration pages under docs/network/talos using the Shared+shell pattern. - ConsoleLink routes and nav data for the Console API Keys section. - "API Key Management" category in the Network sidebar and Talos entries in every quickstarts picker variant. - Discoverability: intro, products overview, welcome cards, Network, OEL, and OSS landing pages, and the SDK page. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
New projects get their Talos HMAC secret and JWT signing key at creation (backoffice setSecrets), so the Enable API Keys button only appears on projects created before the launch — describe both states instead of an unconditional activation step. Soften the SDK page so it does not imply the currently published @ory/client already exports the API keys client, and clarify the max_ttl value in the CLI example. Co-Authored-By: Claude Fable 5 <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
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.
What changed
Ory Talos (API key management) is live on Ory Network but invisible in these docs. This PR adds the Network-facing surfaces (PR-3 of a three-PR sequence):
docs/network/talos/using the Shared+shell pattern (src/components/Shared/talos/index.mdx):ory_pat_vsory_ak_disambiguation included; verify is an authenticated admin call, never public).ory patch project --add '/services/talos=…'(whole object), caveats (ory get projectomits the config; deep patch paths unsupported;--removenot--delete), per-project key reference with Network-default deltas, managed-by-Ory list, rotation semantics.routes.project.apiKeys.{keys,imported,playground,configuration}+ "API Keys" nav group between "OAuth 2" and "Permissions" (matches the shipped Console nav).npm run check-console-linkspasses — the Console pages resolve.sidebars-network.ts(mixing the new shells with the existingtalos/{integrate,concepts,reference}tree, Keto precedent; deliberately excludesoperate/*, env-var config reference, and thetalosCLI pages from the Network audience) + quickstarts picker entries for Network/OEL/OSS.intro.mdx,products/overview.mdx, welcome cards, Network/OEL/OSS getting-started pages,sdk.mdx.No existing URLs changed → no
vercel.jsonredirects.Sequencing
docs/talos/whole-tree port ("PR-2") follows separately; the sidebar here references only pre-existingtalos/*doc ids. Port contract change: never rsync the monorepo-generatedreference/api/into this repo — copy the spec todocs/talos/reference/api.jsonand regenerate withnpx docusaurus clean-api-docs talos && npx docusaurus gen-api-docs talos.Verification
npm run build— green, zero talos-related warnings (checked manually becauseonBrokenLinks: warn).make format,npm run check-console-links— green. markdownlint: only baseline MD044 noise identical to the merged Keto shells.Merge order (do not merge before the port)
sidebars-network.tslinkstalos/integrate/*andtalos/concepts/*doc ids whose current copies underdocs/talos/are the pre-port tree — self-hosted-only content with no deployment-aware prerequisites. Merge order:talos/talos/docs/intodocs/talos/(Task 5 procedure).Console screenshots are produced by the new e2epw screenshot rake (
test/e2epw,pnpm run docs-screenshots+scripts/sync-docs-screenshots.sh) once the k3d cluster is up; embed them together with the images indocs/network/talos/_static/.Remaining before un-drafting
ory patch projectround-trip (prose is code-verified against the spec, gateway rules, and backoffice tests).🤖 Generated with Claude Code