Skip to content

feat(API): improve get /projects/{project_id}/screenshots documentation#1169

Closed
Stephen Lumenta (sbl) wants to merge 1 commit into
mainfrom
devex-115-screenshots-list-screenshots-v2
Closed

feat(API): improve get /projects/{project_id}/screenshots documentation#1169
Stephen Lumenta (sbl) wants to merge 1 commit into
mainfrom
devex-115-screenshots-list-screenshots-v2

Conversation

@sbl

Copy link
Copy Markdown
Contributor

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

Closes DEVEX-115.

@sbl Stephen Lumenta (sbl) added the developer-hub-api-quality API doc quality fix from the API Grader label Jun 10, 2026
Comment thread paths/screenshots/index.yaml Outdated
parameters:
- "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
- "$ref": "../../parameters.yaml#/project_id"
- "$ref": "../../parameters.yaml#/branch"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is nice.

@github-actions

github-actions Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

API changelog (oasdiff)

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

1 changes: 1 error, 0 warning, 0 info
error	[request-parameter-pattern-added] at doc/compiled.json
	in API GET /projects/{project_id}/screenshots
		added the pattern `^[0-9a-f]{32}$` to the `query` request parameter `key_id`
		This is a breaking change because adding a pattern restriction to a previously unrestricted parameter will reject values that were previously accepted, breaking existing clients

Comment thread paths/screenshots/index.yaml Outdated
- "$ref": "../../parameters.yaml#/branch"
- "$ref": "../../parameters.yaml#/page"
- "$ref": "../../parameters.yaml#/per_page"
- name: branch

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is this reference expanded now?

@sbl Stephen Lumenta (sbl) force-pushed the devex-115-screenshots-list-screenshots-v2 branch from 44897c5 to bcd3344 Compare June 15, 2026 15:02
@sbl

Copy link
Copy Markdown
Contributor Author

Closing — missed in the earlier batch cleanup. Fresh PR with updated prompts already open.

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.

2 participants