From 18b18d0213f54c57b5234a8f7440376c7034ee8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Ciesielski?= Date: Tue, 8 Sep 2026 13:14:30 +0000 Subject: [PATCH] docs(STRINGS-3229): document error_message field on upload response 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 --- doc/compiled.json | 6 ++++++ schemas/upload.yaml | 8 ++++++++ 2 files changed, 14 insertions(+) diff --git a/doc/compiled.json b/doc/compiled.json index 7927c2830..cded3fd1c 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -2072,6 +2072,11 @@ "state": { "type": "string" }, + "error_message": { + "type": "string", + "nullable": true, + "description": "A user-facing message explaining why the upload failed, or `null` if the upload did not fail.\n\nThis message is intended for display only. Its wording may change at any time and it should not be parsed or relied upon programmatically.\n" + }, "tag": { "type": "string", "description": "Unique tag of the upload\n" @@ -2141,6 +2146,7 @@ "filename": "example.json", "format": "json", "state": "success", + "error_message": null, "tag": "tag", "summary": { "locales_created": 2, diff --git a/schemas/upload.yaml b/schemas/upload.yaml index 32ad1894e..6bff13f46 100644 --- a/schemas/upload.yaml +++ b/schemas/upload.yaml @@ -11,6 +11,13 @@ upload: type: string state: type: string + error_message: + type: string + nullable: true + description: | + A user-facing message explaining why the upload failed, or `null` if the upload did not fail. + + This message is intended for display only. Its wording may change at any time and it should not be parsed or relied upon programmatically. tag: type: string description: | @@ -66,6 +73,7 @@ upload: filename: example.json format: json state: success + error_message: null tag: tag summary: locales_created: 2