Skip to content

feat(API): improve patch /projects/{project_id}/screenshots/{id} documentation#1190

Open
Stephen Lumenta (sbl) wants to merge 1 commit into
mainfrom
devex-115-screenshots-update-a-screenshot
Open

feat(API): improve patch /projects/{project_id}/screenshots/{id} documentation#1190
Stephen Lumenta (sbl) wants to merge 1 commit into
mainfrom
devex-115-screenshots-update-a-screenshot

Conversation

@sbl

Copy link
Copy Markdown
Contributor

Improves the documentation for patch /projects/{project_id}/screenshots/{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.

2 changes: 1 error, 0 warning, 1 info
error	[request-body-media-type-removed] at doc/compiled.json
	in API PATCH /projects/{project_id}/screenshots/{id}
		removed the media type `application/json` from the request body

info	[request-body-media-type-added] at doc/compiled.json
	in API PATCH /projects/{project_id}/screenshots/{id}
		added the media type `multipart/form-data` to the request body

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