Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Łukasz Ciesielski (lookasc) wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −0
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/compiled.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -2141,6 +2146,7 @@
"filename": "example.json",
"format": "json",
"state": "success",
"error_message": null,
"tag": "tag",
"summary": {
"locales_created": 2,
Expand Down
8 changes: 8 additions & 0 deletions schemas/upload.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down Expand Up @@ -66,6 +73,7 @@ upload:
filename: example.json
format: json
state: success
error_message: null
tag: tag
summary:
locales_created: 2
Expand Down
Loading