diff --git a/articles/LCPublicAPI/api/Public-API.v1.json b/articles/LCPublicAPI/api/Public-API.v1.json index 4f67de7..3d8cfe9 100644 --- a/articles/LCPublicAPI/api/Public-API.v1.json +++ b/articles/LCPublicAPI/api/Public-API.v1.json @@ -8823,6 +8823,9 @@ }, { "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/languageCode" } ], "responses": { @@ -8932,6 +8935,9 @@ }, { "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/languageCode" } ], "responses": { @@ -30833,6 +30839,10 @@ "originatingTaskId": { "type": "string", "description": "The identifier of the task that generated the file." + }, + "verification": { + "$ref": "#/components/schemas/verification", + "description": "The verification result of the target file version. Only available after the file has gone through the Automated QA Check workflow step." } }, "required": [ @@ -34668,6 +34678,60 @@ } } }, + "verification-message": { + "title": "Verification Message", + "type": "object", + "description": "A verification message.", + "properties": { + "messageType": { + "type": "string", + "description": "The type of the verification message." + }, + "friendlyName": { + "type": "string", + "description": "The localized friendly name of the message type." + }, + "verifier": { + "type": "string", + "description": "
default
The verifier that produced the message.
", + "x-default-field": true + }, + "errorMessage": { + "type": "string", + "description": "
default
The localized error message, with error arguments substituted in.
", + "x-default-field": true + }, + "detailedErrorMessage": { + "type": "string", + "description": "
default
The localized detailed error message, with error arguments substituted in.
", + "x-default-field": true + }, + "suggestion": { + "type": "string", + "description": "The localized suggestion for resolving the message." + }, + "segmentId": { + "type": "string", + "description": "
default
The identifier of the segment the message relates to.
", + "x-default-field": true + } + } + }, + "verification": { + "title": "Verification", + "type": "object", + "description": "The verification result of a target file version.", + "properties": { + "messages": { + "type": "array", + "description": "
default
The verification messages.
", + "x-default-field": true, + "items": { + "$ref": "#/components/schemas/verification-message" + } + } + } + }, "volume-unit-type": { "title": "Volume Unit Type", "type": "string", @@ -35644,6 +35708,15 @@ "type": "string" } }, + "languageCode": { + "name": "languageCode", + "in": "query", + "description": "Only applicable when 'verification' is included via the 'fields' query parameter (e.g. 'fields=verification'); ignored otherwise. The language code used to localize the verification message text. The verification message text is localized for \"en-US\", \"cy-GB\", \"de-DE\", \"es-ES\", \"fr-CA\", \"fr-FR\", \"it-IT\", \"ja-JP\", \"nl-NL\" and \"zh-CN\"; any unrecognized value, or omitting this parameter, falls back to \"en-US\".", + "schema": { + "type": "string", + "default": "en-US" + } + }, "email": { "name": "email", "in": "query",