Skip to content

fix(API): improve get /projects/{project_id}/keys/{id}/key_links documentation#1188

Open
Stephen Lumenta (sbl) wants to merge 2 commits into
mainfrom
devex-116-linked-keys-list-child-keys-of-a-parent-key
Open

fix(API): improve get /projects/{project_id}/keys/{id}/key_links documentation#1188
Stephen Lumenta (sbl) wants to merge 2 commits into
mainfrom
devex-116-linked-keys-list-child-keys-of-a-parent-key

Conversation

@sbl

Copy link
Copy Markdown
Contributor

Improves the documentation for get /projects/{project_id}/keys/{id}/key_links: sharper descriptions, parameter docs, error responses, and usage examples.

Drafted with AI assistance and grounded in the API implementation. Please review for technical accuracy before merging; nothing is merged automatically.

🤖 Generated with Claude Code

@sbl Stephen Lumenta (sbl) added the developer-hub-api-quality API doc quality fix from the API Grader label Jun 15, 2026
@github-actions

github-actions Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

API changelog (oasdiff)

Doc-only edits (descriptions, examples) do not appear here.

11 changes: 0 error, 0 warning, 11 info
info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/api_name` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/default_encoding` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/default_file` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/description` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/exportable` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/extension` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/importable` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/includes_locale_information` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/name` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/renders_default_locale` became required for the status `200`

info	[response-optional-property-added] at doc/compiled.json
	in API GET /projects/{project_id}/keys/{id}/key_links
		added the optional property `error` to the response with the `400` status

@sbl Stephen Lumenta (sbl) changed the title feat(API): improve get /projects/{project_id}/keys/{id}/key_links documentation fix(API): improve get /projects/{project_id}/keys/{id}/key_links documentation Jun 17, 2026
Apply the batch review conventions:
- Drop the scope/permission sentence ('Requires the translations:write
  scope ...') from the description; the 403 response already documents it.
- Remove the 'return a 400 response with error code key_not_a_parent'
  status sentence; the 400 response carries that detail. Keep the
  parent-key precondition and the error-code-format note.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

developer-hub-api-quality API doc quality fix from the API Grader

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant