Skip to content

feat(API): improve DELETE /projects/{project_id}/screenshots/{id} documentation#1160

Closed
Stephen Lumenta (sbl) wants to merge 2 commits into
mainfrom
en-api-strings-screenshots-delete-a-screenshot
Closed

feat(API): improve DELETE /projects/{project_id}/screenshots/{id} documentation#1160
Stephen Lumenta (sbl) wants to merge 2 commits into
mainfrom
en-api-strings-screenshots-delete-a-screenshot

Conversation

@sbl

Copy link
Copy Markdown

Fixes rubric dimensions: conceptual_clarity, error_documentation, example_quality, frontmatter_metadata, reference_completeness, schema_completeness, self_contained_examples, stable_identifiers, vocabulary_consistency

Part of DEVEX-60

Source-grounded via Phrase-Engineering/strings-app.

Changes

  • operationId corrected from screenshot/delete to screenshots/destroy (resource/action convention)
  • description expanded from a single vague sentence to a full description covering what the operation does, why you would use it, the string-code id shape, the cascade (markers removed), the feature gate (Attachable Screenshots), and the webhook side effect
  • branch parameter replaced inline definition with shared param ref
  • 204 response replaced bare ref with inline response including rate-limit headers
  • 403 description reworded to accurately reflect Manage permission requirement
  • curl example fixed branch from JSON body to query parameter; replaced placeholders with realistic example values; removed incorrect flags for a DELETE with no body
  • CLI example replaced angle-bracket placeholders with realistic example values

…ntation

Fix rubric dimensions: conceptual_clarity, error_documentation,
example_quality, frontmatter_metadata, reference_completeness,
schema_completeness, self_contained_examples, stable_identifiers,
vocabulary_consistency.

- operationId corrected to screenshots/show (was screenshot/show)
- branch parameter uses shared $ref instead of inline duplicate
- description expanded with what/why/access-control/branch semantics
- 403 response lists all three distinct paths to forbidden
- response example added with realistic values derived from serializer
- curl example uses full URL with realistic project_id + screenshot id
- schema properties gain descriptions and per-field examples

Part of DEVEX-60. Source-grounded via Phrase-Engineering/strings-app.
@sbl Stephen Lumenta (sbl) deleted the en-api-strings-screenshots-delete-a-screenshot branch June 8, 2026 21:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant