docs(API): improve post /projects/{project_id}/keys/{id}/key_links documentation#1192
Merged
Stephen Lumenta (sbl) merged 7 commits intoJun 26, 2026
Conversation
Stephen Lumenta (sbl)
added
the
developer-hub-api-quality
Contributor
API changelog (oasdiff)Doc-only edits (descriptions, examples) do not appear here. |
Stephen Lumenta (sbl)
changed the title
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>
Stephen Lumenta (sbl)
changed the title
Review feedback: error response descriptions should stay in the shared responses.yaml for consistency, not be re-authored inline per operation. Under OpenAPI 3.0 a description sibling of $ref is ignored anyway, so the inline text never rendered. Strip the inline $ref-sibling response descriptions (now bare $refs); the shared response owns the wording. Genuinely custom (non-$ref) response bodies are left intact. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
jablan
requested changes
Jun 25, 2026
Address @jablan's review: the 201 response repeated a large inline example even though the schema is already a `$ref` to `schemas/key_link.yaml#/key_link`. Move the canonical example onto the shared schema so every operation that references key_link (create, list, batch unlink) renders it without restating it, and drop the now-redundant inline example from create.yaml. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Stephen Lumenta (sbl)
added a commit
that referenced
this pull request
Jun 25, 2026
Apply the same dedup as #1192/#1193: the list response repeated a large inline example on top of the `$ref` to `schemas/key_link.yaml#/key_link`. Move the canonical example onto the shared schema and drop the inline copy, so every key_links operation renders one example through the `$ref`. Note: #1192 makes the identical addition to schemas/key_link.yaml; whichever of the two merges second will see a trivial add/add conflict on that file — keep one copy of the example. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Regenerated from source with `swagger-cli bundle -t json -w 300 main.yaml` (the exact command the lint/compare-output CI job runs), so the committed bundle matches a fresh bundle of the deduped YAML. Fixes the compare-output failure introduced by editing the source without rebundling. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Stephen Lumenta (sbl)
added a commit
that referenced
this pull request
Jun 25, 2026
Follow-up to @jablan's review: referencing the schema was only half of it — the 200 response still carried a large inline example that overrode the `$ref` and duplicated the shared model (with off-convention slug-style ids). Drop the inline example and put the canonical one on `schemas/key_link.yaml`, matching #1192 and #1188, so create, list, and batch unlink all render one example through the ref. Rebundled doc/compiled.json from source. Note: #1192 and #1188 make the identical addition to schemas/key_link.yaml; whichever of the three merges first wins and the others get a trivial add/add conflict on that file — keep one copy of the example. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
jablan
approved these changes
Jun 26, 2026
Stephen Lumenta (sbl)
deleted the
devex-116-linked-keys-link-child-keys-to-a-parent-key-v2
branch
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
2 participants
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.
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