Repository navigation
Drop the scope segment from the API key create path - #3
Merged
Merged
Conversation
POST /api-keys/{type}/{sub-type} put the scope in the URL, so every
workspace-scoped call rendered as /api-keys/workspace/{sub-type}. The
scope comes from the calling token, the same reasoning that removed
organisation_id as a parameter, so the segment was saying twice what the
request already carries -- and saying it in a public URL.
The path is now POST /api-keys/{sub-type}, sub-type still user|service.
Its docs URL moves with it, from post-api-keys-by-type-by-sub-type to
post-api-keys-by-sub-type.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
VisargD
approved these changes
Sep 18, 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
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.
POST /api-keys/{type}/{sub-type}took the scope as a path segment, withtypean enum oforganisation | workspace— so every workspace-scoped call rendered as/api-keys/workspace/user. The scope comes from the calling token, which is the same reasoning behind droppingorganisation_idas a parameter, so the segment restated what the request already carries, in a public URL.The path is now
POST /api-keys/{sub-type};sub-typeis unchanged (user | service).Docs URL moves —
/aigw/api-reference/api-keys/post-api-keys-by-type-by-sub-type→/aigw/api-reference/api-keys/post-api-keys-by-sub-type. Recorded in_project/hrefs.yaml; a redirect on the docs site may be wanted.Left alone deliberately: the
workspace_idquery parameter onGET /api-keys. It is not a path segment, so it is a separate question.Touched files beyond the spec are the decision files and generated artifacts —
_project/hrefs.yaml,_project/planes.yaml,overlays/docs-prose.yaml, plusdocs-navigation.jsonandbuild-report.txtfromscripts/build.py.scripts/check.pypasses.🤖 Generated with Claude Code