feat(API): improve get /projects/{project_id}/documents documentation#1183
Open
Stephen Lumenta (sbl) wants to merge 1 commit into
Open
feat(API): improve get /projects/{project_id}/documents documentation#1183Stephen Lumenta (sbl) wants to merge 1 commit into
Stephen Lumenta (sbl) wants to merge 1 commit into
Conversation
Contributor
API changelog (oasdiff)Doc-only edits (descriptions, examples) do not appear here. |
Contributor
Author
|
This PR replaces #1178, which was closed after reviews from jablan and theSoenke. Feedback addressed from #1178:
What changed: The description is fully rewritten. All six flagged items are removed:
What remains is endpoint-specific: what a document is, when you'd use this endpoint, how the 🤖 Generated with Claude Code |
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
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
get /projects/{project_id}/documents: 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