From 522751b0a91245a9a11e31d6b855538d637c1b26 Mon Sep 17 00:00:00 2001 From: Raul Detesan Date: Mon, 21 Sep 2026 14:40:38 +0300 Subject: [PATCH 1/7] CRQ-46495 Exposed Get Verification messages --- articles/LCPublicAPI/api/Public-API.v1.json | 97 +++++++++++++++++++++ 1 file changed, 97 insertions(+) diff --git a/articles/LCPublicAPI/api/Public-API.v1.json b/articles/LCPublicAPI/api/Public-API.v1.json index 4f67de7..b7c74b9 100644 --- a/articles/LCPublicAPI/api/Public-API.v1.json +++ b/articles/LCPublicAPI/api/Public-API.v1.json @@ -30833,6 +30833,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 +34672,99 @@ } } }, + "verification-message-location": { + "title": "Verification Message Location", + "type": "object", + "description": "The location of a verification message within a segment.", + "properties": { + "fromLocation": { + "type": "integer", + "description": "The starting position of the message location." + }, + "toLocation": { + "type": "integer", + "description": "The ending position of the message location." + } + } + }, + "verification-message": { + "title": "Verification Message", + "type": "object", + "description": "A verification message.", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the verification message." + }, + "messageType": { + "type": "string", + "description": "The type of the verification message." + }, + "level": { + "type": "string", + "description": "The severity level of the verification message.", + "enum": [ + "Error", + "Warning", + "Note" + ] + }, + "verifier": { + "type": "string", + "description": "The verifier that produced the message." + }, + "isIgnored": { + "type": "boolean", + "description": "Indicates whether the message is ignored." + }, + "ignoredSource": { + "type": "string", + "description": "Indicates how the message came to be ignored.", + "enum": [ + "None", + "ByMessageType", + "ByMessageId" + ] + }, + "location": { + "$ref": "#/components/schemas/verification-message-location" + }, + "errorArguments": { + "type": "array", + "description": "The arguments associated with the message.", + "items": { + "type": "string" + } + }, + "isSource": { + "type": "boolean", + "description": "Indicates whether the message applies to the source segment." + }, + "tagId": { + "type": "string", + "description": "The identifier of the tag the message relates to, if applicable." + }, + "segmentId": { + "type": "string", + "description": "The identifier of the segment the message relates to." + } + } + }, + "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", From 93e726a13f8f6c00c92454f23c4aa0af1349721e Mon Sep 17 00:00:00 2001 From: Raul Detesan Date: Tue, 22 Sep 2026 08:58:38 +0300 Subject: [PATCH 2/7] Fixed comments --- articles/LCPublicAPI/api/Public-API.v1.json | 86 +++++++++++++++++++-- 1 file changed, 79 insertions(+), 7 deletions(-) diff --git a/articles/LCPublicAPI/api/Public-API.v1.json b/articles/LCPublicAPI/api/Public-API.v1.json index b7c74b9..387f02f 100644 --- a/articles/LCPublicAPI/api/Public-API.v1.json +++ b/articles/LCPublicAPI/api/Public-API.v1.json @@ -34698,15 +34698,87 @@ }, "messageType": { "type": "string", - "description": "The type of the verification message." + "description": "The type of the verification message.", + "enum": [ + "unsupportedType", + "wordListCheck", + "reportAllNonExcluded", + "reportUntranslatedSegment", + "tradeMarkMissing", + "tradeMarkExtra", + "identicalSegment", + "segmentShorter", + "segmentLonger", + "forbiddenChar", + "duplicatedWord", + "uneditedMatch", + "lengthLimitationFixed", + "lengthLimitationContextLong", + "lengthLimitationContextShort", + "punctuationDifferences", + "spanishPunctuation", + "punctuationSpace", + "punctuationSpaceFrench", + "multipleSpaces", + "multipleDots", + "extraEndSpace", + "initialCaps", + "globalCaps", + "openingBracketMissing", + "openingBracketExtra", + "closingBracketMissing", + "closingBracketExtra", + "regExReport", + "regExReportSourceOnly", + "regExReportTargetOnly", + "regExReportGroupedTargetOnly", + "regExReportGroupedBoth", + "numberMissing", + "timeMissing", + "dateMissing", + "measurementMissing", + "numberExtra", + "timeExtra", + "dateExtra", + "measurementExtra", + "tagPairAdded", + "lockedContentExtra", + "tagAdded", + "tagPairDeleted", + "lockedContentNotCopied", + "tagDeleted", + "spaceBeforeTagPairAdded", + "spaceBeforeTagPairRemoved", + "spaceBeforeTagAdded", + "spaceBeforeTagRemoved", + "spaceAfterTagPairAdded", + "spaceAfterTagPairRemoved", + "spaceAfterTagAdded", + "spaceAfterTagRemoved", + "spaceAfterStartTagPairAdded", + "spaceAfterStartTagPairRemoved", + "spaceBeforeEndTagPairAdded", + "spaceBeforeEndTagPairRemoved", + "tagsMoved", + "inconsistentTranslation", + "customType", + "missingTargetTermInTB", + "missingTargetTermHomonym", + "sourceTermOccurenceMissingInTarget", + "missingTargetTerm", + "forbiddenUsageTerm", + "unsupportedLanguageInTB", + "nativeXMLValidation", + "nativeXMLVrpValidation" + ] }, "level": { "type": "string", "description": "The severity level of the verification message.", "enum": [ - "Error", - "Warning", - "Note" + "error", + "warning", + "note" ] }, "verifier": { @@ -34721,9 +34793,9 @@ "type": "string", "description": "Indicates how the message came to be ignored.", "enum": [ - "None", - "ByMessageType", - "ByMessageId" + "none", + "byMessageType", + "byMessageId" ] }, "location": { From d05b209e83842dbdc1ed251fd66a1e56bd1a283a Mon Sep 17 00:00:00 2001 From: Raul Detesan Date: Tue, 22 Sep 2026 12:16:54 +0300 Subject: [PATCH 3/7] Changed the response of verification --- articles/LCPublicAPI/api/Public-API.v1.json | 145 +++----------------- 1 file changed, 19 insertions(+), 126 deletions(-) diff --git a/articles/LCPublicAPI/api/Public-API.v1.json b/articles/LCPublicAPI/api/Public-API.v1.json index 387f02f..01e5b53 100644 --- a/articles/LCPublicAPI/api/Public-API.v1.json +++ b/articles/LCPublicAPI/api/Public-API.v1.json @@ -34672,153 +34672,46 @@ } } }, - "verification-message-location": { - "title": "Verification Message Location", - "type": "object", - "description": "The location of a verification message within a segment.", - "properties": { - "fromLocation": { - "type": "integer", - "description": "The starting position of the message location." - }, - "toLocation": { - "type": "integer", - "description": "The ending position of the message location." - } - } - }, "verification-message": { "title": "Verification Message", "type": "object", "description": "A verification message.", "properties": { - "id": { + "messageType": { "type": "string", - "description": "The unique identifier of the verification message." + "description": "The type of the verification message." }, - "messageType": { + "friendlyName": { "type": "string", - "description": "The type of the verification message.", - "enum": [ - "unsupportedType", - "wordListCheck", - "reportAllNonExcluded", - "reportUntranslatedSegment", - "tradeMarkMissing", - "tradeMarkExtra", - "identicalSegment", - "segmentShorter", - "segmentLonger", - "forbiddenChar", - "duplicatedWord", - "uneditedMatch", - "lengthLimitationFixed", - "lengthLimitationContextLong", - "lengthLimitationContextShort", - "punctuationDifferences", - "spanishPunctuation", - "punctuationSpace", - "punctuationSpaceFrench", - "multipleSpaces", - "multipleDots", - "extraEndSpace", - "initialCaps", - "globalCaps", - "openingBracketMissing", - "openingBracketExtra", - "closingBracketMissing", - "closingBracketExtra", - "regExReport", - "regExReportSourceOnly", - "regExReportTargetOnly", - "regExReportGroupedTargetOnly", - "regExReportGroupedBoth", - "numberMissing", - "timeMissing", - "dateMissing", - "measurementMissing", - "numberExtra", - "timeExtra", - "dateExtra", - "measurementExtra", - "tagPairAdded", - "lockedContentExtra", - "tagAdded", - "tagPairDeleted", - "lockedContentNotCopied", - "tagDeleted", - "spaceBeforeTagPairAdded", - "spaceBeforeTagPairRemoved", - "spaceBeforeTagAdded", - "spaceBeforeTagRemoved", - "spaceAfterTagPairAdded", - "spaceAfterTagPairRemoved", - "spaceAfterTagAdded", - "spaceAfterTagRemoved", - "spaceAfterStartTagPairAdded", - "spaceAfterStartTagPairRemoved", - "spaceBeforeEndTagPairAdded", - "spaceBeforeEndTagPairRemoved", - "tagsMoved", - "inconsistentTranslation", - "customType", - "missingTargetTermInTB", - "missingTargetTermHomonym", - "sourceTermOccurenceMissingInTarget", - "missingTargetTerm", - "forbiddenUsageTerm", - "unsupportedLanguageInTB", - "nativeXMLValidation", - "nativeXMLVrpValidation" - ] + "description": "The localized friendly name of the message type." }, - "level": { + "category": { "type": "string", - "description": "The severity level of the verification message.", - "enum": [ - "error", - "warning", - "note" - ] + "description": "The localized category of the message type." }, "verifier": { "type": "string", - "description": "The verifier that produced the message." - }, - "isIgnored": { - "type": "boolean", - "description": "Indicates whether the message is ignored." + "description": "
default
The verifier that produced the message.
", + "x-default-field": true }, - "ignoredSource": { + "errorMessage": { "type": "string", - "description": "Indicates how the message came to be ignored.", - "enum": [ - "none", - "byMessageType", - "byMessageId" - ] - }, - "location": { - "$ref": "#/components/schemas/verification-message-location" - }, - "errorArguments": { - "type": "array", - "description": "The arguments associated with the message.", - "items": { - "type": "string" - } + "description": "
default
The localized error message, with error arguments substituted in.
", + "x-default-field": true }, - "isSource": { - "type": "boolean", - "description": "Indicates whether the message applies to the source segment." + "detailedErrorMessage": { + "type": "string", + "description": "
default
The localized detailed error message, with error arguments substituted in.
", + "x-default-field": true }, - "tagId": { + "suggestion": { "type": "string", - "description": "The identifier of the tag the message relates to, if applicable." + "description": "The localized suggestion for resolving the message." }, "segmentId": { "type": "string", - "description": "The identifier of the segment the message relates to." + "description": "
default
The identifier of the segment the message relates to.
", + "x-default-field": true } } }, From 7c3acbfb23c00fe6a4dd3f9c7b13664281966ca2 Mon Sep 17 00:00:00 2001 From: Raul Detesan Date: Tue, 22 Sep 2026 15:55:00 +0300 Subject: [PATCH 4/7] Added culture parameter --- articles/LCPublicAPI/api/Public-API.v1.json | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/articles/LCPublicAPI/api/Public-API.v1.json b/articles/LCPublicAPI/api/Public-API.v1.json index 01e5b53..8a40d5b 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/culture" } ], "responses": { @@ -8932,6 +8935,9 @@ }, { "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/culture" } ], "responses": { @@ -35706,6 +35712,15 @@ "type": "string" } }, + "culture": { + "name": "culture", + "in": "query", + "description": "The culture used to localize the verification message type text (\"friendlyName\", \"category\", \"errorMessage\", \"detailedErrorMessage\", \"suggestion\") returned when \"verification.messages\" is requested via the 'fields' query parameter. Defaults to \"en-US\" when omitted. If the requested culture is not recognized, the response falls back to \"en-US\".", + "schema": { + "type": "string", + "default": "en-US" + } + }, "email": { "name": "email", "in": "query", From 05054f756e552e72f8a7530b8766855f2c648295 Mon Sep 17 00:00:00 2001 From: Raul Detesan Date: Tue, 22 Sep 2026 16:26:16 +0300 Subject: [PATCH 5/7] fixed description of culture --- articles/LCPublicAPI/api/Public-API.v1.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/articles/LCPublicAPI/api/Public-API.v1.json b/articles/LCPublicAPI/api/Public-API.v1.json index 8a40d5b..4f5c1c9 100644 --- a/articles/LCPublicAPI/api/Public-API.v1.json +++ b/articles/LCPublicAPI/api/Public-API.v1.json @@ -35715,7 +35715,7 @@ "culture": { "name": "culture", "in": "query", - "description": "The culture used to localize the verification message type text (\"friendlyName\", \"category\", \"errorMessage\", \"detailedErrorMessage\", \"suggestion\") returned when \"verification.messages\" is requested via the 'fields' query parameter. Defaults to \"en-US\" when omitted. If the requested culture is not recognized, the response falls back to \"en-US\".", + "description": "The culture used to localize the verification message text when it is requested via the 'fields' query parameter. Defaults to \"en-US\" when omitted. If the requested culture is not recognized, the response falls back to \"en-US\".", "schema": { "type": "string", "default": "en-US" From 3e6b4492091191a0252ef17cb6d6f6774d385924 Mon Sep 17 00:00:00 2001 From: Raul Detesan Date: Tue, 22 Sep 2026 16:41:09 +0300 Subject: [PATCH 6/7] Removed category --- articles/LCPublicAPI/api/Public-API.v1.json | 4 ---- 1 file changed, 4 deletions(-) diff --git a/articles/LCPublicAPI/api/Public-API.v1.json b/articles/LCPublicAPI/api/Public-API.v1.json index 4f5c1c9..172b651 100644 --- a/articles/LCPublicAPI/api/Public-API.v1.json +++ b/articles/LCPublicAPI/api/Public-API.v1.json @@ -34691,10 +34691,6 @@ "type": "string", "description": "The localized friendly name of the message type." }, - "category": { - "type": "string", - "description": "The localized category of the message type." - }, "verifier": { "type": "string", "description": "
default
The verifier that produced the message.
", From 8eb8dc2010e35780a7ee2a66834ac16d3ac34b0b Mon Sep 17 00:00:00 2001 From: Raul Detesan Date: Tue, 22 Sep 2026 17:41:39 +0300 Subject: [PATCH 7/7] Replaced culture with language code --- articles/LCPublicAPI/api/Public-API.v1.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/articles/LCPublicAPI/api/Public-API.v1.json b/articles/LCPublicAPI/api/Public-API.v1.json index 172b651..20d1fd7 100644 --- a/articles/LCPublicAPI/api/Public-API.v1.json +++ b/articles/LCPublicAPI/api/Public-API.v1.json @@ -8825,7 +8825,7 @@ "$ref": "#/components/parameters/fields" }, { - "$ref": "#/components/parameters/culture" + "$ref": "#/components/parameters/languageCode" } ], "responses": { @@ -8937,7 +8937,7 @@ "$ref": "#/components/parameters/fields" }, { - "$ref": "#/components/parameters/culture" + "$ref": "#/components/parameters/languageCode" } ], "responses": { @@ -35708,10 +35708,10 @@ "type": "string" } }, - "culture": { - "name": "culture", + "languageCode": { + "name": "languageCode", "in": "query", - "description": "The culture used to localize the verification message text when it is requested via the 'fields' query parameter. Defaults to \"en-US\" when omitted. If the requested culture is not recognized, the response falls back to \"en-US\".", + "description": "The language code used to localize the verification message text when it is requested via the 'fields' query parameter. The only supported values are \"en-US\" (default), \"cy-GB\", \"de-DE\", \"es-ES\", \"fr-CA\", \"fr-FR\", \"it-IT\", \"ja-JP\", \"nl-NL\" and \"zh-CN\". Defaults to \"en-US\" when omitted. If the requested language code is not one of the supported values, the response falls back to \"en-US\".", "schema": { "type": "string", "default": "en-US"