Skip to content

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

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

fix(API): improve delete /projects/{project_id}/keys/{id}/key_links documentation#1193
Stephen Lumenta (sbl) wants to merge 2 commits into
mainfrom
devex-116-linked-keys-batch-unlink-child-keys-from-a-parent-key

Conversation

@sbl

Copy link
Copy Markdown
Contributor

Improves the documentation for delete /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.

17 changes: 0 error, 3 warning, 14 info
warning	[optional-response-header-removed] at doc/compiled.json
	in API DELETE /projects/{project_id}/keys/{id}/key_links
		the optional response header `x-rate-limit-limit` removed for the status `422`

warning	[optional-response-header-removed] at doc/compiled.json
	in API DELETE /projects/{project_id}/keys/{id}/key_links
		the optional response header `x-rate-limit-remaining` removed for the status `422`

warning	[optional-response-header-removed] at doc/compiled.json
	in API DELETE /projects/{project_id}/keys/{id}/key_links
		the optional response header `x-rate-limit-reset` removed for the status `422`

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	[new-optional-request-property] at doc/compiled.json
	in API DELETE /projects/{project_id}/keys/{id}/key_links
		added the new optional request property `strategy`

info	[request-body-became-optional] at doc/compiled.json
	in API DELETE /projects/{project_id}/keys/{id}/key_links
		request body became optional

info	[response-media-type-added] at doc/compiled.json
	in API DELETE /projects/{project_id}/keys/{id}/key_links
		added the media type `application/json` for the response with the status `200`

info	[response-optional-property-added] at doc/compiled.json
	in API DELETE /projects/{project_id}/keys/{id}/key_links
		added the optional property `errors/items/code` to the response with the `422` status

@sbl Stephen Lumenta (sbl) changed the title feat(API): improve delete /projects/{project_id}/keys/{id}/key_links documentation fix(API): improve delete /projects/{project_id}/keys/{id}/key_links documentation Jun 17, 2026
Apply the batch review conventions:
- Trim the scope/status sentence from the description (write-permission,
  'returns 403 on a branch', 'returns 422 KEY_IS_NOT_LINKED'); the 403 and
  422 responses already document these. Keep the main-project restriction
  and the error-code-format note.
- Drop the 'Response (HTTP 200): {...}' trailer from the curl sample.

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