Skip to content

docs(STRINGS-3229): document error_message field on upload response - #1259

Open
Łukasz Ciesielski (lookasc) wants to merge 1 commit into
mainfrom
strings-3229-upload-error-schema
Open

docs(STRINGS-3229): document error_message field on upload response#1259
Łukasz Ciesielski (lookasc) wants to merge 1 commit into
mainfrom
strings-3229-upload-error-schema

Conversation

@lookasc

@lookasc Łukasz Ciesielski (lookasc) commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Purpose

Adds an optional, nullable error_message property to the upload schema
so the public API docs reflect the new diagnostic field being added in
the companion strings-app PR for GET /projects/{id}/uploads/{id}. It is
populated only when an upload fails; null otherwise.

Regenerated doc/compiled.json via `make lint` to keep the bundled spec
in sync.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

API changelog (oasdiff)

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

4 changes: 0 error, 0 warning, 4 info
info	[response-optional-property-added] at doc/compiled.json
	in API POST /projects/{project_id}/upload_batches
		added the optional property `uploads/items/error_message` to the response with the `201` status

info	[response-optional-property-added] at doc/compiled.json
	in API GET /projects/{project_id}/uploads
		added the optional property `items/error_message` to the response with the `200` status

info	[response-optional-property-added] at doc/compiled.json
	in API POST /projects/{project_id}/uploads
		added the optional property `error_message` to the response with the `201` status

info	[response-optional-property-added] at doc/compiled.json
	in API GET /projects/{project_id}/uploads/{id}
		added the optional property `error_message` to the response with the `200` status

@lookasc
Łukasz Ciesielski (lookasc) marked this pull request as ready for review September 9, 2026 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants