Skip to content

feat(API): improve delete /projects/{project_id}/documents/{id} documentation#1185

Open
Stephen Lumenta (sbl) wants to merge 1 commit into
mainfrom
devex-119-documents-delete-document
Open

feat(API): improve delete /projects/{project_id}/documents/{id} documentation#1185
Stephen Lumenta (sbl) wants to merge 1 commit into
mainfrom
devex-119-documents-delete-document

Conversation

@sbl

Copy link
Copy Markdown
Contributor

Improves the documentation for delete /projects/{project_id}/documents/{id}: 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

Copy link
Copy Markdown
Contributor

API changelog (oasdiff)

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

No changes to report, but the specs are different.
Run 'oasdiff diff' to see structural differences.

@sbl

Copy link
Copy Markdown
Contributor Author

This PR replaces #1177, which was closed after jablan's review.

Feedback addressed from #1177:

Comment Status
"numeric primary key is an internal development detail and should not be exposed" ✅ Fixed
"This 403 description is almost fully generic and could be moved to the referenced section" ✅ Fixed

What changed:

  • The description no longer mentions numeric primary key or DocumentPolicy#destroy?. Implementation details are translated into caller-facing behaviour: "Requires the write scope on the access token and manage permission on the document."
  • The 403 description is now endpoint-specific: "Obtain a token with the write scope or request manage access from a project administrator." Generic 403 prose has been removed rather than moved inline.

🤖 Generated with Claude Code

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