Skip to content

docs(API): improve post /projects/{project_id}/keys/{id}/key_links documentation#1192

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

docs(API): improve post /projects/{project_id}/keys/{id}/key_links documentation#1192
Stephen Lumenta (sbl) wants to merge 2 commits into
mainfrom
devex-116-linked-keys-link-child-keys-to-a-parent-key-v2

Conversation

@sbl

@sbl Stephen Lumenta (sbl) commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

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

Jira: DEVEX-116

🤖 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 •
edited
Loading

Copy link
Copy Markdown
Contributor

API changelog (oasdiff)

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

10 changes: 0 error, 0 warning, 10 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`

@sbl Stephen Lumenta (sbl) changed the title feat(API): improve post /projects/{project_id}/keys/{id}/key_links documentation fix(API): improve post /projects/{project_id}/keys/{id}/key_links documentation Jun 17, 2026
@sbl @claude
docs(API): clean up post /projects/{project_id}/keys/{id}/key_links
d725329 
Apply the same review conventions landed on the reviewed PRs in this batch:
- Remove the 'Errors:' enumeration from the top-level description; each
  status code already carries its own description on the response object.
- Drop the 'HTTP/1.1 201 Created' response trailer from the curl sample.
- Remove the endpoint-level security block (was overriding the global
  Token/Basic security with OAuth2 on just this operation, which oasdiff
  flagged and theSoenke flagged on the sibling screenshots PR).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@sbl Stephen Lumenta (sbl) changed the title fix(API): improve post /projects/{project_id}/keys/{id}/key_links documentation docs(API): improve post /projects/{project_id}/keys/{id}/key_links documentation Jun 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@sbl