docs(API): improve DELETE /projects/:id/documents/:id documentation#1177
Open
Stephen Lumenta (sbl) wants to merge 1 commit into
Open
docs(API): improve DELETE /projects/:id/documents/:id documentation#1177Stephen Lumenta (sbl) wants to merge 1 commit into
Stephen Lumenta (sbl) wants to merge 1 commit into
Conversation
Adds conceptual description (why/model including permanent deletion warning), documents 401/403 responses with causes and remediation, adds 422 response for model-level constraint failures, and improves example to show expected 200 response. Part of DEVEX-119. 🤖 Generated with Claude Code (claude-sonnet-4-6)
Stephen Lumenta (sbl)
added
the
developer-hub-api-quality
jablan
reviewed
Jun 12, 2026
|
|
||
| Use this endpoint to clean up source documents that are no longer needed — for example, after a campaign has ended or a deprecated content file has been superseded. The deletion is irreversible; ensure you have exported or archived any segment translations before proceeding. | ||
|
|
||
| The document is identified by its `id` (the document's code, not a numeric primary key). The token must have the `write` scope. Deletion is subject to the document policy (`DocumentPolicy#destroy?`), which requires manage permissions on the document. |
Collaborator
There was a problem hiding this comment.
"numeric primary key" is an internal development detail and should not be exposed.
jablan
reviewed
Jun 12, 2026
| '403': | ||
| "$ref": "../../responses.yaml#/403" | ||
| description: Forbidden. Returned when the access token lacks the `write` scope or when the requesting user is not allowed to delete this document. | ||
| description: | |
Collaborator
There was a problem hiding this comment.
this description is almost fully generic and could be moved to the referenced section.
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
DELETE /projects/:project_id/documents/:id(delete document).Changes
All changes are spec-layer only (paths/documents/destroy.yaml + compiled bundle). No Ruby source edits.
Part of DEVEX-119.
Drafted with AI assistance and grounded in the strings-app source. Please review for technical accuracy before merging; nothing is merged automatically.
🤖 Generated with Claude Code