From 66572f5d60352e8a11a314fd6c7a8dceec9cab4f Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Mon, 21 Oct 2024 15:10:13 +0300 Subject: [PATCH 01/21] fix warnings --- .../regex_check_settings.yaml | 115 ++++++- .../regex_check_settings_result.yaml | 300 ++++++++++++++---- 2 files changed, 346 insertions(+), 69 deletions(-) diff --git a/spec/translation_quality/regex_check_settings.yaml b/spec/translation_quality/regex_check_settings.yaml index 057cc13a..3088b5a4 100644 --- a/spec/translation_quality/regex_check_settings.yaml +++ b/spec/translation_quality/regex_check_settings.yaml @@ -26,6 +26,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/TQCRegexRuleResponse' + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl @@ -52,6 +60,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/TQCRegexRuleResponse' + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl @@ -83,6 +99,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/TQCRegexRuleResponse' + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl @@ -101,7 +125,7 @@ x-paths: - $ref: './tqc_common.yaml#/components/parameters/regexRuleUidPathParameter' responses: - '200': + 200: description: OK content: application/json: @@ -110,9 +134,15 @@ x-paths: examples: response: value: - response: - code: SUCCESS - data: null + code: SUCCESS + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl @@ -155,6 +185,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/TQCRegexRuleGroupResponse' + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl @@ -179,6 +217,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/TQCRegexRuleGroupsResponse' + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl @@ -206,6 +252,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/TQCRegexRuleGroupResponse' + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl @@ -226,7 +280,7 @@ x-paths: - $ref: './tqc_common.yaml#/components/parameters/groupUidPathParameter' responses: - '200': + 200: description: OK content: application/json: @@ -235,9 +289,15 @@ x-paths: examples: response: value: - response: - code: SUCCESS - data: null + code: SUCCESS + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl @@ -272,6 +332,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/TQCRegexRuleResponse' + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl @@ -306,6 +374,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/TQCRegexRuleGroupResponse' + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl @@ -322,12 +398,13 @@ x-paths: operationId: deleteLocaleFromTranslationQualityCheckTypeRegexRuleGroup parameters: - $ref: '../api_common.yaml#/components/parameters/accountUid' + - $ref: './tqc_common.yaml#/components/parameters/profileUidPathParameter' - $ref: './tqc_common.yaml#/components/parameters/regexRuleUidPathParameter' - $ref: './tqc_common.yaml#/components/parameters/groupUidPathParameter' - $ref: './tqc_common.yaml#/components/parameters/targetLocaleIdPathParameter' responses: - '200': + 200: description: OK content: application/json: @@ -336,9 +413,15 @@ x-paths: examples: response: value: - response: - code: SUCCESS - data: null + code: SUCCESS + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl @@ -373,6 +456,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/TQCRegexRuleGroupResponse' + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl diff --git a/spec/translation_quality/regex_check_settings_result.yaml b/spec/translation_quality/regex_check_settings_result.yaml index 88c421a0..40bc9ba2 100644 --- a/spec/translation_quality/regex_check_settings_result.yaml +++ b/spec/translation_quality/regex_check_settings_result.yaml @@ -7,7 +7,7 @@ x-paths: - Translation quality checks operationId: createTQCRegexRule parameters: - - &ref_1 + - &ref_2 name: accountUid in: path schema: @@ -16,7 +16,7 @@ x-paths: description: >- The account’s unique identifier. This can be found in the Smartling Dashboard under Account Settings > API. - - &ref_2 + - &ref_3 name: profileUid in: path required: true @@ -28,7 +28,7 @@ x-paths: required: true content: application/json: - schema: &ref_5 + schema: &ref_10 allOf: - &ref_0 type: object @@ -37,7 +37,7 @@ x-paths: type: string description: Rule name example: ruleName - severityLevelCode: &ref_10 + severityLevelCode: &ref_15 enum: - DISABLED - LOW @@ -101,12 +101,12 @@ x-paths: description: OK content: application/json: - schema: &ref_3 + schema: &ref_4 type: object properties: response: allOf: - - &ref_6 + - &ref_11 type: object required: - code @@ -137,7 +137,7 @@ x-paths: type: array items: allOf: - - &ref_7 + - &ref_12 type: object properties: groupUid: @@ -165,6 +165,153 @@ x-paths: - LOW - MEDIUM - HIGH + '400': &ref_5 + description: Provided request parameters are invalid. + content: + application/json: + schema: + type: object + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - VALIDATION_ERROR + type: string + errors: + items: &ref_1 + type: object + properties: + key: + example: general_error + type: string + message: + example: Unexpected server error + type: string + details: + example: {} + type: object + required: + - key + - message + type: array + required: + - code + - errors + type: object + required: + - response + examples: + response: + value: + response: + code: VALIDATION_ERROR + errors: + key: unknown.field + message: >- + The field unknown.parameter was not expected. Please + consult the documentation to verify the fields you are + submitting. + details: unknown.parameter + '401': &ref_6 + description: Provided credentials are not valid. + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - AUTHENTICATION_ERROR + - AUTHORIZATION_ERROR + type: string + errors: + items: *ref_1 + type: array + required: + - code + - errors + type: object + required: + - response + type: object + examples: + response: + value: + response: + code: AUTHENTICATION_ERROR + errors: + details: {} + key: invalid_token + message: Invalid token + '429': &ref_7 + description: Too many simultaneous API requests. + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - MAX_OPERATIONS_LIMIT_EXCEEDED + type: string + errors: + items: *ref_1 + type: array + required: + - code + - errors + type: object + required: + - response + type: object + examples: + response: + value: + response: + code: MAX_OPERATIONS_LIMIT_EXCEEDED + errors: + key: too.many.requests + message: >- + The limit of 10 concurrent Smartling file API + operations for this project has been exceeded. + '500': &ref_8 + description: Unexpected error + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - GENERAL_ERROR + - MAINTENANCE_MODE_ERROR + type: string + errors: + items: *ref_1 + type: array + required: + - code + - errors + type: object + required: + - response + type: object x-code-samples: - lang: curl source: > @@ -179,9 +326,9 @@ x-paths: - Translation quality checks operationId: getTQCRegexRule parameters: - - *ref_1 - *ref_2 - - &ref_4 + - *ref_3 + - &ref_9 name: ruleUid in: path required: true @@ -193,7 +340,11 @@ x-paths: description: OK content: application/json: - schema: *ref_3 + schema: *ref_4 + '400': *ref_5 + '401': *ref_6 + '429': *ref_7 + '500': *ref_8 x-code-samples: - lang: curl source: > @@ -206,21 +357,25 @@ x-paths: - Translation quality checks operationId: updateTQCRegexRule parameters: - - *ref_1 - *ref_2 - - *ref_4 + - *ref_3 + - *ref_9 requestBody: description: '' required: true content: application/json: - schema: *ref_5 + schema: *ref_10 responses: '200': description: OK content: application/json: - schema: *ref_3 + schema: *ref_4 + '400': *ref_5 + '401': *ref_6 + '429': *ref_7 + '500': *ref_8 x-code-samples: - lang: curl source: > @@ -234,21 +389,23 @@ x-paths: - Translation quality checks operationId: deleteTQCRegexRule parameters: - - *ref_1 - *ref_2 - - *ref_4 + - *ref_3 + - *ref_9 responses: '200': description: OK content: application/json: - schema: *ref_6 + schema: *ref_11 examples: response: value: - response: - code: SUCCESS - data: null + code: SUCCESS + '400': *ref_5 + '401': *ref_6 + '429': *ref_7 + '500': *ref_8 x-code-samples: - lang: curl source: > @@ -262,9 +419,9 @@ x-paths: - Translation quality checks operationId: createTQCRegexRuleGroup parameters: - - *ref_1 - *ref_2 - - *ref_4 + - *ref_3 + - *ref_9 requestBody: content: application/json: @@ -284,15 +441,19 @@ x-paths: description: OK content: application/json: - schema: &ref_8 + schema: &ref_13 type: object properties: response: allOf: - - *ref_6 + - *ref_11 - type: object properties: - data: *ref_7 + data: *ref_12 + '400': *ref_5 + '401': *ref_6 + '429': *ref_7 + '500': *ref_8 x-code-samples: - lang: curl source: > @@ -306,9 +467,9 @@ x-paths: - Translation quality checks operationId: getTQCRegexRuleGroups parameters: - - *ref_1 - *ref_2 - - *ref_4 + - *ref_3 + - *ref_9 responses: '200': description: OK @@ -319,7 +480,7 @@ x-paths: properties: response: allOf: - - *ref_6 + - *ref_11 - type: object properties: data: @@ -333,7 +494,11 @@ x-paths: type: array items: allOf: - - *ref_7 + - *ref_12 + '400': *ref_5 + '401': *ref_6 + '429': *ref_7 + '500': *ref_8 x-code-samples: - lang: curl source: > @@ -348,10 +513,10 @@ x-paths: - Translation quality checks operationId: getTQCRegexRuleGroup parameters: - - *ref_1 - *ref_2 - - *ref_4 - - &ref_9 + - *ref_3 + - *ref_9 + - &ref_14 name: groupUid in: path schema: @@ -363,7 +528,11 @@ x-paths: description: OK content: application/json: - schema: *ref_8 + schema: *ref_13 + '400': *ref_5 + '401': *ref_6 + '429': *ref_7 + '500': *ref_8 x-code-samples: - lang: curl source: > @@ -377,22 +546,24 @@ x-paths: - Translation quality checks operationId: deleteTQCRegexRuleGroup parameters: - - *ref_1 - *ref_2 - - *ref_4 + - *ref_3 - *ref_9 + - *ref_14 responses: '200': description: OK content: application/json: - schema: *ref_6 + schema: *ref_11 examples: response: value: - response: - code: SUCCESS - data: null + code: SUCCESS + '400': *ref_5 + '401': *ref_6 + '429': *ref_7 + '500': *ref_8 x-code-samples: - lang: curl source: > @@ -407,19 +578,19 @@ x-paths: - Translation quality checks operationId: updateProfilesCheckRuleSeverityLevel parameters: - - *ref_1 - *ref_2 - - *ref_4 + - *ref_3 + - *ref_9 requestBody: description: '' required: true content: application/json: - schema: &ref_11 + schema: &ref_16 allOf: - type: object properties: - severityLevelCode: *ref_10 + severityLevelCode: *ref_15 required: - severityLevelCode responses: @@ -427,7 +598,11 @@ x-paths: description: OK content: application/json: - schema: *ref_3 + schema: *ref_4 + '400': *ref_5 + '401': *ref_6 + '429': *ref_7 + '500': *ref_8 x-code-samples: - lang: curl source: > @@ -442,10 +617,10 @@ x-paths: - Translation quality checks operationId: addLocaleToProfilesTranslationQualityCheckTypeRegexRuleGroup parameters: - - *ref_1 - *ref_2 - - *ref_4 + - *ref_3 - *ref_9 + - *ref_14 requestBody: description: '' required: true @@ -466,7 +641,11 @@ x-paths: description: OK content: application/json: - schema: *ref_8 + schema: *ref_13 + '400': *ref_5 + '401': *ref_6 + '429': *ref_7 + '500': *ref_8 x-code-samples: - lang: curl source: > @@ -481,9 +660,10 @@ x-paths: - Translation quality checks operationId: deleteLocaleFromTranslationQualityCheckTypeRegexRuleGroup parameters: - - *ref_1 - - *ref_4 + - *ref_2 + - *ref_3 - *ref_9 + - *ref_14 - name: targetLocaleId in: path required: true @@ -495,13 +675,15 @@ x-paths: description: OK content: application/json: - schema: *ref_6 + schema: *ref_11 examples: response: value: - response: - code: SUCCESS - data: null + code: SUCCESS + '400': *ref_5 + '401': *ref_6 + '429': *ref_7 + '500': *ref_8 x-code-samples: - lang: curl source: > @@ -516,22 +698,26 @@ x-paths: - Translation quality checks operationId: updateProfilesCheckRuleGroupSeverityLevel parameters: - - *ref_1 - *ref_2 - - *ref_4 + - *ref_3 - *ref_9 + - *ref_14 requestBody: description: '' required: true content: application/json: - schema: *ref_11 + schema: *ref_16 responses: '200': description: OK content: application/json: - schema: *ref_8 + schema: *ref_13 + '400': *ref_5 + '401': *ref_6 + '429': *ref_7 + '500': *ref_8 x-code-samples: - lang: curl source: > From fdcd58fd0d777bc22b5e0fc69e096277e479d211 Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Mon, 21 Oct 2024 16:48:18 +0300 Subject: [PATCH 02/21] added changes --- spec/api_common.yaml | 16 +- spec/file_translation/fts_common.yaml | 10 +- spec/openapi.yaml | 26 +- .../checks/blacklisted_terms.yaml | 13 +- .../checks/emoji_consistency.yaml | 9 +- .../global_capitalisation_consistency.yaml | 5 +- .../checks/glossary_compliance.yaml | 5 +- .../checks/grammar_check.yaml | 5 +- .../checks/insertable_consistency.yaml | 5 +- .../checks/leading_trailing_spaces.yaml | 5 +- .../checks/non_translatable_text.yaml | 5 +- .../checks/number_consistency.yaml | 6 +- .../checks/open_issues.yaml | 5 +- .../checks/original_equals_target.yaml | 5 +- .../checks/plurals_repetition.yaml | 5 +- .../checks/punctuation_consistency.yaml | 5 +- .../checks/regex_check.yaml | 8 +- .../checks/repeated_word.yaml | 7 +- .../checks/segment_completeness.yaml | 5 +- .../checks/source_in_wrong_language.yaml | 5 +- .../checks/spellcheck.yaml | 5 +- .../checks/tag_consistency.yaml | 5 +- .../checks/target_in_wrong_language.yaml | 5 +- .../checks/target_length_limit.yaml | 5 +- .../checks/target_source_consistency.yaml | 5 +- .../checks/trademark_consistency.yaml | 5 +- .../checks/whitespaces.yaml | 5 +- .../regex_check_settings_result.yaml | 26 +- spec/translation_quality/tqc_check.yaml | 11 + .../translation_quality/tqc_check_result.yaml | 339 ++++++++++++------ spec/translation_quality/tqc_common.yaml | 1 + 31 files changed, 367 insertions(+), 200 deletions(-) diff --git a/spec/api_common.yaml b/spec/api_common.yaml index 3d5fccc3..f1aee412 100644 --- a/spec/api_common.yaml +++ b/spec/api_common.yaml @@ -232,7 +232,7 @@ components: The field unknown.parameter was not expected. Please consult the documentation to verify the fields you are submitting. - details: unknown.parameter + details: {} Error401ResponseDefinition: description: Provided credentials are not valid. @@ -246,9 +246,9 @@ components: response: code: AUTHENTICATION_ERROR errors: - details: {} - key: invalid_token - message: Invalid token + - key: invalid_token + details: {} + message: Invalid token Error429ResponseDefinition: description: Too many simultaneous API requests. @@ -262,10 +262,10 @@ components: response: code: MAX_OPERATIONS_LIMIT_EXCEEDED errors: - key: too.many.requests - message: >- - The limit of 10 concurrent Smartling file API - operations for this project has been exceeded. + - key: too.many.requests + message: >- + The limit of 10 concurrent Smartling file API + operations for this project has been exceeded. Error500ResponseDefinition: description: Unexpected error diff --git a/spec/file_translation/fts_common.yaml b/spec/file_translation/fts_common.yaml index d2e20efa..c9de7969 100644 --- a/spec/file_translation/fts_common.yaml +++ b/spec/file_translation/fts_common.yaml @@ -121,8 +121,8 @@ components: response: code: VALIDATION_ERROR errors: - key: not.found - message: >- - mtUid jtcorrr3 not found - details: - mtUid: jtcorrr3 + - key: not.found + message: >- + mtUid jtcorrr3 not found + details: + mtUid: jtcorrr3 diff --git a/spec/openapi.yaml b/spec/openapi.yaml index 325fd719..b3b3abea 100644 --- a/spec/openapi.yaml +++ b/spec/openapi.yaml @@ -13922,12 +13922,12 @@ components: response: code: VALIDATION_ERROR errors: - key: unknown.field - message: >- - The field unknown.parameter was not expected. Please - consult the documentation to verify the fields you are - submitting. - details: unknown.parameter + - key: unknown.field + message: >- + The field unknown.parameter was not expected. Please + consult the documentation to verify the fields you are + submitting. + details: unknown.parameter Error401ResponseDefinition: description: Provided credentials are not valid. @@ -13941,9 +13941,9 @@ components: response: code: AUTHENTICATION_ERROR errors: - details: {} - key: invalid_token - message: Invalid token + - key: invalid_token + details: {} + message: Invalid token Error429ResponseDefinition: description: Too many simultaneous API requests. @@ -13957,10 +13957,10 @@ components: response: code: MAX_OPERATIONS_LIMIT_EXCEEDED errors: - key: too.many.requests - message: >- - The limit of 10 concurrent Smartling file API - operations for this project has been exceeded. + - key: too.many.requests + message: >- + The limit of 10 concurrent Smartling file API + operations for this project has been exceeded. Error500ResponseDefinition: description: Unexpected error diff --git a/spec/translation_quality/checks/blacklisted_terms.yaml b/spec/translation_quality/checks/blacklisted_terms.yaml index 508bd6bb..5212c51f 100644 --- a/spec/translation_quality/checks/blacklisted_terms.yaml +++ b/spec/translation_quality/checks/blacklisted_terms.yaml @@ -40,8 +40,8 @@ components: TqcCheckMistakeDTO: title: BLACKLISTED_TERMS allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -52,6 +52,7 @@ components: example: "BLACKLISTED_TERMS" details: type: object + nullable: true properties: blacklistedTermUid: type: string @@ -128,10 +129,10 @@ components: - "from": 0 "to": 14 "details": - - "blacklistedTermUid": "uidgj1" - "termText": "blacklist_term" - "alternatives": [] - "notes": "" + "blacklistedTermUid": "uidgj1" + "termText": "blacklist_term" + "alternatives": [] + "notes": "" "positionTypeCode": "TARGET" dictionary_checkTypes_response_example: diff --git a/spec/translation_quality/checks/emoji_consistency.yaml b/spec/translation_quality/checks/emoji_consistency.yaml index c666ac1c..a80575b7 100644 --- a/spec/translation_quality/checks/emoji_consistency.yaml +++ b/spec/translation_quality/checks/emoji_consistency.yaml @@ -91,8 +91,8 @@ components: TqcCheckMistakeDTO: title: EMOJI_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -102,6 +102,7 @@ components: description: check type code example: "EMOJI_CONSISTENCY" details: + nullable: true type: object properties: emoji: @@ -172,8 +173,8 @@ components: - "from": 14 "to": 16 "details": - - "emoji": "😀" - "type": "EMOJI_DELETED" + "emoji": "😀" + "type": "EMOJI_DELETED" "positionTypeCode": "SOURCE" accounts_check_types_settings_example: diff --git a/spec/translation_quality/checks/global_capitalisation_consistency.yaml b/spec/translation_quality/checks/global_capitalisation_consistency.yaml index 5d00abeb..2b8f4b66 100644 --- a/spec/translation_quality/checks/global_capitalisation_consistency.yaml +++ b/spec/translation_quality/checks/global_capitalisation_consistency.yaml @@ -40,8 +40,8 @@ components: TqcCheckMistakeDTO: title: GLOBAL_CAPITALISATION_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -51,6 +51,7 @@ components: description: check type code example: "GLOBAL_CAPITALISATION_CONSISTENCY" details: + nullable: true type: object positionTypeCode: type: string diff --git a/spec/translation_quality/checks/glossary_compliance.yaml b/spec/translation_quality/checks/glossary_compliance.yaml index c6394fb0..a69469f5 100644 --- a/spec/translation_quality/checks/glossary_compliance.yaml +++ b/spec/translation_quality/checks/glossary_compliance.yaml @@ -116,8 +116,8 @@ components: TqcCheckMistakeDTO: title: GLOSSARY_COMPLIANCE allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -128,6 +128,7 @@ components: example: "GLOSSARY_COMPLIANCE" details: type: object + nullable: true properties: glossaryTerm: type: object diff --git a/spec/translation_quality/checks/grammar_check.yaml b/spec/translation_quality/checks/grammar_check.yaml index c6498b5b..0ec3261a 100644 --- a/spec/translation_quality/checks/grammar_check.yaml +++ b/spec/translation_quality/checks/grammar_check.yaml @@ -40,8 +40,8 @@ components: TqcCheckMistakeDTO: title: GRAMMAR_CHECK allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -51,6 +51,7 @@ components: description: check type code example: "GRAMMAR_CHECK" details: + nullable: true type: object properties: text: diff --git a/spec/translation_quality/checks/insertable_consistency.yaml b/spec/translation_quality/checks/insertable_consistency.yaml index 36ec57e6..471e5409 100644 --- a/spec/translation_quality/checks/insertable_consistency.yaml +++ b/spec/translation_quality/checks/insertable_consistency.yaml @@ -64,8 +64,8 @@ components: TqcCheckMistakeDTO: title: INSERTABLE_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -76,6 +76,7 @@ components: example: "INSERTABLE_CONSISTENCY" details: type: object + nullable: true properties: insertable: type: string diff --git a/spec/translation_quality/checks/leading_trailing_spaces.yaml b/spec/translation_quality/checks/leading_trailing_spaces.yaml index 99ccfda7..52e133c5 100644 --- a/spec/translation_quality/checks/leading_trailing_spaces.yaml +++ b/spec/translation_quality/checks/leading_trailing_spaces.yaml @@ -55,8 +55,8 @@ components: TqcCheckMistakeDTO: title: LEADING_TRAILING_SPACES allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -67,6 +67,7 @@ components: example: "LEADING_TRAILING_SPACES" details: type: object + nullable: true positionTypeCode: type: string enum: diff --git a/spec/translation_quality/checks/non_translatable_text.yaml b/spec/translation_quality/checks/non_translatable_text.yaml index 150ec000..4148116b 100644 --- a/spec/translation_quality/checks/non_translatable_text.yaml +++ b/spec/translation_quality/checks/non_translatable_text.yaml @@ -68,8 +68,8 @@ components: TqcCheckMistakeDTO: title: NON_TRANSLATABLE_TEXT allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -80,6 +80,7 @@ components: example: "NON_TRANSLATABLE_TEXT" details: type: object + nullable: true properties: placeable: type: string diff --git a/spec/translation_quality/checks/number_consistency.yaml b/spec/translation_quality/checks/number_consistency.yaml index dca05d2f..355bec0b 100644 --- a/spec/translation_quality/checks/number_consistency.yaml +++ b/spec/translation_quality/checks/number_consistency.yaml @@ -86,8 +86,8 @@ components: TqcCheckMistakeDTO: title: NUMBER_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -97,6 +97,8 @@ components: description: check type code example: "NUMBER_CONSISTENCY" details: + type: object + nullable: true oneOf: - type: object title: NUMBER_ADDED diff --git a/spec/translation_quality/checks/open_issues.yaml b/spec/translation_quality/checks/open_issues.yaml index 0ce49445..1f4a901f 100644 --- a/spec/translation_quality/checks/open_issues.yaml +++ b/spec/translation_quality/checks/open_issues.yaml @@ -72,8 +72,8 @@ components: TqcCheckMistakeDTO: title: OPEN_ISSUES allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -83,6 +83,7 @@ components: description: check type code example: "OPEN_ISSUES" details: + nullable: true type: object properties: sourceIssuesCount: diff --git a/spec/translation_quality/checks/original_equals_target.yaml b/spec/translation_quality/checks/original_equals_target.yaml index 0c86eb77..ee02618a 100644 --- a/spec/translation_quality/checks/original_equals_target.yaml +++ b/spec/translation_quality/checks/original_equals_target.yaml @@ -73,8 +73,8 @@ components: TqcCheckMistakeDTO: title: ORIGINAL_EQUALS_TARGET allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -84,6 +84,7 @@ components: description: check type code example: "ORIGINAL_EQUALS_TARGET" details: + nullable: true type: object properties: types: diff --git a/spec/translation_quality/checks/plurals_repetition.yaml b/spec/translation_quality/checks/plurals_repetition.yaml index 20ec306a..b93a61a1 100644 --- a/spec/translation_quality/checks/plurals_repetition.yaml +++ b/spec/translation_quality/checks/plurals_repetition.yaml @@ -40,8 +40,8 @@ components: TqcCheckMistakeDTO: title: PLURALS_REPETITION allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -51,6 +51,7 @@ components: description: check type code example: "PLURALS_REPETITION" details: + nullable: true type: object properties: pluralFormGroupUid: diff --git a/spec/translation_quality/checks/punctuation_consistency.yaml b/spec/translation_quality/checks/punctuation_consistency.yaml index 91085118..66c5de93 100644 --- a/spec/translation_quality/checks/punctuation_consistency.yaml +++ b/spec/translation_quality/checks/punctuation_consistency.yaml @@ -40,8 +40,8 @@ components: TqcCheckMistakeDTO: title: PUNCTUATION_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -51,6 +51,7 @@ components: description: check type code example: "PUNCTUATION_CONSISTENCY" details: + nullable: true type: object positionTypeCode: type: string diff --git a/spec/translation_quality/checks/regex_check.yaml b/spec/translation_quality/checks/regex_check.yaml index 3db2d764..95a145eb 100644 --- a/spec/translation_quality/checks/regex_check.yaml +++ b/spec/translation_quality/checks/regex_check.yaml @@ -38,8 +38,8 @@ components: TqcCheckMistakeDTO: title: REGEX_CHECK allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -49,7 +49,9 @@ components: description: check type code example: "REGEX_CHECK" details: - - ref: '../tqc_common.yaml#/components/schemas/regexRuleWithRuleUid' + type: object + nullable: true + $ref: './tqc_common.yaml#/components/schemas/regexRuleWithRuleUid' positionTypeCode: type: string enum: diff --git a/spec/translation_quality/checks/repeated_word.yaml b/spec/translation_quality/checks/repeated_word.yaml index ad0c66f7..c7eb4878 100644 --- a/spec/translation_quality/checks/repeated_word.yaml +++ b/spec/translation_quality/checks/repeated_word.yaml @@ -40,8 +40,8 @@ components: TqcCheckMistakeDTO: title: REPEATED_WORD allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -51,6 +51,7 @@ components: description: check type code example: "REPEATED_WORD" details: + nullable: true type: object properties: word: @@ -116,7 +117,7 @@ components: "from": 5 "to": 9 "details": - - "word": "Hello" + "word": "Hello" "positionTypeCode": "TARGET" dictionary_checkTypes_response_example: diff --git a/spec/translation_quality/checks/segment_completeness.yaml b/spec/translation_quality/checks/segment_completeness.yaml index 7ef6639f..a0250b79 100644 --- a/spec/translation_quality/checks/segment_completeness.yaml +++ b/spec/translation_quality/checks/segment_completeness.yaml @@ -95,8 +95,8 @@ components: TqcCheckMistakeDTO: title: SEGMENT_COMPLETENESS allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -107,6 +107,7 @@ components: example: "SEGMENT_COMPLETENESS" details: type: object + nullable: true properties: type: type: string diff --git a/spec/translation_quality/checks/source_in_wrong_language.yaml b/spec/translation_quality/checks/source_in_wrong_language.yaml index 7ac61678..db1eb10b 100644 --- a/spec/translation_quality/checks/source_in_wrong_language.yaml +++ b/spec/translation_quality/checks/source_in_wrong_language.yaml @@ -65,8 +65,8 @@ components: TqcCheckMistakeDTO: title: SOURCE_IN_WRONG_LANGUAGE allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -76,6 +76,7 @@ components: description: check type code example: "SOURCE_IN_WRONG_LANGUAGE" details: + nullable: true type: object positionTypeCode: type: string diff --git a/spec/translation_quality/checks/spellcheck.yaml b/spec/translation_quality/checks/spellcheck.yaml index a1eab089..7958dc94 100644 --- a/spec/translation_quality/checks/spellcheck.yaml +++ b/spec/translation_quality/checks/spellcheck.yaml @@ -94,8 +94,8 @@ components: TqcCheckMistakeDTO: title: SPELLCHECK allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -106,6 +106,7 @@ components: example: "SPELLCHECK" details: type: object + nullable: true properties: word: type: string diff --git a/spec/translation_quality/checks/tag_consistency.yaml b/spec/translation_quality/checks/tag_consistency.yaml index ba0eaf43..08f44861 100644 --- a/spec/translation_quality/checks/tag_consistency.yaml +++ b/spec/translation_quality/checks/tag_consistency.yaml @@ -67,8 +67,8 @@ components: TqcCheckMistakeDTO: title: TAG_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -79,6 +79,7 @@ components: example: "TAG_CONSISTENCY" details: type: object + nullable: true properties: tag: type: string diff --git a/spec/translation_quality/checks/target_in_wrong_language.yaml b/spec/translation_quality/checks/target_in_wrong_language.yaml index 9a9c7d4c..480309e3 100644 --- a/spec/translation_quality/checks/target_in_wrong_language.yaml +++ b/spec/translation_quality/checks/target_in_wrong_language.yaml @@ -66,8 +66,8 @@ components: TqcCheckMistakeDTO: title: TARGET_IN_WRONG_LANGUAGE allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -78,6 +78,7 @@ components: example: "TARGET_IN_WRONG_LANGUAGE" details: type: object + nullable: true positionTypeCode: type: string enum: diff --git a/spec/translation_quality/checks/target_length_limit.yaml b/spec/translation_quality/checks/target_length_limit.yaml index 04219c73..8d2dc9d4 100644 --- a/spec/translation_quality/checks/target_length_limit.yaml +++ b/spec/translation_quality/checks/target_length_limit.yaml @@ -40,8 +40,8 @@ components: TqcCheckMistakeDTO: title: TARGET_LENGTH_LIMIT allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -52,6 +52,7 @@ components: example: "TARGET_LENGTH_LIMIT" details: type: object + nullable: true positionTypeCode: type: string enum: diff --git a/spec/translation_quality/checks/target_source_consistency.yaml b/spec/translation_quality/checks/target_source_consistency.yaml index 587acac9..d6a5076d 100644 --- a/spec/translation_quality/checks/target_source_consistency.yaml +++ b/spec/translation_quality/checks/target_source_consistency.yaml @@ -92,8 +92,8 @@ components: TqcCheckMistakeDTO: title: TARGET_SOURCE_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -104,6 +104,7 @@ components: example: "TARGET_SOURCE_CONSISTENCY" details: type: object + nullable: true properties: type: type: string diff --git a/spec/translation_quality/checks/trademark_consistency.yaml b/spec/translation_quality/checks/trademark_consistency.yaml index 6017763e..5392de52 100644 --- a/spec/translation_quality/checks/trademark_consistency.yaml +++ b/spec/translation_quality/checks/trademark_consistency.yaml @@ -40,8 +40,8 @@ components: TqcCheckMistakeDTO: title: TRADEMARK_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -52,6 +52,7 @@ components: example: "TRADEMARK_CONSISTENCY" details: type: object + nullable: true properties: trademarkTypeCode: type: string diff --git a/spec/translation_quality/checks/whitespaces.yaml b/spec/translation_quality/checks/whitespaces.yaml index 2d664823..c0462dd6 100644 --- a/spec/translation_quality/checks/whitespaces.yaml +++ b/spec/translation_quality/checks/whitespaces.yaml @@ -40,8 +40,8 @@ components: TqcCheckMistakeDTO: title: WHITESPACES allOf: - - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -52,6 +52,7 @@ components: example: "WHITESPACES" details: type: object + nullable: true positionTypeCode: type: string enum: diff --git a/spec/translation_quality/regex_check_settings_result.yaml b/spec/translation_quality/regex_check_settings_result.yaml index 40bc9ba2..75aa7aa6 100644 --- a/spec/translation_quality/regex_check_settings_result.yaml +++ b/spec/translation_quality/regex_check_settings_result.yaml @@ -210,12 +210,12 @@ x-paths: response: code: VALIDATION_ERROR errors: - key: unknown.field - message: >- - The field unknown.parameter was not expected. Please - consult the documentation to verify the fields you are - submitting. - details: unknown.parameter + - key: unknown.field + message: >- + The field unknown.parameter was not expected. Please + consult the documentation to verify the fields you + are submitting. + details: unknown.parameter '401': &ref_6 description: Provided credentials are not valid. content: @@ -248,9 +248,9 @@ x-paths: response: code: AUTHENTICATION_ERROR errors: - details: {} - key: invalid_token - message: Invalid token + - key: invalid_token + details: {} + message: Invalid token '429': &ref_7 description: Too many simultaneous API requests. content: @@ -282,10 +282,10 @@ x-paths: response: code: MAX_OPERATIONS_LIMIT_EXCEEDED errors: - key: too.many.requests - message: >- - The limit of 10 concurrent Smartling file API - operations for this project has been exceeded. + - key: too.many.requests + message: >- + The limit of 10 concurrent Smartling file API + operations for this project has been exceeded. '500': &ref_8 description: Unexpected error content: diff --git a/spec/translation_quality/tqc_check.yaml b/spec/translation_quality/tqc_check.yaml index 7c53c6af..ded54bae 100644 --- a/spec/translation_quality/tqc_check.yaml +++ b/spec/translation_quality/tqc_check.yaml @@ -30,6 +30,14 @@ x-paths: $ref: '#/components/schemas/TqcCheckResponse' examples: $ref: './examples.yaml#/components/examples/tqc_check_response_example' + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl @@ -93,6 +101,7 @@ components: properties: stringUid: type: string + nullable: true description: it is string part unique identifier if string is splitted on several parts example: "" originalString: @@ -109,10 +118,12 @@ components: example: "7191152182c69d9b72069ac1290fe24b" pluralFormGroupUid: type: string + nullable: true description: unique identifier of plural form example: "7191152182c69d9b72069ac1290fe24b" pluralForm: type: string + nullable: true description: plural form example: "FEW" mistakes: diff --git a/spec/translation_quality/tqc_check_result.yaml b/spec/translation_quality/tqc_check_result.yaml index 3300aa95..c3eaa7e1 100644 --- a/spec/translation_quality/tqc_check_result.yaml +++ b/spec/translation_quality/tqc_check_result.yaml @@ -90,6 +90,7 @@ x-paths: properties: pluralFormGroupUid: type: string + nullable: true description: unique identifier of plural form example: 7191152182c69d9b72069ac1290fe24b - type: object @@ -196,6 +197,7 @@ x-paths: properties: stringUid: type: string + nullable: true description: >- it is string part unique identifier if string is splitted on several parts @@ -214,10 +216,12 @@ x-paths: example: 7191152182c69d9b72069ac1290fe24b pluralFormGroupUid: type: string + nullable: true description: unique identifier of plural form example: 7191152182c69d9b72069ac1290fe24b pluralForm: type: string + nullable: true description: plural form example: FEW mistakes: @@ -226,10 +230,8 @@ x-paths: oneOf: - title: BLACKLISTED_TERMS allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -240,6 +242,7 @@ x-paths: example: BLACKLISTED_TERMS details: type: object + nullable: true properties: blacklistedTermUid: type: string @@ -266,10 +269,8 @@ x-paths: example: TARGET - title: EMOJI_CONSISTENCY allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -279,6 +280,7 @@ x-paths: description: check type code example: EMOJI_CONSISTENCY details: + nullable: true type: object properties: emoji: @@ -302,10 +304,8 @@ x-paths: example: SOURCE - title: GLOBAL_CAPITALISATION_CONSISTENCY allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -315,6 +315,7 @@ x-paths: description: check type code example: GLOBAL_CAPITALISATION_CONSISTENCY details: + nullable: true type: object positionTypeCode: type: string @@ -324,10 +325,8 @@ x-paths: example: TARGET - title: GLOSSARY_COMPLIANCE allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -338,6 +337,7 @@ x-paths: example: GLOSSARY_COMPLIANCE details: type: object + nullable: true properties: glossaryTerm: type: object @@ -446,10 +446,8 @@ x-paths: example: SOURCE - title: GRAMMAR_CHECK allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -459,6 +457,7 @@ x-paths: description: check type code example: GRAMMAR_CHECK details: + nullable: true type: object properties: text: @@ -493,10 +492,8 @@ x-paths: example: TARGET - title: INSERTABLE_CONSISTENCY allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -507,6 +504,7 @@ x-paths: example: INSERTABLE_CONSISTENCY details: type: object + nullable: true properties: insertable: type: string @@ -532,10 +530,8 @@ x-paths: example: SOURCE - title: LEADING_TRAILING_SPACES allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -546,6 +542,7 @@ x-paths: example: LEADING_TRAILING_SPACES details: type: object + nullable: true positionTypeCode: type: string enum: @@ -554,10 +551,8 @@ x-paths: example: TARGET - title: NON_TRANSLATABLE_TEXT allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -568,6 +563,7 @@ x-paths: example: NON_TRANSLATABLE_TEXT details: type: object + nullable: true properties: placeable: type: string @@ -591,10 +587,8 @@ x-paths: example: SOURCE - title: NUMBER_CONSISTENCY allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -604,6 +598,8 @@ x-paths: description: check type code example: NUMBER_CONSISTENCY details: + type: object + nullable: true oneOf: - type: object title: NUMBER_ADDED @@ -654,10 +650,8 @@ x-paths: example: SOURCE - title: ORIGINAL_EQUALS_TARGET allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -667,6 +661,7 @@ x-paths: description: check type code example: ORIGINAL_EQUALS_TARGET details: + nullable: true type: object properties: types: @@ -687,10 +682,8 @@ x-paths: example: TARGET - title: REPEATED_WORD allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -700,6 +693,7 @@ x-paths: description: check type code example: REPEATED_WORD details: + nullable: true type: object properties: word: @@ -714,10 +708,8 @@ x-paths: example: TARGET - title: SEGMENT_COMPLETENESS allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -728,6 +720,7 @@ x-paths: example: SEGMENT_COMPLETENESS details: type: object + nullable: true properties: type: type: string @@ -745,10 +738,8 @@ x-paths: example: TARGET - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -758,6 +749,7 @@ x-paths: description: check type code example: SOURCE_IN_WRONG_LANGUAGE details: + nullable: true type: object positionTypeCode: type: string @@ -767,10 +759,8 @@ x-paths: example: SOURCE - title: SPELLCHECK allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -781,6 +771,7 @@ x-paths: example: SPELLCHECK details: type: object + nullable: true properties: word: type: string @@ -802,10 +793,8 @@ x-paths: example: TARGET - title: TAG_CONSISTENCY allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -816,6 +805,7 @@ x-paths: example: TAG_CONSISTENCY details: type: object + nullable: true properties: tag: type: string @@ -838,10 +828,8 @@ x-paths: example: SOURCE - title: TARGET_IN_WRONG_LANGUAGE allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -852,6 +840,7 @@ x-paths: example: TARGET_IN_WRONG_LANGUAGE details: type: object + nullable: true positionTypeCode: type: string enum: @@ -860,10 +849,8 @@ x-paths: example: TARGET - title: TARGET_LENGTH_LIMIT allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -874,6 +861,7 @@ x-paths: example: TARGET_LENGTH_LIMIT details: type: object + nullable: true positionTypeCode: type: string enum: @@ -882,10 +870,8 @@ x-paths: example: TARGET - title: TARGET_SOURCE_CONSISTENCY allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -896,6 +882,7 @@ x-paths: example: TARGET_SOURCE_CONSISTENCY details: type: object + nullable: true properties: type: type: string @@ -920,10 +907,8 @@ x-paths: example: TARGET - title: TRADEMARK_CONSISTENCY allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -934,6 +919,7 @@ x-paths: example: TRADEMARK_CONSISTENCY details: type: object + nullable: true properties: trademarkTypeCode: type: string @@ -952,10 +938,8 @@ x-paths: example: SOURCE - title: WHITESPACES allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -966,6 +950,7 @@ x-paths: example: WHITESPACES details: type: object + nullable: true positionTypeCode: type: string enum: @@ -974,10 +959,8 @@ x-paths: example: TARGET - title: PUNCTUATION_CONSISTENCY allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -987,6 +970,7 @@ x-paths: description: check type code example: PUNCTUATION_CONSISTENCY details: + nullable: true type: object positionTypeCode: type: string @@ -996,10 +980,8 @@ x-paths: example: SOURCE - title: PLURALS_REPETITION allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -1009,6 +991,7 @@ x-paths: description: check type code example: PLURALS_REPETITION details: + nullable: true type: object properties: pluralFormGroupUid: @@ -1028,10 +1011,8 @@ x-paths: example: TARGET - title: REGEX_CHECK allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -1041,8 +1022,10 @@ x-paths: description: check type code example: REGEX_CHECK details: - - $ref: >- - ./tqc_common.yaml#/components/schemas/regexRuleWithRuleUid + type: object + nullable: true + $ref: >- + ./tqc_common.yaml#/components/schemas/regexRuleWithRuleUid positionTypeCode: type: string enum: @@ -1051,10 +1034,8 @@ x-paths: example: TARGET - title: OPEN_ISSUES allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: @@ -1064,6 +1045,7 @@ x-paths: description: check type code example: OPEN_ISSUES details: + nullable: true type: object properties: sourceIssuesCount: @@ -1101,10 +1083,10 @@ x-paths: - from: 0 to: 14 details: - - blacklistedTermUid: uidgj1 - termText: blacklist_term - alternatives: [] - notes: '' + blacklistedTermUid: uidgj1 + termText: blacklist_term + alternatives: [] + notes: '' positionTypeCode: TARGET EMOJI_CONSISTENCY: value: @@ -1126,8 +1108,8 @@ x-paths: - from: 14 to: 16 details: - - emoji: 😀 - type: EMOJI_DELETED + emoji: 😀 + type: EMOJI_DELETED positionTypeCode: SOURCE GLOBAL_CAPITALISATION_CONSISTENCY: value: @@ -1318,7 +1300,7 @@ x-paths: from: 5 to: 9 details: - - word: Hello + word: Hello positionTypeCode: TARGET SEGMENT_COMPLETENESS: value: @@ -1675,6 +1657,153 @@ x-paths: sourceIssuesCount: 5 translationIssuesCount: 3 positionTypeCode: TARGET + '400': + description: Provided request parameters are invalid. + content: + application/json: + schema: + type: object + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - VALIDATION_ERROR + type: string + errors: + items: &ref_0 + type: object + properties: + key: + example: general_error + type: string + message: + example: Unexpected server error + type: string + details: + example: {} + type: object + required: + - key + - message + type: array + required: + - code + - errors + type: object + required: + - response + examples: + response: + value: + response: + code: VALIDATION_ERROR + errors: + - key: unknown.field + message: >- + The field unknown.parameter was not expected. Please + consult the documentation to verify the fields you + are submitting. + details: unknown.parameter + '401': + description: Provided credentials are not valid. + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - AUTHENTICATION_ERROR + - AUTHORIZATION_ERROR + type: string + errors: + items: *ref_0 + type: array + required: + - code + - errors + type: object + required: + - response + type: object + examples: + response: + value: + response: + code: AUTHENTICATION_ERROR + errors: + - key: invalid_token + details: {} + message: Invalid token + '429': + description: Too many simultaneous API requests. + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - MAX_OPERATIONS_LIMIT_EXCEEDED + type: string + errors: + items: *ref_0 + type: array + required: + - code + - errors + type: object + required: + - response + type: object + examples: + response: + value: + response: + code: MAX_OPERATIONS_LIMIT_EXCEEDED + errors: + - key: too.many.requests + message: >- + The limit of 10 concurrent Smartling file API + operations for this project has been exceeded. + '500': + description: Unexpected error + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - GENERAL_ERROR + - MAINTENANCE_MODE_ERROR + type: string + errors: + items: *ref_0 + type: array + required: + - code + - errors + type: object + required: + - response + type: object x-code-samples: - lang: curl source: > diff --git a/spec/translation_quality/tqc_common.yaml b/spec/translation_quality/tqc_common.yaml index 2cd07465..71b3e9ba 100644 --- a/spec/translation_quality/tqc_common.yaml +++ b/spec/translation_quality/tqc_common.yaml @@ -489,6 +489,7 @@ components: properties: pluralFormGroupUid: type: string + nullable: true description: unique identifier of plural form example: "7191152182c69d9b72069ac1290fe24b" From 15097f8d37e034302c2ae514b7c395f4b0b3687a Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Mon, 21 Oct 2024 17:51:43 +0300 Subject: [PATCH 03/21] addded changes --- spec/api_common.yaml | 12 +- spec/issues/account_issue_sub_types.yaml | 44 +- spec/issues/dictionaries.yaml | 38 +- spec/issues/issue_comments.yaml | 50 +- spec/issues/issue_watchers.yaml | 58 ++- spec/issues/issues_common.yaml | 130 +++++- spec/issues/webhooks/examples.yaml | 2 +- spec/issues/webhooks/settings.yaml | 40 +- spec/openapi.yaml | 2 +- .../translation_quality/account_settings.yaml | 118 ++++- .../account_settings_result.yaml | 345 ++++++++++---- .../check_type_severity_level.yaml | 36 +- .../check_type_severity_level_result.yaml | 201 +++++++- spec/translation_quality/checks/accounts.yaml | 45 +- .../checks/accounts_result.yaml | 431 ++++++++++++------ spec/translation_quality/dictionaries.yaml | 90 +++- .../dictionaries_result.yaml | 227 ++++++++- spec/translation_quality/profiles.yaml | 70 ++- spec/translation_quality/profiles_result.yaml | 233 ++++++++-- .../regex_check_settings_result.yaml | 2 +- .../translation_quality/tqc_check_result.yaml | 2 +- spec/translation_quality/tqc_common.yaml | 1 - 22 files changed, 1801 insertions(+), 376 deletions(-) diff --git a/spec/api_common.yaml b/spec/api_common.yaml index f1aee412..025956ff 100644 --- a/spec/api_common.yaml +++ b/spec/api_common.yaml @@ -227,12 +227,12 @@ components: response: code: VALIDATION_ERROR errors: - key: unknown.field - message: >- - The field unknown.parameter was not expected. Please - consult the documentation to verify the fields you are - submitting. - details: {} + - key: unknown.field + message: >- + The field unknown.parameter was not expected. Please + consult the documentation to verify the fields you are + submitting. + details: {} Error401ResponseDefinition: description: Provided credentials are not valid. diff --git a/spec/issues/account_issue_sub_types.yaml b/spec/issues/account_issue_sub_types.yaml index 3b489d6e..200138f0 100644 --- a/spec/issues/account_issue_sub_types.yaml +++ b/spec/issues/account_issue_sub_types.yaml @@ -26,7 +26,7 @@ x-paths: $ref: '#/components/schemas/AccountIssueSubtypeModel' required: true responses: - '200': + 200: content: application/json: examples: @@ -40,6 +40,14 @@ x-paths: schema: $ref: '#/components/schemas/AccountIssueSubTypeResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -81,7 +89,7 @@ x-paths: $ref: '#/components/schemas/AccountIssueSubtypeDescriptionField' required: true responses: - '200': + 200: content: application/json: examples: @@ -95,6 +103,14 @@ x-paths: schema: $ref: '#/components/schemas/AccountIssueSubTypeResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -126,7 +142,7 @@ x-paths: schema: type: string responses: - '200': + 200: description: OK content: application/json: @@ -135,9 +151,15 @@ x-paths: examples: response: value: - response: - code: SUCCESS - data: null + code: SUCCESS + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -178,7 +200,7 @@ x-paths: $ref: '#/components/schemas/AccountIssueSubtypeStateField' required: true responses: - '200': + 200: content: application/json: examples: @@ -191,6 +213,14 @@ x-paths: schema: $ref: '#/components/schemas/AccountIssueSubTypeStateResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > diff --git a/spec/issues/dictionaries.yaml b/spec/issues/dictionaries.yaml index d56749f2..35c676fc 100644 --- a/spec/issues/dictionaries.yaml +++ b/spec/issues/dictionaries.yaml @@ -11,7 +11,7 @@ x-paths: - Issues operationId: getAllIssuesStates responses: - '200': + 200: content: application/json: examples: @@ -29,6 +29,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueStatesResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -64,6 +72,14 @@ x-paths: - description: High issueSeverityLevelCode: HIGH totalCount: 3 + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -124,6 +140,14 @@ x-paths: - description: MT Error issueSubTypeCode: MT_ERROR totalCount: 2 + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -145,7 +169,7 @@ x-paths: - Issues operationId: getAllIssueTypes responses: - '200': + 200: content: application/json: examples: @@ -179,6 +203,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueTypesResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' components: schemas: @@ -310,6 +342,7 @@ components: - TRANSLATION type: string subTypes: + type: array properties: description: description: Issue subtype description @@ -326,7 +359,6 @@ components: - CUSTOM - MT_ERROR type: string - type: object type: object type: array totalCount: diff --git a/spec/issues/issue_comments.yaml b/spec/issues/issue_comments.yaml index 7168dcb8..b87dab31 100644 --- a/spec/issues/issue_comments.yaml +++ b/spec/issues/issue_comments.yaml @@ -26,7 +26,7 @@ x-paths: schema: type: string responses: - '200': + 200: content: application/json: examples: @@ -44,6 +44,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueCommentsGetResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -83,7 +91,7 @@ x-paths: $ref: '#/components/schemas/CommentRequest' required: true responses: - '200': + 200: content: application/json: examples: @@ -99,6 +107,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueCommentAddResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -151,7 +167,7 @@ x-paths: $ref: '#/components/schemas/CommentRequest' required: true responses: - '200': + 200: content: application/json: examples: @@ -168,6 +184,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueCommentEditResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -206,7 +230,7 @@ x-paths: schema: type: string responses: - '200': + 200: content: application/json: examples: @@ -222,6 +246,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueCommentGetResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -258,7 +290,7 @@ x-paths: schema: type: string responses: - '200': + 200: content: application/json: examples: @@ -269,6 +301,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueCommentDeleteResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > diff --git a/spec/issues/issue_watchers.yaml b/spec/issues/issue_watchers.yaml index 106f4855..894d1cb8 100644 --- a/spec/issues/issue_watchers.yaml +++ b/spec/issues/issue_watchers.yaml @@ -34,7 +34,7 @@ x-paths: default: 0 type: number responses: - '200': + 200: content: application/json: examples: @@ -54,6 +54,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueGetWatchersResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -98,6 +106,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueWatcherResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -132,7 +148,7 @@ x-paths: $ref: '#/components/schemas/WatcherRequest' required: true responses: - '200': + 200: content: application/json: examples: @@ -150,6 +166,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueWatcherResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -194,7 +218,7 @@ x-paths: schema: type: string responses: - '200': + 200: content: application/json: examples: @@ -205,6 +229,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueWatcherAssignResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -246,7 +278,7 @@ x-paths: schema: type: string responses: - '200': + 200: content: application/json: examples: @@ -257,6 +289,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueWatcherDeleteResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -292,7 +332,7 @@ x-paths: schema: type: string responses: - '200': + 200: content: application/json: examples: @@ -312,6 +352,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueWatcherGetListResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > diff --git a/spec/issues/issues_common.yaml b/spec/issues/issues_common.yaml index fadb7632..2e6c3cc3 100644 --- a/spec/issues/issues_common.yaml +++ b/spec/issues/issues_common.yaml @@ -59,6 +59,14 @@ x-paths: reopened: false reopenedByUserUid: null reopenedDate: null + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -107,7 +115,7 @@ x-paths: $ref: '#/components/schemas/IssueTextRequest' required: true responses: - '200': + 200: content: application/json: examples: @@ -121,6 +129,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueTextResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -155,7 +171,7 @@ x-paths: $ref: '#/components/schemas/IssueStateRequest' required: true responses: - '200': + 200: content: application/json: examples: @@ -169,6 +185,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueStateResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -204,7 +228,7 @@ x-paths: schema: type: string responses: - '200': + 200: content: application/json: examples: @@ -223,7 +247,7 @@ x-paths: issueUid: dceaa996d417 projectId: e8fa915fa accountUid: dqsd4r5vr - issueNUmber: 53 + issueNumber: 53 reportedByUserUid: 661801f19693 string: hashcode: c32c16cddafd63dfa0dc12449372a093 @@ -236,6 +260,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueGetResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -271,7 +303,7 @@ x-paths: $ref: '#/components/schemas/IssueAnsweredRequest' required: true responses: - '200': + 200: content: application/json: examples: @@ -284,6 +316,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueAnsweredResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -319,7 +359,7 @@ x-paths: $ref: '#/components/schemas/IssueAssigneeRequest' required: true responses: - '200': + 200: content: application/json: examples: @@ -332,6 +372,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueAssigneeResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -359,7 +407,7 @@ x-paths: schema: type: string responses: - '200': + 200: content: application/json: examples: @@ -370,6 +418,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueAssigneeDeleteResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -403,7 +459,7 @@ x-paths: $ref: '#/components/schemas/IssueSeverityLevelRequest' required: true responses: - '200': + 200: content: application/json: examples: @@ -416,6 +472,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueSeverityLevelResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -450,7 +514,7 @@ x-paths: $ref: '#/components/schemas/IssueChangedTypeRequest' required: true responses: - '200': + 200: content: application/json: examples: @@ -465,6 +529,14 @@ x-paths: schema: $ref: '#/components/schemas/IssueChangedTypeResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -531,7 +603,15 @@ x-paths: reopened: true reopenedByUserUid: 661801f19693 reopenedDate: '2015-12-21T16:38:48Z' - totalCount: 1 + totalCount: 1 + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -564,7 +644,7 @@ x-paths: $ref: '#/components/schemas/CountRequest' required: true responses: - '200': + 200: content: application/json: examples: @@ -577,6 +657,14 @@ x-paths: schema: $ref: '#/components/schemas/IssuesCountResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -644,6 +732,14 @@ x-paths: reopenedByUserUid: 661801f19693 reopenedDate: '2015-12-21T16:38:48Z' totalCount: 1 + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -676,7 +772,7 @@ x-paths: $ref: '#/components/schemas/AccountCountRequest' required: true responses: - '200': + 200: content: application/json: examples: @@ -689,6 +785,14 @@ x-paths: schema: $ref: '#/components/schemas/IssuesCountResponse' description: OK + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -854,9 +958,11 @@ components: description: Issue flag "reopened" type: boolean reopenedByUserUid: + nullable: true description: User identifier who reopened issue type: string reopenedDate: + nullable: true description: Issue reopen date type: string string: diff --git a/spec/issues/webhooks/examples.yaml b/spec/issues/webhooks/examples.yaml index a70c3efa..8b03d75c 100644 --- a/spec/issues/webhooks/examples.yaml +++ b/spec/issues/webhooks/examples.yaml @@ -5,4 +5,4 @@ components: code: SUCCESS data: webhookUrl: 'https://your.domain.com/send/webhook/here' - enabled: 'true' + enabled: true diff --git a/spec/issues/webhooks/settings.yaml b/spec/issues/webhooks/settings.yaml index a044aa53..c0fa639a 100644 --- a/spec/issues/webhooks/settings.yaml +++ b/spec/issues/webhooks/settings.yaml @@ -17,7 +17,7 @@ x-paths: $ref: './commons.yaml#/components/schemas/setupWebhookRequest' required: true responses: - '200': + 200: content: application/json: example: @@ -25,6 +25,14 @@ x-paths: schema: $ref: './commons.yaml#/components/schemas/setupWebhookResponse' description: OK + 400: + $ref: '../../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -42,7 +50,7 @@ x-paths: parameters: - $ref: '../../api_common.yaml#/components/parameters/accountUid' responses: - '200': + 200: content: application/json: example: @@ -50,6 +58,14 @@ x-paths: schema: $ref: './commons.yaml#/components/schemas/setupWebhookResponse' description: OK + 400: + $ref: '../../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -66,12 +82,20 @@ x-paths: parameters: - $ref: '../../api_common.yaml#/components/parameters/accountUid' responses: - '200': + 200: content: application/json: schema: $ref: './commons.yaml#/components/schemas/receiveWebhookResponse' description: OK + 400: + $ref: '../../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: > @@ -104,9 +128,17 @@ x-paths: - $ref: './commons.yaml#/components/schemas/webhooks/issueLocaleChanged' required: true responses: - '200': + 200: content: application/json: schema: $ref: './commons.yaml#/components/schemas/receiveWebhookResponse' description: OK + 400: + $ref: '../../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../../openapi.yaml#/components/responses/Error500ResponseDefinition' diff --git a/spec/openapi.yaml b/spec/openapi.yaml index b3b3abea..763f77c7 100644 --- a/spec/openapi.yaml +++ b/spec/openapi.yaml @@ -13927,7 +13927,7 @@ components: The field unknown.parameter was not expected. Please consult the documentation to verify the fields you are submitting. - details: unknown.parameter + details: {} Error401ResponseDefinition: description: Provided credentials are not valid. diff --git a/spec/translation_quality/account_settings.yaml b/spec/translation_quality/account_settings.yaml index 4a529704..33df0fc0 100644 --- a/spec/translation_quality/account_settings.yaml +++ b/spec/translation_quality/account_settings.yaml @@ -20,7 +20,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/AccountCheckTypeCreateGroupResponse' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -45,7 +52,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/AccountCheckTypeGetGroupsResponse' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -71,7 +85,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/ProfilesAccountCheckTypeGetGroupsResponse' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -112,7 +133,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/ProfilesAccountCheckTypeCreateGroupResponse' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -140,7 +168,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/AccountCheckTypeGroupGetByUidResponse' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -166,7 +201,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/AccountCheckTypeGroupDeleteByUidResponse' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -194,7 +236,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/ProfilesAccountCheckTypeGroupGetByUidResponse' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -214,7 +263,7 @@ x-paths: - $ref: './tqc_common.yaml#/components/parameters/groupUidPathParameter' responses: - '200': + 200: description: OK content: application/json: @@ -223,10 +272,15 @@ x-paths: examples: response: value: - response: - code: SUCCESS - data: null - + code: SUCCESS + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -261,7 +315,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/AccountCheckTypeGroupAddLocaleResponse' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -295,7 +356,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/AccountCheckTypeGroupAddLocaleResponse' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -323,7 +391,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/AccountCheckTypeGroupDeleteLocaleResponse' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -354,10 +429,15 @@ x-paths: examples: response: value: - response: - code: SUCCESS - data: null - + code: SUCCESS + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | diff --git a/spec/translation_quality/account_settings_result.yaml b/spec/translation_quality/account_settings_result.yaml index f25e7390..437239f1 100644 --- a/spec/translation_quality/account_settings_result.yaml +++ b/spec/translation_quality/account_settings_result.yaml @@ -8,7 +8,7 @@ x-paths: - Translation quality checks operationId: createTranslationQualityCheckTypeGroup parameters: - - &ref_2 + - &ref_3 name: accountUid in: path schema: @@ -17,7 +17,7 @@ x-paths: description: >- The account’s unique identifier. This can be found in the Smartling Dashboard under Account Settings > API. - - &ref_3 + - &ref_4 name: checkTypeCode in: path required: true @@ -58,7 +58,7 @@ x-paths: properties: response: allOf: - - &ref_4 + - &ref_5 type: object required: - code @@ -74,13 +74,13 @@ x-paths: properties: data: allOf: - - &ref_5 + - &ref_6 type: object properties: groupUid: type: string description: Unique identifier of corresponding group. - - &ref_6 + - &ref_7 type: object properties: severityLevelCode: &ref_1 @@ -89,7 +89,7 @@ x-paths: - LOW - MEDIUM - HIGH - - &ref_7 + - &ref_8 type: object properties: checkTypeCode: *ref_0 @@ -99,7 +99,7 @@ x-paths: type: array items: allOf: - - &ref_8 + - &ref_9 type: object properties: checkSubTypeCode: @@ -132,7 +132,7 @@ x-paths: type: string description: check subtype name example: Emoji added - - &ref_9 + - &ref_10 type: object properties: severityLevelCode: *ref_1 @@ -142,7 +142,7 @@ x-paths: type: array items: allOf: - - &ref_10 + - &ref_11 type: object properties: targetLocaleId: @@ -158,6 +158,153 @@ x-paths: ignoreSign: type: string example: false + '400': &ref_12 + description: Provided request parameters are invalid. + content: + application/json: + schema: + type: object + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - VALIDATION_ERROR + type: string + errors: + items: &ref_2 + type: object + properties: + key: + example: general_error + type: string + message: + example: Unexpected server error + type: string + details: + example: {} + type: object + required: + - key + - message + type: array + required: + - code + - errors + type: object + required: + - response + examples: + response: + value: + response: + code: VALIDATION_ERROR + errors: + - key: unknown.field + message: >- + The field unknown.parameter was not expected. Please + consult the documentation to verify the fields you + are submitting. + details: {} + '401': &ref_13 + description: Provided credentials are not valid. + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - AUTHENTICATION_ERROR + - AUTHORIZATION_ERROR + type: string + errors: + items: *ref_2 + type: array + required: + - code + - errors + type: object + required: + - response + type: object + examples: + response: + value: + response: + code: AUTHENTICATION_ERROR + errors: + - key: invalid_token + details: {} + message: Invalid token + '429': &ref_14 + description: Too many simultaneous API requests. + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - MAX_OPERATIONS_LIMIT_EXCEEDED + type: string + errors: + items: *ref_2 + type: array + required: + - code + - errors + type: object + required: + - response + type: object + examples: + response: + value: + response: + code: MAX_OPERATIONS_LIMIT_EXCEEDED + errors: + - key: too.many.requests + message: >- + The limit of 10 concurrent Smartling file API + operations for this project has been exceeded. + '500': &ref_15 + description: Unexpected error + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - GENERAL_ERROR + - MAINTENANCE_MODE_ERROR + type: string + errors: + items: *ref_2 + type: array + required: + - code + - errors + type: object + required: + - response + type: object x-code-samples: - lang: curl source: > @@ -172,8 +319,8 @@ x-paths: - Translation quality checks operationId: getTranslationQualityCheckTypeGroupDetails parameters: - - *ref_2 - *ref_3 + - *ref_4 responses: '200': description: OK @@ -184,7 +331,7 @@ x-paths: properties: response: allOf: - - *ref_4 + - *ref_5 - type: object properties: data: @@ -198,29 +345,33 @@ x-paths: type: array items: allOf: - - *ref_5 - *ref_6 - *ref_7 + - *ref_8 - type: object properties: subTypes: type: array items: allOf: - - *ref_8 - *ref_9 + - *ref_10 - type: object properties: locales: type: array items: allOf: - - *ref_10 + - *ref_11 - type: object properties: ignoreSign: type: string example: false + '400': *ref_12 + '401': *ref_13 + '429': *ref_14 + '500': *ref_15 x-code-samples: - lang: curl source: > @@ -235,15 +386,15 @@ x-paths: - Translation quality checks operationId: getProfilesTranslationQualityCheckTypeGroupDetails parameters: - - *ref_2 - - &ref_11 + - *ref_3 + - &ref_16 name: profileUid in: path required: true schema: type: string description: Unique identifier of corresponding profile. - - *ref_3 + - *ref_4 responses: '200': description: OK @@ -254,7 +405,7 @@ x-paths: properties: response: allOf: - - *ref_4 + - *ref_5 - type: object properties: data: @@ -268,8 +419,8 @@ x-paths: type: array items: allOf: - - *ref_5 - - &ref_12 + - *ref_6 + - &ref_17 type: object properties: profileUid: @@ -278,28 +429,32 @@ x-paths: Unique identifier of corresponding profile. example: ce6d6b5dbc12 - - *ref_6 - *ref_7 + - *ref_8 - type: object properties: subTypes: type: array items: allOf: - - *ref_8 - *ref_9 + - *ref_10 - type: object properties: locales: type: array items: allOf: - - *ref_10 + - *ref_11 - type: object properties: ignoreSign: type: string example: false + '400': *ref_12 + '401': *ref_13 + '429': *ref_14 + '500': *ref_15 x-code-samples: - lang: curl source: > @@ -313,9 +468,9 @@ x-paths: - Translation quality checks operationId: CreateProfilesTranslationQualityCheckTypeGroup parameters: - - *ref_2 - - *ref_11 - *ref_3 + - *ref_16 + - *ref_4 requestBody: content: application/json: @@ -340,35 +495,39 @@ x-paths: properties: response: allOf: - - *ref_4 + - *ref_5 - type: object properties: data: allOf: - - *ref_5 - - *ref_12 - *ref_6 + - *ref_17 - *ref_7 + - *ref_8 - type: object properties: subTypes: type: array items: allOf: - - *ref_8 - *ref_9 + - *ref_10 - type: object properties: locales: type: array items: allOf: - - *ref_10 + - *ref_11 - type: object properties: ignoreSign: type: string example: false + '400': *ref_12 + '401': *ref_13 + '429': *ref_14 + '500': *ref_15 x-code-samples: - lang: curl source: > @@ -384,9 +543,9 @@ x-paths: - Translation quality checks operationId: getTranslationQualityCheckTypeGroupDetailsByGroup parameters: - - *ref_2 - *ref_3 - - &ref_13 + - *ref_4 + - &ref_18 name: groupUid in: path schema: @@ -403,34 +562,38 @@ x-paths: properties: response: allOf: - - *ref_4 + - *ref_5 - type: object properties: data: allOf: - - *ref_5 - *ref_6 - *ref_7 + - *ref_8 - type: object properties: subTypes: type: array items: allOf: - - *ref_8 - *ref_9 + - *ref_10 - type: object properties: locales: type: array items: allOf: - - *ref_10 + - *ref_11 - type: object properties: ignoreSign: type: string example: false + '400': *ref_12 + '401': *ref_13 + '429': *ref_14 + '500': *ref_15 x-code-samples: - lang: curl source: > @@ -445,9 +608,9 @@ x-paths: - Translation quality checks operationId: deleteTranslationQualityCheckTypeGroup parameters: - - *ref_2 - *ref_3 - - *ref_13 + - *ref_4 + - *ref_18 responses: '200': description: OK @@ -458,12 +621,16 @@ x-paths: properties: response: allOf: - - *ref_4 + - *ref_5 - type: object properties: data: allOf: - - *ref_5 + - *ref_6 + '400': *ref_12 + '401': *ref_13 + '429': *ref_14 + '500': *ref_15 x-code-samples: - lang: curl source: > @@ -478,10 +645,10 @@ x-paths: - Translation quality checks operationId: getProfilesTranslationQualityCheckTypeGroupDetailsByGroup parameters: - - *ref_2 - - *ref_11 - *ref_3 - - *ref_13 + - *ref_16 + - *ref_4 + - *ref_18 responses: '200': description: OK @@ -492,35 +659,39 @@ x-paths: properties: response: allOf: - - *ref_4 + - *ref_5 - type: object properties: data: allOf: - - *ref_5 - - *ref_12 - *ref_6 + - *ref_17 - *ref_7 + - *ref_8 - type: object properties: subTypes: type: array items: allOf: - - *ref_8 - *ref_9 + - *ref_10 - type: object properties: locales: type: array items: allOf: - - *ref_10 + - *ref_11 - type: object properties: ignoreSign: type: string example: false + '400': *ref_12 + '401': *ref_13 + '429': *ref_14 + '500': *ref_15 x-code-samples: - lang: curl source: > @@ -534,22 +705,24 @@ x-paths: - Translation quality checks operationId: deleteProfilesTranslationQualityCheckTypeGroup parameters: - - *ref_2 - - *ref_11 - *ref_3 - - *ref_13 + - *ref_16 + - *ref_4 + - *ref_18 responses: '200': description: OK content: application/json: - schema: *ref_4 + schema: *ref_5 examples: response: value: - response: - code: SUCCESS - data: null + code: SUCCESS + '400': *ref_12 + '401': *ref_13 + '429': *ref_14 + '500': *ref_15 x-code-samples: - lang: curl source: > @@ -565,33 +738,37 @@ x-paths: - Translation quality checks operationId: addLocaleToTranslationQualityCheckTypeGroup parameters: - - *ref_2 - *ref_3 - - *ref_13 + - *ref_4 + - *ref_18 requestBody: description: '' required: true content: application/json: - schema: &ref_14 + schema: &ref_19 allOf: - - *ref_10 + - *ref_11 responses: '200': description: OK content: application/json: - schema: &ref_15 + schema: &ref_20 type: object properties: response: allOf: - - *ref_4 + - *ref_5 - type: object properties: data: allOf: - - *ref_10 + - *ref_11 + '400': *ref_12 + '401': *ref_13 + '429': *ref_14 + '500': *ref_15 x-code-samples: - lang: curl source: > @@ -606,22 +783,26 @@ x-paths: - Translation quality checks operationId: addLocaleToProfilesTranslationQualityCheckTypeGroup parameters: - - *ref_2 - - *ref_11 - *ref_3 - - *ref_13 + - *ref_16 + - *ref_4 + - *ref_18 requestBody: description: '' required: true content: application/json: - schema: *ref_14 + schema: *ref_19 responses: '200': description: OK content: application/json: - schema: *ref_15 + schema: *ref_20 + '400': *ref_12 + '401': *ref_13 + '429': *ref_14 + '500': *ref_15 x-code-samples: - lang: curl source: > @@ -637,10 +818,10 @@ x-paths: - Translation quality checks operationId: deleteLocaleFromTranslationQualityCheckTypeGroup parameters: - - *ref_2 - *ref_3 - - *ref_13 - - &ref_16 + - *ref_4 + - *ref_18 + - &ref_21 name: targetLocaleId in: path required: true @@ -657,12 +838,16 @@ x-paths: properties: response: allOf: - - *ref_4 + - *ref_5 - type: object properties: data: allOf: - - *ref_10 + - *ref_11 + '400': *ref_12 + '401': *ref_13 + '429': *ref_14 + '500': *ref_15 x-code-samples: - lang: curl source: > @@ -677,23 +862,25 @@ x-paths: - Translation quality checks operationId: deleteLocaleFromProfilesTranslationQualityCheckTypeGroup parameters: - - *ref_2 - - *ref_11 - *ref_3 - - *ref_13 - *ref_16 + - *ref_4 + - *ref_18 + - *ref_21 responses: '200': description: OK content: application/json: - schema: *ref_4 + schema: *ref_5 examples: response: value: - response: - code: SUCCESS - data: null + code: SUCCESS + '400': *ref_12 + '401': *ref_13 + '429': *ref_14 + '500': *ref_15 x-code-samples: - lang: curl source: > diff --git a/spec/translation_quality/check_type_severity_level.yaml b/spec/translation_quality/check_type_severity_level.yaml index 53227cd0..cb06b89a 100644 --- a/spec/translation_quality/check_type_severity_level.yaml +++ b/spec/translation_quality/check_type_severity_level.yaml @@ -27,7 +27,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/CheckTypeSeverityLevelResponse' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -61,7 +68,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/CheckTypeSeverityLevelResponse' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -95,7 +109,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/CheckTypeSeverityLevelResponse' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -130,7 +151,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/CheckTypeSeverityLevelResponse' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | diff --git a/spec/translation_quality/check_type_severity_level_result.yaml b/spec/translation_quality/check_type_severity_level_result.yaml index a2071751..a678a056 100644 --- a/spec/translation_quality/check_type_severity_level_result.yaml +++ b/spec/translation_quality/check_type_severity_level_result.yaml @@ -7,7 +7,7 @@ x-paths: - Translation quality checks operationId: profilesUpdateCheckTypeSeverityLevel parameters: - - &ref_0 + - &ref_1 name: accountUid in: path schema: @@ -16,14 +16,14 @@ x-paths: description: >- The account’s unique identifier. This can be found in the Smartling Dashboard under Account Settings > API. - - &ref_1 + - &ref_2 name: profileUid in: path required: true schema: type: string description: Unique identifier of corresponding profile. - - &ref_4 + - &ref_9 name: checkTypeCode in: path required: true @@ -59,7 +59,7 @@ x-paths: required: true content: application/json: - schema: &ref_2 + schema: &ref_3 allOf: - type: object properties: @@ -76,7 +76,7 @@ x-paths: description: OK content: application/json: - schema: &ref_3 + schema: &ref_4 type: object properties: response: @@ -103,6 +103,153 @@ x-paths: - LOW - MEDIUM - HIGH + '400': &ref_5 + description: Provided request parameters are invalid. + content: + application/json: + schema: + type: object + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - VALIDATION_ERROR + type: string + errors: + items: &ref_0 + type: object + properties: + key: + example: general_error + type: string + message: + example: Unexpected server error + type: string + details: + example: {} + type: object + required: + - key + - message + type: array + required: + - code + - errors + type: object + required: + - response + examples: + response: + value: + response: + code: VALIDATION_ERROR + errors: + - key: unknown.field + message: >- + The field unknown.parameter was not expected. Please + consult the documentation to verify the fields you + are submitting. + details: {} + '401': &ref_6 + description: Provided credentials are not valid. + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - AUTHENTICATION_ERROR + - AUTHORIZATION_ERROR + type: string + errors: + items: *ref_0 + type: array + required: + - code + - errors + type: object + required: + - response + type: object + examples: + response: + value: + response: + code: AUTHENTICATION_ERROR + errors: + - key: invalid_token + details: {} + message: Invalid token + '429': &ref_7 + description: Too many simultaneous API requests. + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - MAX_OPERATIONS_LIMIT_EXCEEDED + type: string + errors: + items: *ref_0 + type: array + required: + - code + - errors + type: object + required: + - response + type: object + examples: + response: + value: + response: + code: MAX_OPERATIONS_LIMIT_EXCEEDED + errors: + - key: too.many.requests + message: >- + The limit of 10 concurrent Smartling file API + operations for this project has been exceeded. + '500': &ref_8 + description: Unexpected error + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - GENERAL_ERROR + - MAINTENANCE_MODE_ERROR + type: string + errors: + items: *ref_0 + type: array + required: + - code + - errors + type: object + required: + - response + type: object x-code-samples: - lang: curl source: > @@ -117,9 +264,9 @@ x-paths: - Translation quality checks operationId: profilesUpdateCheckSubTypeSeverityLevel parameters: - - *ref_0 - *ref_1 - - &ref_5 + - *ref_2 + - &ref_10 name: checkTypeCode in: path required: true @@ -133,7 +280,7 @@ x-paths: - INSERTABLE_CONSISTENCY - TARGET_SOURCE_CONSISTENCY description: '[check type code](#operation/getTranslationQualityCheckTypes)' - - &ref_7 + - &ref_12 name: checkSubTypeCode in: path required: true @@ -169,13 +316,17 @@ x-paths: required: true content: application/json: - schema: *ref_2 + schema: *ref_3 responses: '200': description: OK content: application/json: - schema: *ref_3 + schema: *ref_4 + '400': *ref_5 + '401': *ref_6 + '429': *ref_7 + '500': *ref_8 x-code-samples: - lang: curl source: > @@ -190,10 +341,10 @@ x-paths: - Translation quality checks operationId: updateProfilesCheckGroupSeverityLevel parameters: - - *ref_0 - *ref_1 - - *ref_4 - - &ref_6 + - *ref_2 + - *ref_9 + - &ref_11 name: groupUid in: path schema: @@ -205,13 +356,17 @@ x-paths: required: true content: application/json: - schema: *ref_2 + schema: *ref_3 responses: '200': description: OK content: application/json: - schema: *ref_3 + schema: *ref_4 + '400': *ref_5 + '401': *ref_6 + '429': *ref_7 + '500': *ref_8 x-code-samples: - lang: curl source: > @@ -226,23 +381,27 @@ x-paths: - Translation quality checks operationId: updateSeverityLevelForProfilesGroupAndSubType parameters: - - *ref_0 - *ref_1 - - *ref_5 - - *ref_6 - - *ref_7 + - *ref_2 + - *ref_10 + - *ref_11 + - *ref_12 requestBody: description: '' required: true content: application/json: - schema: *ref_2 + schema: *ref_3 responses: '200': description: OK content: application/json: - schema: *ref_3 + schema: *ref_4 + '400': *ref_5 + '401': *ref_6 + '429': *ref_7 + '500': *ref_8 x-code-samples: - lang: curl source: > diff --git a/spec/translation_quality/checks/accounts.yaml b/spec/translation_quality/checks/accounts.yaml index 86e764c9..a2ae4535 100644 --- a/spec/translation_quality/checks/accounts.yaml +++ b/spec/translation_quality/checks/accounts.yaml @@ -21,7 +21,14 @@ x-paths: $ref: '#/components/schemas/ProfilesTqcAccountGetCheckTypesResponse' example: $ref: '../examples.yaml#/components/examples/profiles_accounts_check_types_settings_example' - + 400: + $ref: '../../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -50,7 +57,14 @@ x-paths: - $ref: '#/components/schemas/ProfilesAccountCheckTypeEffectiveResponse' examples: $ref: '../examples.yaml#/components/examples/profiles_account_check_types_settings_effective_example' - + 400: + $ref: '../../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -85,7 +99,14 @@ x-paths: $ref: '#/components/schemas/ProfilesAccountCheckTypeApplySettingsResponse' examples: $ref: '../examples.yaml#/components/examples/profiles_accounts_check_types_checkType_settings_example' - + 400: + $ref: '../../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -121,7 +142,14 @@ x-paths: $ref: '#/components/schemas/ProfilesAccountCheckTypeApplyGroupSettingsResponse' examples: $ref: '../examples.yaml#/components/examples/profiles_accounts_check_types_checkType_group_settings_example' - + 400: + $ref: '../../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -148,7 +176,14 @@ x-paths: $ref: '#/components/schemas/TqcProjectGetCheckTypesResponse' example: $ref: '../examples.yaml#/components/examples/projects_check_types_settings_example' - + 400: + $ref: '../../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | diff --git a/spec/translation_quality/checks/accounts_result.yaml b/spec/translation_quality/checks/accounts_result.yaml index 59cfbb62..91b0ca13 100644 --- a/spec/translation_quality/checks/accounts_result.yaml +++ b/spec/translation_quality/checks/accounts_result.yaml @@ -7,7 +7,7 @@ x-paths: - Translation quality checks operationId: getProfilesAccountCheckTypesSettings parameters: - - &ref_0 + - &ref_1 name: accountUid in: path schema: @@ -16,7 +16,7 @@ x-paths: description: >- The account’s unique identifier. This can be found in the Smartling Dashboard under Account Settings > API. - - &ref_1 + - &ref_2 name: profileUid in: path required: true @@ -33,7 +33,7 @@ x-paths: properties: response: allOf: - - &ref_2 + - &ref_3 type: object required: - code @@ -77,7 +77,7 @@ x-paths: ../tqc_common.yaml#/components/schemas/profileUidResponse - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_10 + - &ref_15 type: object properties: noEmojisAllowedInTarget: @@ -126,7 +126,7 @@ x-paths: - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - allOf: - - &ref_16 + - &ref_21 type: object properties: matchMethod: @@ -145,7 +145,7 @@ x-paths: minimum: 0 maximum: 100 example: 10 - - &ref_17 + - &ref_22 type: object properties: sameTermCount: @@ -254,7 +254,7 @@ x-paths: ../tqc_common.yaml#/components/schemas/profileUidResponse - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_14 + - &ref_19 type: object properties: ignoreSign: @@ -288,7 +288,7 @@ x-paths: ../tqc_common.yaml#/components/schemas/profileUidResponse - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_18 + - &ref_23 type: object properties: mustHaveIdenticalTags: @@ -329,7 +329,7 @@ x-paths: ../tqc_common.yaml#/components/schemas/profileUidResponse - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_19 + - &ref_24 type: object properties: lowerLengthThreshold: @@ -371,7 +371,7 @@ x-paths: ../tqc_common.yaml#/components/schemas/profileUidResponse - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_12 + - &ref_17 type: object properties: minTextLengthLimit: @@ -393,7 +393,7 @@ x-paths: ../tqc_common.yaml#/components/schemas/profileUidResponse - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_11 + - &ref_16 type: object properties: skipIfWordInUserDictionary: @@ -458,7 +458,7 @@ x-paths: ../tqc_common.yaml#/components/schemas/profileUidResponse - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_13 + - &ref_18 type: object properties: minTextLengthLimit: @@ -494,7 +494,7 @@ x-paths: ../tqc_common.yaml#/components/schemas/profileUidResponse - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_15 + - &ref_20 type: object properties: ignoreTagsAndPlaceholders: @@ -606,7 +606,7 @@ x-paths: ../tqc_common.yaml#/components/schemas/profileUidResponse - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_20 + - &ref_25 type: object properties: sourceIssuesMustBeResolved: @@ -866,6 +866,153 @@ x-paths: groups: [] sourceIssuesMustBeResolved: true translationIssuesMustBeResolved: true + '400': &ref_11 + description: Provided request parameters are invalid. + content: + application/json: + schema: + type: object + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - VALIDATION_ERROR + type: string + errors: + items: &ref_0 + type: object + properties: + key: + example: general_error + type: string + message: + example: Unexpected server error + type: string + details: + example: {} + type: object + required: + - key + - message + type: array + required: + - code + - errors + type: object + required: + - response + examples: + response: + value: + response: + code: VALIDATION_ERROR + errors: + - key: unknown.field + message: >- + The field unknown.parameter was not expected. Please + consult the documentation to verify the fields you + are submitting. + details: {} + '401': &ref_12 + description: Provided credentials are not valid. + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - AUTHENTICATION_ERROR + - AUTHORIZATION_ERROR + type: string + errors: + items: *ref_0 + type: array + required: + - code + - errors + type: object + required: + - response + type: object + examples: + response: + value: + response: + code: AUTHENTICATION_ERROR + errors: + - key: invalid_token + details: {} + message: Invalid token + '429': &ref_13 + description: Too many simultaneous API requests. + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - MAX_OPERATIONS_LIMIT_EXCEEDED + type: string + errors: + items: *ref_0 + type: array + required: + - code + - errors + type: object + required: + - response + type: object + examples: + response: + value: + response: + code: MAX_OPERATIONS_LIMIT_EXCEEDED + errors: + - key: too.many.requests + message: >- + The limit of 10 concurrent Smartling file API + operations for this project has been exceeded. + '500': &ref_14 + description: Unexpected error + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - GENERAL_ERROR + - MAINTENANCE_MODE_ERROR + type: string + errors: + items: *ref_0 + type: array + required: + - code + - errors + type: object + required: + - response + type: object x-code-samples: - lang: curl source: > @@ -880,8 +1027,8 @@ x-paths: - Translation quality checks operationId: getProfilesSingleCheckTypeSettings parameters: - - *ref_0 - *ref_1 + - *ref_2 - name: checkTypeCode in: path required: true @@ -923,14 +1070,14 @@ x-paths: properties: response: allOf: - - *ref_2 + - *ref_3 - type: object properties: data: anyOf: - title: LEADING_TRAILING_SPACES allOf: - - &ref_4 + - &ref_5 type: object properties: profileUid: @@ -939,12 +1086,12 @@ x-paths: Unique identifier of corresponding profile. example: ce6d6b5dbc12 - - &ref_5 + - &ref_6 allOf: - - &ref_6 + - &ref_7 type: object properties: - severityLevelCode: &ref_3 + severityLevelCode: &ref_4 enum: - DISABLED - LOW @@ -961,7 +1108,7 @@ x-paths: type: string description: check subtype code example: '' - - &ref_7 + - &ref_8 type: object properties: localeSeverityLevels: @@ -975,8 +1122,8 @@ x-paths: Smartling locale identifier of the translation example: it-IT - severityLevelCode: *ref_3 - - &ref_8 + severityLevelCode: *ref_4 + - &ref_9 type: object properties: groups: @@ -1000,8 +1147,8 @@ x-paths: example: LEADING_TRAILING_SPACES - title: WHITESPACES allOf: - - *ref_4 - *ref_5 + - *ref_6 - type: object properties: checkTypeCode: @@ -1012,8 +1159,8 @@ x-paths: example: WHITESPACES - title: ORIGINAL_EQUALS_TARGET allOf: - - *ref_4 - *ref_5 + - *ref_6 - type: object properties: mustHaveIdenticalTags: @@ -1036,8 +1183,8 @@ x-paths: example: ORIGINAL_EQUALS_TARGET - title: SPELLCHECK allOf: - - *ref_4 - *ref_5 + - *ref_6 - type: object properties: skipIfWordInUserDictionary: @@ -1070,12 +1217,12 @@ x-paths: example: SPELLCHECK - title: TAG_CONSISTENCY allOf: - - *ref_4 - - &ref_9 + - *ref_5 + - &ref_10 allOf: - - *ref_6 - *ref_7 - *ref_8 + - *ref_9 - type: object properties: checkTypeCode: @@ -1100,8 +1247,8 @@ x-paths: example: TAG_ADDED - title: TARGET_LENGTH_LIMIT allOf: - - *ref_4 - *ref_5 + - *ref_6 - type: object properties: checkTypeCode: @@ -1112,8 +1259,8 @@ x-paths: example: TARGET_LENGTH_LIMIT - title: NUMBER_CONSISTENCY allOf: - - *ref_4 - - *ref_9 + - *ref_5 + - *ref_10 - type: object properties: ignoreSign: @@ -1143,8 +1290,8 @@ x-paths: example: NUMBER_ADDED - title: REPEATED_WORD allOf: - - *ref_4 - *ref_5 + - *ref_6 - type: object properties: checkTypeCode: @@ -1155,8 +1302,8 @@ x-paths: example: REPEATED_WORD - title: TARGET_IN_WRONG_LANGUAGE allOf: - - *ref_4 - *ref_5 + - *ref_6 - type: object properties: minTextLengthLimit: @@ -1174,8 +1321,8 @@ x-paths: example: TARGET_IN_WRONG_LANGUAGE - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - *ref_4 - *ref_5 + - *ref_6 - type: object properties: minTextLengthLimit: @@ -1193,8 +1340,8 @@ x-paths: example: SOURCE_IN_WRONG_LANGUAGE - title: SEGMENT_COMPLETENESS allOf: - - *ref_4 - - *ref_9 + - *ref_5 + - *ref_10 - type: object properties: lowerLengthThreshold: @@ -1232,8 +1379,8 @@ x-paths: example: TARGET_IS_EMPTY - title: NON_TRANSLATABLE_TEXT allOf: - - *ref_4 - *ref_5 + - *ref_6 - type: object properties: checkTypeCode: @@ -1258,8 +1405,8 @@ x-paths: example: PLACEABLE_ADDED - title: EMOJI_CONSISTENCY allOf: - - *ref_4 - - *ref_9 + - *ref_5 + - *ref_10 - type: object properties: noEmojisAllowedInTarget: @@ -1289,8 +1436,8 @@ x-paths: example: EMOJI_ADDED - title: INSERTABLE_CONSISTENCY allOf: - - *ref_4 - - *ref_9 + - *ref_5 + - *ref_10 - type: object properties: checkTypeCode: @@ -1313,8 +1460,8 @@ x-paths: example: INSERTABLE_ADDED - title: TARGET_SOURCE_CONSISTENCY allOf: - - *ref_4 - - *ref_9 + - *ref_5 + - *ref_10 - type: object properties: ignoreTagsAndPlaceholders: @@ -1347,8 +1494,8 @@ x-paths: example: SAME_SOURCE_DIFFERENT_TRANSLATIONS - title: BLACKLISTED_TERMS allOf: - - *ref_4 - *ref_5 + - *ref_6 - type: object properties: checkTypeCode: @@ -1359,8 +1506,8 @@ x-paths: example: BLACKLISTED_TERMS - title: GLOSSARY_COMPLIANCE allOf: - - *ref_4 - *ref_5 + - *ref_6 - allOf: - type: object properties: @@ -1400,8 +1547,8 @@ x-paths: example: GLOSSARY_COMPLIANCE - title: TRADEMARK_CONSISTENCY allOf: - - *ref_4 - *ref_5 + - *ref_6 - type: object properties: checkTypeCode: @@ -1412,8 +1559,8 @@ x-paths: example: TRADEMARK_CONSISTENCY - title: GRAMMAR_CHECK allOf: - - *ref_4 - *ref_5 + - *ref_6 - type: object properties: checkTypeCode: @@ -1424,8 +1571,8 @@ x-paths: example: GRAMMAR_CHECK - title: GLOBAL_CAPITALISATION_CONSISTENCY allOf: - - *ref_4 - *ref_5 + - *ref_6 - type: object properties: checkTypeCode: @@ -1436,8 +1583,8 @@ x-paths: example: GLOBAL_CAPITALISATION_CONSISTENCY - title: PUNCTUATION_CONSISTENCY allOf: - - *ref_4 - *ref_5 + - *ref_6 - type: object properties: checkTypeCode: @@ -1448,8 +1595,8 @@ x-paths: example: PUNCTUATION_CONSISTENCY - title: PLURALS_REPETITION allOf: - - *ref_4 - *ref_5 + - *ref_6 - type: object properties: checkTypeCode: @@ -1460,8 +1607,8 @@ x-paths: example: PLURALS_REPETITION - title: REGEX_CHECK allOf: - - *ref_4 - *ref_5 + - *ref_6 - type: object properties: checkTypeCode: @@ -1577,11 +1724,11 @@ x-paths: items: type: string type: array - severityLevelCode: *ref_3 + severityLevelCode: *ref_4 - title: OPEN_ISSUES allOf: - - *ref_4 - *ref_5 + - *ref_6 - type: object properties: sourceIssuesMustBeResolved: @@ -1864,6 +2011,10 @@ x-paths: groups: [] sourceIssuesMustBeResolved: true translationIssuesMustBeResolved: true + '400': *ref_11 + '401': *ref_12 + '429': *ref_13 + '500': *ref_14 x-code-samples: - lang: curl source: > @@ -1878,9 +2029,9 @@ x-paths: - Translation quality checks operationId: profilesUpdateAccountCheckTypesSettings parameters: - - *ref_0 - *ref_1 - - &ref_22 + - *ref_2 + - &ref_27 name: checkTypeCode in: path required: true @@ -1906,21 +2057,21 @@ x-paths: oneOf: - title: EMOJI_CONSISTENCY allOf: - - *ref_10 - - &ref_23 + - *ref_15 + - &ref_28 $ref: >- ../tqc_common.yaml#/components/requestBodies/targetLocaleId - - &ref_24 + - &ref_29 type: object required: - noEmojisAllowedInTarget - title: SPELLCHECK allOf: - - *ref_11 - - &ref_25 + - *ref_16 + - &ref_30 $ref: >- ../tqc_common.yaml#/components/requestBodies/targetLocaleId - - &ref_26 + - &ref_31 type: object required: - skipIfWordInUserDictionary @@ -1930,71 +2081,71 @@ x-paths: - runSpellcheckForSubWords - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - *ref_12 - - &ref_27 + - *ref_17 + - &ref_32 $ref: >- ../tqc_common.yaml#/components/requestBodies/targetLocaleId - - &ref_28 + - &ref_33 type: object required: - minTextLengthLimit - title: TARGET_IN_WRONG_LANGUAGE allOf: - - &ref_29 + - &ref_34 type: object required: - minTextLengthLimit - - &ref_30 + - &ref_35 $ref: >- ../tqc_common.yaml#/components/requestBodies/targetLocaleId - - *ref_13 - - &ref_31 + - *ref_18 + - &ref_36 title: NUMBER_CONSISTENCY allOf: - - *ref_14 + - *ref_19 - title: TARGET_SOURCE_CONSISTENCY allOf: - - *ref_15 - - &ref_32 + - *ref_20 + - &ref_37 $ref: >- ../tqc_common.yaml#/components/requestBodies/targetLocaleId - - &ref_33 + - &ref_38 type: object required: - ignoreTagsAndPlaceholders - ignoreCase - - &ref_34 + - &ref_39 title: GLOSSARY_COMPLIANCE allOf: - - &ref_21 + - &ref_26 allOf: - - *ref_16 - - *ref_17 + - *ref_21 + - *ref_22 - type: object required: - matchMethod - matchThreshold - title: ORIGINAL_EQUALS_TARGET allOf: - - *ref_18 - - &ref_35 + - *ref_23 + - &ref_40 $ref: >- ../tqc_common.yaml#/components/requestBodies/targetLocaleId - - &ref_36 + - &ref_41 type: object required: - mustHaveIdenticalTags - mustHaveIdenticalCapitalization - title: SEGMENT_COMPLETENESS allOf: - - *ref_19 - - &ref_37 + - *ref_24 + - &ref_42 $ref: >- ../tqc_common.yaml#/components/requestBodies/targetLocaleId - - &ref_38 + - &ref_43 title: OPEN_ISSUES allOf: - - *ref_20 + - *ref_25 - type: object required: - sourceIssuesMustBeResolved @@ -2009,41 +2160,41 @@ x-paths: properties: response: allOf: - - *ref_2 + - *ref_3 - type: object properties: - data: &ref_39 + data: &ref_44 oneOf: - title: EMOJI_CONSISTENCY allOf: - - *ref_10 + - *ref_15 - title: SPELLCHECK allOf: - - *ref_11 + - *ref_16 - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - *ref_12 + - *ref_17 - title: TARGET_IN_WRONG_LANGUAGE allOf: - - *ref_13 + - *ref_18 - title: NUMBER_CONSISTENCY allOf: - - *ref_14 + - *ref_19 - title: TARGET_SOURCE_CONSISTENCY allOf: - - *ref_15 + - *ref_20 - title: GLOSSARY_COMPLIANCE allOf: - - *ref_21 + - *ref_26 - title: ORIGINAL_EQUALS_TARGET allOf: - - *ref_18 + - *ref_23 - title: SEGMENT_COMPLETENESS allOf: - - *ref_19 + - *ref_24 - title: OPEN_ISSUES allOf: - - *ref_20 + - *ref_25 examples: EMOJI_CONSISTENCY: value: @@ -2086,6 +2237,10 @@ x-paths: value: sourceIssuesMustBeResolved: true translationIssuesMustBeResolved: true + '400': *ref_11 + '401': *ref_12 + '429': *ref_13 + '500': *ref_14 x-code-samples: - lang: curl source: > @@ -2100,9 +2255,9 @@ x-paths: - Translation quality checks operationId: updateProfilesCheckTypeGroupSettings parameters: - - *ref_0 - *ref_1 - - *ref_22 + - *ref_2 + - *ref_27 - name: groupUid in: path schema: @@ -2118,41 +2273,41 @@ x-paths: oneOf: - title: EMOJI_CONSISTENCY allOf: - - *ref_10 - - *ref_23 - - *ref_24 + - *ref_15 + - *ref_28 + - *ref_29 - title: SPELLCHECK allOf: - - *ref_11 - - *ref_25 - - *ref_26 + - *ref_16 + - *ref_30 + - *ref_31 - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - *ref_12 - - *ref_27 - - *ref_28 + - *ref_17 + - *ref_32 + - *ref_33 - title: TARGET_IN_WRONG_LANGUAGE allOf: - - *ref_29 - - *ref_30 - - *ref_13 - - *ref_31 + - *ref_34 + - *ref_35 + - *ref_18 + - *ref_36 - title: TARGET_SOURCE_CONSISTENCY allOf: - - *ref_15 - - *ref_32 - - *ref_33 - - *ref_34 + - *ref_20 + - *ref_37 + - *ref_38 + - *ref_39 - title: ORIGINAL_EQUALS_TARGET allOf: - - *ref_18 - - *ref_35 - - *ref_36 + - *ref_23 + - *ref_40 + - *ref_41 - title: SEGMENT_COMPLETENESS allOf: - - *ref_19 - - *ref_37 - - *ref_38 + - *ref_24 + - *ref_42 + - *ref_43 responses: '200': description: OK @@ -2163,10 +2318,10 @@ x-paths: properties: response: allOf: - - *ref_2 + - *ref_3 - type: object properties: - data: *ref_39 + data: *ref_44 examples: EMOJI_CONSISTENCY: value: @@ -2209,6 +2364,10 @@ x-paths: value: sourceIssuesMustBeResolved: true translationIssuesMustBeResolved: true + '400': *ref_11 + '401': *ref_12 + '429': *ref_13 + '500': *ref_14 x-code-samples: - lang: curl source: > @@ -2247,7 +2406,7 @@ x-paths: properties: response: allOf: - - *ref_2 + - *ref_3 - type: object properties: data: @@ -2276,7 +2435,7 @@ x-paths: allOf: - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_10 + - *ref_15 - type: object properties: checkTypeCode: @@ -2314,7 +2473,7 @@ x-paths: allOf: - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_16 + - *ref_21 - type: object properties: sameTermCount: @@ -2413,7 +2572,7 @@ x-paths: allOf: - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_14 + - *ref_19 - type: object properties: checkTypeCode: @@ -2439,7 +2598,7 @@ x-paths: allOf: - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_18 + - *ref_23 - type: object required: - checkTypeCode @@ -2466,7 +2625,7 @@ x-paths: allOf: - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_19 + - *ref_24 - type: object properties: checkTypeCode: @@ -2492,7 +2651,7 @@ x-paths: allOf: - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_12 + - *ref_17 - type: object properties: checkTypeCode: @@ -2505,7 +2664,7 @@ x-paths: allOf: - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_11 + - *ref_16 - type: object properties: checkTypeCode: @@ -2544,7 +2703,7 @@ x-paths: allOf: - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_13 + - *ref_18 - type: object properties: checkTypeCode: @@ -2569,7 +2728,7 @@ x-paths: allOf: - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_15 + - *ref_20 - type: object properties: checkTypeCode: @@ -2659,7 +2818,7 @@ x-paths: allOf: - $ref: >- ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_20 + - *ref_25 - type: object required: - checkTypeCode @@ -2873,6 +3032,10 @@ x-paths: groups: [] sourceIssuesMustBeResolved: true translationIssuesMustBeResolved: true + '400': *ref_11 + '401': *ref_12 + '429': *ref_13 + '500': *ref_14 x-code-samples: - lang: curl source: > diff --git a/spec/translation_quality/dictionaries.yaml b/spec/translation_quality/dictionaries.yaml index f7c71382..52ed6d3a 100644 --- a/spec/translation_quality/dictionaries.yaml +++ b/spec/translation_quality/dictionaries.yaml @@ -17,7 +17,14 @@ x-paths: $ref: '#/components/schemas/DictionaryCheckTypesResponse' example: $ref: './examples.yaml#/components/examples/dictionary_checkTypes_response_example' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -43,7 +50,14 @@ x-paths: $ref: '#/components/schemas/DictionaryCheckSubTypeResponse' example: $ref: './examples.yaml#/components/examples/dictionary_checkType_subTypes_example' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -67,7 +81,14 @@ x-paths: $ref: '#/components/schemas/DictionaryCheckTypeMatchMethodsGlossaryComplianceResponse' example: $ref: './examples.yaml#/components/examples/dictionary_checkType_GLOSSARY_COMPLIANCE_match_methods_example' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -91,7 +112,14 @@ x-paths: $ref: '#/components/schemas/DictionaryCheckSeverityLevelResponse' example: $ref: './examples.yaml#/components/examples/dictionary_severity_levels_example' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -115,7 +143,14 @@ x-paths: $ref: '#/components/schemas/DictionaryCheckTypeTrademarkTypesTrademarkConsistencyResponse' example: $ref: './examples.yaml#/components/examples/dictionary_checkType_TRADEMARK_CONSISTENCY_trademark_types_example' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -139,7 +174,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/CurrentUserSettingsDictionaryForLocaleResponse' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -169,7 +211,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/CurrentUserSettingsDictionaryForLocalePostResponse' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -194,7 +243,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/CurrentUserSettingsDictionaryForLocalePostResponse' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -219,7 +275,14 @@ x-paths: $ref: '#/components/schemas/DictionaryRegexCheckRuleTypesResponse' example: $ref: '#/components/examples/regex_check_rule_types_example' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -243,7 +306,14 @@ x-paths: $ref: '#/components/schemas/DictionaryRegexCheckFlavorsResponse' example: $ref: '#/components/examples/regex_check_flavors_example' - + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | diff --git a/spec/translation_quality/dictionaries_result.yaml b/spec/translation_quality/dictionaries_result.yaml index 9f0b9493..79b9b606 100644 --- a/spec/translation_quality/dictionaries_result.yaml +++ b/spec/translation_quality/dictionaries_result.yaml @@ -16,7 +16,7 @@ x-paths: properties: response: allOf: - - &ref_1 + - &ref_2 type: object required: - code @@ -42,7 +42,7 @@ x-paths: allOf: - type: object properties: - checkTypeCode: &ref_0 + checkTypeCode: &ref_1 enum: - LEADING_TRAILING_SPACES - ORIGINAL_EQUALS_TARGET @@ -84,7 +84,7 @@ x-paths: type: array items: allOf: - - &ref_2 + - &ref_3 type: object properties: checkSubTypeCode: @@ -159,9 +159,7 @@ x-paths: name: Tag order changed - checkTypeCode: TARGET_LENGTH_LIMIT name: Target length limit - description: >- - Check that the translation is within the length - limit + description: Check that the translation is within the length limit checkSubTypes: [] - checkTypeCode: NUMBER_CONSISTENCY name: Number consistency @@ -293,6 +291,153 @@ x-paths: name: Open Issues description: Check that strings do not have open issues checkSubTypes: [] + '400': &ref_4 + description: Provided request parameters are invalid. + content: + application/json: + schema: + type: object + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - VALIDATION_ERROR + type: string + errors: + items: &ref_0 + type: object + properties: + key: + example: general_error + type: string + message: + example: Unexpected server error + type: string + details: + example: {} + type: object + required: + - key + - message + type: array + required: + - code + - errors + type: object + required: + - response + examples: + response: + value: + response: + code: VALIDATION_ERROR + errors: + - key: unknown.field + message: >- + The field unknown.parameter was not expected. Please + consult the documentation to verify the fields you + are submitting. + details: {} + '401': &ref_5 + description: Provided credentials are not valid. + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - AUTHENTICATION_ERROR + - AUTHORIZATION_ERROR + type: string + errors: + items: *ref_0 + type: array + required: + - code + - errors + type: object + required: + - response + type: object + examples: + response: + value: + response: + code: AUTHENTICATION_ERROR + errors: + - key: invalid_token + details: {} + message: Invalid token + '429': &ref_6 + description: Too many simultaneous API requests. + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - MAX_OPERATIONS_LIMIT_EXCEEDED + type: string + errors: + items: *ref_0 + type: array + required: + - code + - errors + type: object + required: + - response + type: object + examples: + response: + value: + response: + code: MAX_OPERATIONS_LIMIT_EXCEEDED + errors: + - key: too.many.requests + message: >- + The limit of 10 concurrent Smartling file API + operations for this project has been exceeded. + '500': &ref_7 + description: Unexpected error + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - GENERAL_ERROR + - MAINTENANCE_MODE_ERROR + type: string + errors: + items: *ref_0 + type: array + required: + - code + - errors + type: object + required: + - response + type: object x-code-samples: - lang: curl source: > @@ -309,7 +454,7 @@ x-paths: - name: checkTypeCode in: path required: true - schema: *ref_0 + schema: *ref_1 description: '[check type code](#operation/getTranslationQualityCheckTypes)' responses: '200': @@ -321,7 +466,7 @@ x-paths: properties: response: allOf: - - *ref_1 + - *ref_2 - type: object properties: data: @@ -334,7 +479,7 @@ x-paths: type: array items: allOf: - - *ref_2 + - *ref_3 example: response: code: SUCCESS @@ -347,6 +492,10 @@ x-paths: name: Emoji deleted - checkSubTypeCode: EMOJI_PRESENT name: Emoji present + '400': *ref_4 + '401': *ref_5 + '429': *ref_6 + '500': *ref_7 x-code-samples: - lang: curl source: > @@ -369,7 +518,7 @@ x-paths: properties: response: allOf: - - *ref_1 + - *ref_2 - type: object properties: data: @@ -410,6 +559,10 @@ x-paths: matchMethodName: Exact match - matchMethodCode: LEXICAL_ANALYSIS matchMethodName: Lexical analysis + '400': *ref_4 + '401': *ref_5 + '429': *ref_6 + '500': *ref_7 x-code-samples: - lang: curl source: > @@ -432,7 +585,7 @@ x-paths: properties: response: allOf: - - *ref_1 + - *ref_2 - type: object properties: data: @@ -473,6 +626,10 @@ x-paths: name: Medium Severity - severityLevelCode: HIGH name: High Severity + '400': *ref_4 + '401': *ref_5 + '429': *ref_6 + '500': *ref_7 x-code-samples: - lang: curl source: > @@ -495,7 +652,7 @@ x-paths: properties: response: allOf: - - *ref_1 + - *ref_2 - type: object properties: data: @@ -539,6 +696,10 @@ x-paths: trademarkTypeCode: REGISTERED - name: Trademark symbol trademarkTypeCode: TRADEMARK + '400': *ref_4 + '401': *ref_5 + '429': *ref_6 + '500': *ref_7 x-code-samples: - lang: curl source: > @@ -552,7 +713,7 @@ x-paths: - Translation quality checks operationId: getUserCustomDictionary parameters: - - &ref_3 + - &ref_8 name: localeId in: path required: true @@ -569,7 +730,7 @@ x-paths: properties: response: allOf: - - *ref_1 + - *ref_2 - type: object properties: data: @@ -582,7 +743,7 @@ x-paths: type: array items: allOf: - - &ref_4 + - &ref_9 type: object properties: wordUid: @@ -600,6 +761,10 @@ x-paths: the UTC value of the date the word was added. example: 2018-11-21T01:51:17.000Z + '400': *ref_4 + '401': *ref_5 + '429': *ref_6 + '500': *ref_7 x-code-samples: - lang: curl source: > @@ -612,7 +777,7 @@ x-paths: - Translation quality checks operationId: addWordToUserCustomDictionary parameters: - - *ref_3 + - *ref_8 requestBody: description: '' required: true @@ -630,17 +795,21 @@ x-paths: description: OK content: application/json: - schema: &ref_5 + schema: &ref_10 type: object properties: response: allOf: - - *ref_1 + - *ref_2 - type: object properties: data: allOf: - - *ref_4 + - *ref_9 + '400': *ref_4 + '401': *ref_5 + '429': *ref_6 + '500': *ref_7 x-code-samples: - lang: curl source: > @@ -655,7 +824,7 @@ x-paths: - Translation quality checks operationId: removeWordFromUserCustomDictionary parameters: - - *ref_3 + - *ref_8 - name: wordUid in: path required: true @@ -667,7 +836,11 @@ x-paths: description: OK content: application/json: - schema: *ref_5 + schema: *ref_10 + '400': *ref_4 + '401': *ref_5 + '429': *ref_6 + '500': *ref_7 x-code-samples: - lang: curl source: > @@ -691,7 +864,7 @@ x-paths: properties: response: allOf: - - *ref_1 + - *ref_2 - type: object properties: data: @@ -731,6 +904,10 @@ x-paths: name: >- Count of regex matches differ between source and target + '400': *ref_4 + '401': *ref_5 + '429': *ref_6 + '500': *ref_7 x-code-samples: - lang: curl source: > @@ -753,7 +930,7 @@ x-paths: properties: response: allOf: - - *ref_1 + - *ref_2 - type: object properties: data: @@ -788,6 +965,10 @@ x-paths: name: Java - flavorCode: DOT_NET name: .NET + '400': *ref_4 + '401': *ref_5 + '429': *ref_6 + '500': *ref_7 x-code-samples: - lang: curl source: > diff --git a/spec/translation_quality/profiles.yaml b/spec/translation_quality/profiles.yaml index 66d2c696..3d3fac21 100644 --- a/spec/translation_quality/profiles.yaml +++ b/spec/translation_quality/profiles.yaml @@ -20,6 +20,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/TQCProfilesResponse' + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl @@ -50,6 +58,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/TQCProfileResponse' + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl @@ -82,6 +98,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/UpdateTQCProfileResponse' + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl @@ -106,6 +130,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/TQCProfileResponse' + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl @@ -123,7 +155,7 @@ x-paths: - $ref: '../api_common.yaml#/components/parameters/accountUid' - $ref: './tqc_common.yaml#/components/parameters/profileUidPathParameter' responses: - '200': + 200: description: OK content: application/json: @@ -132,9 +164,15 @@ x-paths: examples: response: value: - response: - code: SUCCESS - data: null + code: SUCCESS + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -157,6 +195,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/TQCProfileResponse' + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl @@ -186,6 +232,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/TQCProfileResponse' + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl @@ -218,6 +272,14 @@ x-paths: application/json: schema: $ref: '#/components/schemas/TQCProfileResponse' + 400: + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' + 401: + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' + 429: + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' + 500: + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl diff --git a/spec/translation_quality/profiles_result.yaml b/spec/translation_quality/profiles_result.yaml index e6496e2d..cdf56960 100644 --- a/spec/translation_quality/profiles_result.yaml +++ b/spec/translation_quality/profiles_result.yaml @@ -7,7 +7,7 @@ x-paths: - Translation quality checks operationId: getTQCProfiles parameters: - - &ref_0 + - &ref_1 name: accountUid in: path schema: @@ -47,7 +47,7 @@ x-paths: properties: response: allOf: - - &ref_1 + - &ref_2 type: object required: - code @@ -70,7 +70,7 @@ x-paths: example: 1 items: type: array - items: &ref_2 + items: &ref_3 type: object properties: profileUid: @@ -101,6 +101,153 @@ x-paths: type: string description: modified date example: '2018-07-02T13:39:27Z' + '400': &ref_4 + description: Provided request parameters are invalid. + content: + application/json: + schema: + type: object + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - VALIDATION_ERROR + type: string + errors: + items: &ref_0 + type: object + properties: + key: + example: general_error + type: string + message: + example: Unexpected server error + type: string + details: + example: {} + type: object + required: + - key + - message + type: array + required: + - code + - errors + type: object + required: + - response + examples: + response: + value: + response: + code: VALIDATION_ERROR + errors: + - key: unknown.field + message: >- + The field unknown.parameter was not expected. Please + consult the documentation to verify the fields you + are submitting. + details: {} + '401': &ref_5 + description: Provided credentials are not valid. + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - AUTHENTICATION_ERROR + - AUTHORIZATION_ERROR + type: string + errors: + items: *ref_0 + type: array + required: + - code + - errors + type: object + required: + - response + type: object + examples: + response: + value: + response: + code: AUTHENTICATION_ERROR + errors: + - key: invalid_token + details: {} + message: Invalid token + '429': &ref_6 + description: Too many simultaneous API requests. + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - MAX_OPERATIONS_LIMIT_EXCEEDED + type: string + errors: + items: *ref_0 + type: array + required: + - code + - errors + type: object + required: + - response + type: object + examples: + response: + value: + response: + code: MAX_OPERATIONS_LIMIT_EXCEEDED + errors: + - key: too.many.requests + message: >- + The limit of 10 concurrent Smartling file API + operations for this project has been exceeded. + '500': &ref_7 + description: Unexpected error + content: + application/json: + schema: + properties: + response: + properties: + code: + description: >- + Indicates whether the response was successful or what + error has occured. + enum: + - GENERAL_ERROR + - MAINTENANCE_MODE_ERROR + type: string + errors: + items: *ref_0 + type: array + required: + - code + - errors + type: object + required: + - response + type: object x-code-samples: - lang: curl source: > @@ -113,15 +260,15 @@ x-paths: - Translation quality checks operationId: createTQCProfile parameters: - - *ref_0 + - *ref_1 requestBody: description: '' required: true content: application/json: - schema: &ref_3 + schema: &ref_8 allOf: - - &ref_4 + - &ref_9 type: object properties: name: @@ -135,15 +282,19 @@ x-paths: description: OK content: application/json: - schema: &ref_6 + schema: &ref_11 type: object properties: response: allOf: - - *ref_1 + - *ref_2 - type: object properties: - data: *ref_2 + data: *ref_3 + '400': *ref_4 + '401': *ref_5 + '429': *ref_6 + '500': *ref_7 x-code-samples: - lang: curl source: > @@ -158,8 +309,8 @@ x-paths: - Translation quality checks operationId: updateTQCProfile parameters: - - *ref_0 - - &ref_5 + - *ref_1 + - &ref_10 name: profileUid in: path required: true @@ -171,7 +322,7 @@ x-paths: required: true content: application/json: - schema: *ref_3 + schema: *ref_8 responses: '200': description: OK @@ -182,10 +333,14 @@ x-paths: properties: response: allOf: - - *ref_1 + - *ref_2 - type: object properties: - data: *ref_4 + data: *ref_9 + '400': *ref_4 + '401': *ref_5 + '429': *ref_6 + '500': *ref_7 x-code-samples: - lang: curl source: > @@ -200,14 +355,18 @@ x-paths: - Translation quality checks operationId: getTQCProfile parameters: - - *ref_0 - - *ref_5 + - *ref_1 + - *ref_10 responses: '200': description: OK content: application/json: - schema: *ref_6 + schema: *ref_11 + '400': *ref_4 + '401': *ref_5 + '429': *ref_6 + '500': *ref_7 x-code-samples: - lang: curl source: > @@ -220,20 +379,22 @@ x-paths: - Translation quality checks operationId: deleteTQCProfile parameters: - - *ref_0 - - *ref_5 + - *ref_1 + - *ref_10 responses: '200': description: OK content: application/json: - schema: *ref_1 + schema: *ref_2 examples: response: value: - response: - code: SUCCESS - data: null + code: SUCCESS + '400': *ref_4 + '401': *ref_5 + '429': *ref_6 + '500': *ref_7 x-code-samples: - lang: curl source: > @@ -248,13 +409,17 @@ x-paths: - Translation quality checks operationId: getTQCDefaultProfile parameters: - - *ref_0 + - *ref_1 responses: '200': description: OK content: application/json: - schema: *ref_6 + schema: *ref_11 + '400': *ref_4 + '401': *ref_5 + '429': *ref_6 + '500': *ref_7 x-code-samples: - lang: curl source: > @@ -267,7 +432,7 @@ x-paths: - Translation quality checks operationId: updateTQCDefaultProfile parameters: - - *ref_0 + - *ref_1 requestBody: description: '' required: true @@ -288,7 +453,11 @@ x-paths: description: OK content: application/json: - schema: *ref_6 + schema: *ref_11 + '400': *ref_4 + '401': *ref_5 + '429': *ref_6 + '500': *ref_7 x-code-samples: - lang: curl source: > @@ -303,7 +472,7 @@ x-paths: - Translation quality checks operationId: copyTQCProfile parameters: - - *ref_0 + - *ref_1 - name: profileUid in: path required: true @@ -315,13 +484,17 @@ x-paths: required: true content: application/json: - schema: *ref_3 + schema: *ref_8 responses: '200': description: OK content: application/json: - schema: *ref_6 + schema: *ref_11 + '400': *ref_4 + '401': *ref_5 + '429': *ref_6 + '500': *ref_7 x-code-samples: - lang: curl source: > diff --git a/spec/translation_quality/regex_check_settings_result.yaml b/spec/translation_quality/regex_check_settings_result.yaml index 75aa7aa6..c9e9cd01 100644 --- a/spec/translation_quality/regex_check_settings_result.yaml +++ b/spec/translation_quality/regex_check_settings_result.yaml @@ -215,7 +215,7 @@ x-paths: The field unknown.parameter was not expected. Please consult the documentation to verify the fields you are submitting. - details: unknown.parameter + details: {} '401': &ref_6 description: Provided credentials are not valid. content: diff --git a/spec/translation_quality/tqc_check_result.yaml b/spec/translation_quality/tqc_check_result.yaml index c3eaa7e1..d99bca81 100644 --- a/spec/translation_quality/tqc_check_result.yaml +++ b/spec/translation_quality/tqc_check_result.yaml @@ -1707,7 +1707,7 @@ x-paths: The field unknown.parameter was not expected. Please consult the documentation to verify the fields you are submitting. - details: unknown.parameter + details: {} '401': description: Provided credentials are not valid. content: diff --git a/spec/translation_quality/tqc_common.yaml b/spec/translation_quality/tqc_common.yaml index 71b3e9ba..642c848c 100644 --- a/spec/translation_quality/tqc_common.yaml +++ b/spec/translation_quality/tqc_common.yaml @@ -147,7 +147,6 @@ components: properties: profileUid: type: string - required: true description: Unique identifier of corresponding profile. example: "ce6d6b5dbc12" required: From ea05075cb8a281e3f26282bd5c23bb5b6b8f6a4b Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Mon, 21 Oct 2024 18:53:18 +0300 Subject: [PATCH 04/21] added changes --- .../checks/accounts_result.yaml | 257 ++++++------------ .../checks/blacklisted_terms.yaml | 4 +- .../checks/emoji_consistency.yaml | 4 +- .../global_capitalisation_consistency.yaml | 4 +- .../checks/glossary_compliance.yaml | 4 +- .../checks/grammar_check.yaml | 4 +- .../checks/insertable_consistency.yaml | 4 +- .../checks/leading_trailing_spaces.yaml | 12 +- .../checks/non_translatable_text.yaml | 4 +- .../checks/number_consistency.yaml | 4 +- .../checks/open_issues.yaml | 4 +- .../checks/original_equals_target.yaml | 4 +- .../checks/plurals_repetition.yaml | 4 +- .../checks/punctuation_consistency.yaml | 4 +- .../checks/regex_check.yaml | 4 +- .../checks/repeated_word.yaml | 4 +- .../checks/segment_completeness.yaml | 4 +- .../checks/source_in_wrong_language.yaml | 4 +- .../checks/spellcheck.yaml | 4 +- .../checks/tag_consistency.yaml | 4 +- .../checks/target_in_wrong_language.yaml | 4 +- .../checks/target_length_limit.yaml | 4 +- .../checks/target_source_consistency.yaml | 4 +- .../checks/trademark_consistency.yaml | 4 +- .../checks/whitespaces.yaml | 4 +- .../translation_quality/tqc_check_result.yaml | 7 +- spec/translation_quality/tqc_common.yaml | 250 ++++++++--------- 27 files changed, 267 insertions(+), 351 deletions(-) diff --git a/spec/translation_quality/checks/accounts_result.yaml b/spec/translation_quality/checks/accounts_result.yaml index 91b0ca13..17923cae 100644 --- a/spec/translation_quality/checks/accounts_result.yaml +++ b/spec/translation_quality/checks/accounts_result.yaml @@ -59,10 +59,8 @@ x-paths: anyOf: - title: BLACKLISTED_TERMS allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -73,10 +71,8 @@ x-paths: example: BLACKLISTED_TERMS - title: EMOJI_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' - &ref_15 type: object properties: @@ -107,10 +103,8 @@ x-paths: example: EMOJI_ADDED - title: GLOBAL_CAPITALISATION_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -121,10 +115,8 @@ x-paths: example: GLOBAL_CAPITALISATION_CONSISTENCY - title: GLOSSARY_COMPLIANCE allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - allOf: - &ref_21 type: object @@ -166,10 +158,8 @@ x-paths: example: GLOSSARY_COMPLIANCE - title: GRAMMAR_CHECK allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -180,10 +170,8 @@ x-paths: example: GRAMMAR_CHECK - title: INSERTABLE_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -206,10 +194,8 @@ x-paths: example: INSERTABLE_ADDED - title: LEADING_TRAILING_SPACES allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object required: - checkTypeCode @@ -222,10 +208,8 @@ x-paths: example: LEADING_TRAILING_SPACES - title: NON_TRANSLATABLE_TEXT allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -250,10 +234,8 @@ x-paths: example: PLACEABLE_ADDED - title: NUMBER_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' - &ref_19 type: object properties: @@ -284,10 +266,8 @@ x-paths: example: NUMBER_ADDED - title: ORIGINAL_EQUALS_TARGET allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - &ref_23 type: object properties: @@ -311,10 +291,8 @@ x-paths: example: ORIGINAL_EQUALS_TARGET - title: REPEATED_WORD allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -325,10 +303,8 @@ x-paths: example: REPEATED_WORD - title: SEGMENT_COMPLETENESS allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' - &ref_24 type: object properties: @@ -367,10 +343,8 @@ x-paths: example: TARGET_IS_EMPTY - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - &ref_17 type: object properties: @@ -389,10 +363,8 @@ x-paths: example: SOURCE_IN_WRONG_LANGUAGE - title: SPELLCHECK allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - &ref_16 type: object properties: @@ -426,10 +398,8 @@ x-paths: example: SPELLCHECK - title: TAG_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -454,10 +424,8 @@ x-paths: example: TAG_ADDED - title: TARGET_IN_WRONG_LANGUAGE allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - &ref_18 type: object properties: @@ -476,10 +444,8 @@ x-paths: example: TARGET_IN_WRONG_LANGUAGE - title: TARGET_LENGTH_LIMIT allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -490,10 +456,8 @@ x-paths: example: TARGET_LENGTH_LIMIT - title: TARGET_SOURCE_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' - &ref_20 type: object properties: @@ -527,10 +491,8 @@ x-paths: example: SAME_SOURCE_DIFFERENT_TRANSLATIONS - title: TRADEMARK_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -541,10 +503,8 @@ x-paths: example: TRADEMARK_CONSISTENCY - title: WHITESPACES allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -555,10 +515,8 @@ x-paths: example: WHITESPACES - title: PUNCTUATION_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -569,10 +527,8 @@ x-paths: example: PUNCTUATION_CONSISTENCY - title: PLURALS_REPETITION allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -583,10 +539,8 @@ x-paths: example: PLURALS_REPETITION - title: REGEX_CHECK allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -598,14 +552,11 @@ x-paths: rules: type: array items: - $ref: >- - ../tqc_common.yaml#/components/schemas/regexRuleWithRuleUid + $ref: '../tqc_common.yaml#/components/schemas/regexRuleWithRuleUid' - title: OPEN_ISSUES allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - &ref_25 type: object properties: @@ -635,7 +586,7 @@ x-paths: items: - profileUid: ce6d6b5dbc12 severityLevelCode: LOW - checkTypeCode: LEADING_TRAILING_SPACES 1 + checkTypeCode: LEADING_TRAILING_SPACES subTypes: [] localeSeverityLevels: [] groups: [] @@ -665,17 +616,17 @@ x-paths: skipIfWordValidInSourceLocale: false runSpellcheckForSubWords: false - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW + severityLevelCode: "LOW" checkTypeCode: TAG_CONSISTENCY subTypes: - checkSubTypeCode: TAG_ADDED - severityLevelCode: LOW + severityLevelCode: "LOW" - checkSubTypeCode: TAG_DELETED - severityLevelCode: LOW + severityLevelCode: "LOW" - checkSubTypeCode: TAG_ORDER_IS_CHANGED - severityLevelCode: LOW + severityLevelCode: "LOW" - checkSubTypeCode: SPACES_AROUND_TAGS - severityLevelCode: LOW + severityLevelCode: "LOW" localeSeverityLevels: [] groups: [] - profileUid: ce6d6b5dbc12 @@ -2059,8 +2010,7 @@ x-paths: allOf: - *ref_15 - &ref_28 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId + $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' - &ref_29 type: object required: @@ -2069,8 +2019,7 @@ x-paths: allOf: - *ref_16 - &ref_30 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId + $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' - &ref_31 type: object required: @@ -2083,8 +2032,7 @@ x-paths: allOf: - *ref_17 - &ref_32 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId + $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' - &ref_33 type: object required: @@ -2096,8 +2044,7 @@ x-paths: required: - minTextLengthLimit - &ref_35 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId + $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' - *ref_18 - &ref_36 title: NUMBER_CONSISTENCY @@ -2107,8 +2054,7 @@ x-paths: allOf: - *ref_20 - &ref_37 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId + $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' - &ref_38 type: object required: @@ -2129,8 +2075,7 @@ x-paths: allOf: - *ref_23 - &ref_40 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId + $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' - &ref_41 type: object required: @@ -2140,8 +2085,7 @@ x-paths: allOf: - *ref_24 - &ref_42 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId + $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' - &ref_43 title: OPEN_ISSUES allOf: @@ -2421,8 +2365,7 @@ x-paths: anyOf: - title: BLACKLISTED_TERMS allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -2433,8 +2376,7 @@ x-paths: example: BLACKLISTED_TERMS - title: EMOJI_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' - *ref_15 - type: object properties: @@ -2459,8 +2401,7 @@ x-paths: example: EMOJI_ADDED - title: GLOBAL_CAPITALISATION_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -2471,8 +2412,7 @@ x-paths: example: GLOBAL_CAPITALISATION_CONSISTENCY - title: GLOSSARY_COMPLIANCE allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - *ref_21 - type: object properties: @@ -2494,8 +2434,7 @@ x-paths: example: GLOSSARY_COMPLIANCE - title: GRAMMAR_CHECK allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -2506,8 +2445,7 @@ x-paths: example: GRAMMAR_CHECK - title: INSERTABLE_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -2530,8 +2468,7 @@ x-paths: example: INSERTABLE_ADDED - title: LEADING_TRAILING_SPACES allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object required: - checkTypeCode @@ -2544,8 +2481,7 @@ x-paths: example: LEADING_TRAILING_SPACES - title: NON_TRANSLATABLE_TEXT allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -2570,8 +2506,7 @@ x-paths: example: PLACEABLE_ADDED - title: NUMBER_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' - *ref_19 - type: object properties: @@ -2596,8 +2531,7 @@ x-paths: example: NUMBER_ADDED - title: ORIGINAL_EQUALS_TARGET allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - *ref_23 - type: object required: @@ -2611,8 +2545,7 @@ x-paths: example: ORIGINAL_EQUALS_TARGET - title: REPEATED_WORD allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -2623,8 +2556,7 @@ x-paths: example: REPEATED_WORD - title: SEGMENT_COMPLETENESS allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' - *ref_24 - type: object properties: @@ -2649,8 +2581,7 @@ x-paths: example: TARGET_IS_EMPTY - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - *ref_17 - type: object properties: @@ -2662,8 +2593,7 @@ x-paths: example: SOURCE_IN_WRONG_LANGUAGE - title: SPELLCHECK allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - *ref_16 - type: object properties: @@ -2675,8 +2605,7 @@ x-paths: example: SPELLCHECK - title: TAG_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -2701,8 +2630,7 @@ x-paths: example: TAG_ADDED - title: TARGET_IN_WRONG_LANGUAGE allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - *ref_18 - type: object properties: @@ -2714,8 +2642,7 @@ x-paths: example: TARGET_IN_WRONG_LANGUAGE - title: TARGET_LENGTH_LIMIT allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -2726,8 +2653,7 @@ x-paths: example: TARGET_LENGTH_LIMIT - title: TARGET_SOURCE_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' - *ref_20 - type: object properties: @@ -2751,8 +2677,7 @@ x-paths: example: SAME_SOURCE_DIFFERENT_TRANSLATIONS - title: TRADEMARK_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -2763,8 +2688,7 @@ x-paths: example: TRADEMARK_CONSISTENCY - title: WHITESPACES allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -2775,8 +2699,7 @@ x-paths: example: WHITESPACES - title: PUNCTUATION_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -2787,8 +2710,7 @@ x-paths: example: PUNCTUATION_CONSISTENCY - title: PLURALS_REPETITION allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -2799,8 +2721,7 @@ x-paths: example: PLURALS_REPETITION - title: REGEX_CHECK allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - type: object properties: checkTypeCode: @@ -2812,12 +2733,10 @@ x-paths: rules: type: array items: - $ref: >- - ../tqc_common.yaml#/components/schemas/regexRuleWithRuleUid + $ref: '../tqc_common.yaml#/components/schemas/regexRuleWithRuleUid' - title: OPEN_ISSUES allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' - *ref_25 - type: object required: @@ -2836,7 +2755,7 @@ x-paths: totalCount: 24 items: - severityLevelCode: LOW - checkTypeCode: LEADING_TRAILING_SPACES 1 + checkTypeCode: LEADING_TRAILING_SPACES subTypes: [] localeSeverityLevels: [] groups: [] diff --git a/spec/translation_quality/checks/blacklisted_terms.yaml b/spec/translation_quality/checks/blacklisted_terms.yaml index 5212c51f..37497b05 100644 --- a/spec/translation_quality/checks/blacklisted_terms.yaml +++ b/spec/translation_quality/checks/blacklisted_terms.yaml @@ -40,8 +40,8 @@ components: TqcCheckMistakeDTO: title: BLACKLISTED_TERMS allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/emoji_consistency.yaml b/spec/translation_quality/checks/emoji_consistency.yaml index a80575b7..3e2d2939 100644 --- a/spec/translation_quality/checks/emoji_consistency.yaml +++ b/spec/translation_quality/checks/emoji_consistency.yaml @@ -91,8 +91,8 @@ components: TqcCheckMistakeDTO: title: EMOJI_CONSISTENCY allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/global_capitalisation_consistency.yaml b/spec/translation_quality/checks/global_capitalisation_consistency.yaml index 2b8f4b66..d0ef366e 100644 --- a/spec/translation_quality/checks/global_capitalisation_consistency.yaml +++ b/spec/translation_quality/checks/global_capitalisation_consistency.yaml @@ -40,8 +40,8 @@ components: TqcCheckMistakeDTO: title: GLOBAL_CAPITALISATION_CONSISTENCY allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/glossary_compliance.yaml b/spec/translation_quality/checks/glossary_compliance.yaml index a69469f5..b251f4a9 100644 --- a/spec/translation_quality/checks/glossary_compliance.yaml +++ b/spec/translation_quality/checks/glossary_compliance.yaml @@ -116,8 +116,8 @@ components: TqcCheckMistakeDTO: title: GLOSSARY_COMPLIANCE allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/grammar_check.yaml b/spec/translation_quality/checks/grammar_check.yaml index 0ec3261a..846299de 100644 --- a/spec/translation_quality/checks/grammar_check.yaml +++ b/spec/translation_quality/checks/grammar_check.yaml @@ -40,8 +40,8 @@ components: TqcCheckMistakeDTO: title: GRAMMAR_CHECK allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/insertable_consistency.yaml b/spec/translation_quality/checks/insertable_consistency.yaml index 471e5409..1b02440f 100644 --- a/spec/translation_quality/checks/insertable_consistency.yaml +++ b/spec/translation_quality/checks/insertable_consistency.yaml @@ -64,8 +64,8 @@ components: TqcCheckMistakeDTO: title: INSERTABLE_CONSISTENCY allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/leading_trailing_spaces.yaml b/spec/translation_quality/checks/leading_trailing_spaces.yaml index 52e133c5..ce22ee1f 100644 --- a/spec/translation_quality/checks/leading_trailing_spaces.yaml +++ b/spec/translation_quality/checks/leading_trailing_spaces.yaml @@ -55,14 +55,12 @@ components: TqcCheckMistakeDTO: title: LEADING_TRAILING_SPACES allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: type: string - enum: - - LEADING_TRAILING_SPACES description: check type code example: "LEADING_TRAILING_SPACES" details: @@ -80,21 +78,21 @@ components: profiles_accounts_check_types_settings_example: "profileUid": "ce6d6b5dbc12" "severityLevelCode": "LOW" - "checkTypeCode": "LEADING_TRAILING_SPACES 1" + "checkTypeCode": "LEADING_TRAILING_SPACES" "subTypes": [] "localeSeverityLevels": [] "groups": [] accounts_check_types_settings_example: "severityLevelCode": "LOW" - "checkTypeCode": "LEADING_TRAILING_SPACES 1" + "checkTypeCode": "LEADING_TRAILING_SPACES" "subTypes": [] "localeSeverityLevels": [] "groups": [] projects_check_types_settings_example: "severityLevelCode": "LOW" - "checkTypeCode": "LEADING_TRAILING_SPACES 1" + "checkTypeCode": "LEADING_TRAILING_SPACES" "subTypes": [] "localeSeverityLevels": [] "groups": [] diff --git a/spec/translation_quality/checks/non_translatable_text.yaml b/spec/translation_quality/checks/non_translatable_text.yaml index 4148116b..4931f746 100644 --- a/spec/translation_quality/checks/non_translatable_text.yaml +++ b/spec/translation_quality/checks/non_translatable_text.yaml @@ -68,8 +68,8 @@ components: TqcCheckMistakeDTO: title: NON_TRANSLATABLE_TEXT allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/number_consistency.yaml b/spec/translation_quality/checks/number_consistency.yaml index 355bec0b..2cc9fbea 100644 --- a/spec/translation_quality/checks/number_consistency.yaml +++ b/spec/translation_quality/checks/number_consistency.yaml @@ -86,8 +86,8 @@ components: TqcCheckMistakeDTO: title: NUMBER_CONSISTENCY allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/open_issues.yaml b/spec/translation_quality/checks/open_issues.yaml index 1f4a901f..1829e1ef 100644 --- a/spec/translation_quality/checks/open_issues.yaml +++ b/spec/translation_quality/checks/open_issues.yaml @@ -72,8 +72,8 @@ components: TqcCheckMistakeDTO: title: OPEN_ISSUES allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/original_equals_target.yaml b/spec/translation_quality/checks/original_equals_target.yaml index ee02618a..b62aa74a 100644 --- a/spec/translation_quality/checks/original_equals_target.yaml +++ b/spec/translation_quality/checks/original_equals_target.yaml @@ -73,8 +73,8 @@ components: TqcCheckMistakeDTO: title: ORIGINAL_EQUALS_TARGET allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/plurals_repetition.yaml b/spec/translation_quality/checks/plurals_repetition.yaml index b93a61a1..d7e0fa08 100644 --- a/spec/translation_quality/checks/plurals_repetition.yaml +++ b/spec/translation_quality/checks/plurals_repetition.yaml @@ -40,8 +40,8 @@ components: TqcCheckMistakeDTO: title: PLURALS_REPETITION allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/punctuation_consistency.yaml b/spec/translation_quality/checks/punctuation_consistency.yaml index 66c5de93..5544ea66 100644 --- a/spec/translation_quality/checks/punctuation_consistency.yaml +++ b/spec/translation_quality/checks/punctuation_consistency.yaml @@ -40,8 +40,8 @@ components: TqcCheckMistakeDTO: title: PUNCTUATION_CONSISTENCY allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/regex_check.yaml b/spec/translation_quality/checks/regex_check.yaml index 95a145eb..4a05749f 100644 --- a/spec/translation_quality/checks/regex_check.yaml +++ b/spec/translation_quality/checks/regex_check.yaml @@ -38,8 +38,8 @@ components: TqcCheckMistakeDTO: title: REGEX_CHECK allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/repeated_word.yaml b/spec/translation_quality/checks/repeated_word.yaml index c7eb4878..eb09143f 100644 --- a/spec/translation_quality/checks/repeated_word.yaml +++ b/spec/translation_quality/checks/repeated_word.yaml @@ -40,8 +40,8 @@ components: TqcCheckMistakeDTO: title: REPEATED_WORD allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/segment_completeness.yaml b/spec/translation_quality/checks/segment_completeness.yaml index a0250b79..e08b219e 100644 --- a/spec/translation_quality/checks/segment_completeness.yaml +++ b/spec/translation_quality/checks/segment_completeness.yaml @@ -95,8 +95,8 @@ components: TqcCheckMistakeDTO: title: SEGMENT_COMPLETENESS allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/source_in_wrong_language.yaml b/spec/translation_quality/checks/source_in_wrong_language.yaml index db1eb10b..37783c56 100644 --- a/spec/translation_quality/checks/source_in_wrong_language.yaml +++ b/spec/translation_quality/checks/source_in_wrong_language.yaml @@ -65,8 +65,8 @@ components: TqcCheckMistakeDTO: title: SOURCE_IN_WRONG_LANGUAGE allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/spellcheck.yaml b/spec/translation_quality/checks/spellcheck.yaml index 7958dc94..ba06d78d 100644 --- a/spec/translation_quality/checks/spellcheck.yaml +++ b/spec/translation_quality/checks/spellcheck.yaml @@ -94,8 +94,8 @@ components: TqcCheckMistakeDTO: title: SPELLCHECK allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/tag_consistency.yaml b/spec/translation_quality/checks/tag_consistency.yaml index 08f44861..6185a295 100644 --- a/spec/translation_quality/checks/tag_consistency.yaml +++ b/spec/translation_quality/checks/tag_consistency.yaml @@ -67,8 +67,8 @@ components: TqcCheckMistakeDTO: title: TAG_CONSISTENCY allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/target_in_wrong_language.yaml b/spec/translation_quality/checks/target_in_wrong_language.yaml index 480309e3..c5e89469 100644 --- a/spec/translation_quality/checks/target_in_wrong_language.yaml +++ b/spec/translation_quality/checks/target_in_wrong_language.yaml @@ -66,8 +66,8 @@ components: TqcCheckMistakeDTO: title: TARGET_IN_WRONG_LANGUAGE allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/target_length_limit.yaml b/spec/translation_quality/checks/target_length_limit.yaml index 8d2dc9d4..d8a0862e 100644 --- a/spec/translation_quality/checks/target_length_limit.yaml +++ b/spec/translation_quality/checks/target_length_limit.yaml @@ -40,8 +40,8 @@ components: TqcCheckMistakeDTO: title: TARGET_LENGTH_LIMIT allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/target_source_consistency.yaml b/spec/translation_quality/checks/target_source_consistency.yaml index d6a5076d..69d8f62d 100644 --- a/spec/translation_quality/checks/target_source_consistency.yaml +++ b/spec/translation_quality/checks/target_source_consistency.yaml @@ -92,8 +92,8 @@ components: TqcCheckMistakeDTO: title: TARGET_SOURCE_CONSISTENCY allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/trademark_consistency.yaml b/spec/translation_quality/checks/trademark_consistency.yaml index 5392de52..a7455867 100644 --- a/spec/translation_quality/checks/trademark_consistency.yaml +++ b/spec/translation_quality/checks/trademark_consistency.yaml @@ -40,8 +40,8 @@ components: TqcCheckMistakeDTO: title: TRADEMARK_CONSISTENCY allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/checks/whitespaces.yaml b/spec/translation_quality/checks/whitespaces.yaml index c0462dd6..77a1107d 100644 --- a/spec/translation_quality/checks/whitespaces.yaml +++ b/spec/translation_quality/checks/whitespaces.yaml @@ -40,8 +40,8 @@ components: TqcCheckMistakeDTO: title: WHITESPACES allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' + - $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeResponse' + - $ref: '../tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - type: object properties: checkTypeCode: diff --git a/spec/translation_quality/tqc_check_result.yaml b/spec/translation_quality/tqc_check_result.yaml index d99bca81..58d7f7e7 100644 --- a/spec/translation_quality/tqc_check_result.yaml +++ b/spec/translation_quality/tqc_check_result.yaml @@ -536,8 +536,8 @@ x-paths: properties: checkTypeCode: type: string - enum: - - LEADING_TRAILING_SPACES + schema: >- + ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse' description: check type code example: LEADING_TRAILING_SPACES details: @@ -1024,8 +1024,7 @@ x-paths: details: type: object nullable: true - $ref: >- - ./tqc_common.yaml#/components/schemas/regexRuleWithRuleUid + $ref: './tqc_common.yaml#/components/schemas/regexRuleWithRuleUid' positionTypeCode: type: string enum: diff --git a/spec/translation_quality/tqc_common.yaml b/spec/translation_quality/tqc_common.yaml index 642c848c..c41c4a93 100644 --- a/spec/translation_quality/tqc_common.yaml +++ b/spec/translation_quality/tqc_common.yaml @@ -22,7 +22,7 @@ components: required: true schema: type: string - $ref: '#/components/schemas/enum/checkTypeCodeEnum' + $ref: '#/components/schemas/checkTypeCodeEnum' description: '[check type code](#operation/getTranslationQualityCheckTypes)' checkTypeCodeWithSettingsPathParameter: @@ -31,7 +31,7 @@ components: required: true schema: type: string - $ref: '#/components/schemas/enum/checkTypeCodeWithSettingsEnum' + $ref: '#/components/schemas/checkTypeCodeWithSettingsEnum' description: '[check type code](#operation/getTranslationQualityCheckTypes)' checkTypeCodeOnlyWithSubtypesPathParameter: @@ -40,7 +40,7 @@ components: required: true schema: type: string - $ref: '#/components/schemas/enum/checkTypeCodeOnlyWithSubtypesEnum' + $ref: '#/components/schemas/checkTypeCodeOnlyWithSubtypesEnum' description: '[check type code](#operation/getTranslationQualityCheckTypes)' checkSubTypeCodePathParameter: @@ -49,7 +49,7 @@ components: required: true schema: type: string - $ref: '#/components/schemas/enum/checkSubtypeEnum' + $ref: '#/components/schemas/checkSubtypeEnum' description: '[check subtype code](#operation/getTranslationQualityCheckSubTypes)' targetLocaleIdPathParameter: @@ -126,7 +126,7 @@ components: properties: severityLevelCode: type: string - $ref: '#/components/schemas/enum/severityLevelCodeEnumCopyForRequest' + $ref: '#/components/schemas/severityLevelCodeEnumCopyForRequest' description: '[severity level code](#operation/getTranslationQualityCheckSeverityLevels)' example: "MEDIUM" required: @@ -167,7 +167,7 @@ components: properties: checkTypeCode: type: string - $ref: '#/components/schemas/enum/checkTypeCodeEnum' + $ref: '#/components/schemas/checkTypeCodeEnum' description: '[check type code](#operation/getTranslationQualityCheckTypes)' example: "LEADING_TRAILING_SPACES" @@ -200,7 +200,7 @@ components: type: array severityLevelCode: type: string - $ref: '#/components/schemas/enum/severityLevelCodeEnum' + $ref: '#/components/schemas/severityLevelCodeEnum' description: severity level code example: "MEDIUM" @@ -213,17 +213,17 @@ components: example: "ruleName" severityLevelCode: type: string - $ref: '#/components/schemas/enum/severityLevelCodeEnumCopyForRequest' + $ref: '#/components/schemas/severityLevelCodeEnumCopyForRequest' description: '[Severity level code](#operation/getTranslationQualityCheckSeverityLevels)' example: "MEDIUM" ruleTypeCode: type: string - $ref: '#/components/schemas/enum/ruleTypeCodeEnumCopyForRequest' + $ref: '#/components/schemas/ruleTypeCodeEnumCopyForRequest' description: '[Rule type code](#operation/getRegexQualityCheckRuleTypes)' example: "FORBIDDEN" flavorCode: type: string - $ref: '#/components/schemas/enum/flavorCodeEnum' + $ref: '#/components/schemas/flavorCodeEnum' description: Flavor code example: "JAVA" originalPattern: @@ -282,7 +282,7 @@ components: properties: ruleTypeCode: type: string - $ref: '#/components/schemas/enum/ruleTypeCodeEnum' + $ref: '#/components/schemas/ruleTypeCodeEnum' description: rule type code example: "FORBIDDEN" @@ -291,7 +291,7 @@ components: properties: flavorCode: type: string - $ref: '#/components/schemas/enum/flavorCodeEnum' + $ref: '#/components/schemas/flavorCodeEnum' description: flavor code example: "JAVA" @@ -308,7 +308,7 @@ components: properties: checkTypeCode: type: string - $ref: '#/components/schemas/enum/checkTypeCodeEnum' + $ref: '#/components/schemas/checkTypeCodeEnum' description: check type code profileResponse: @@ -344,7 +344,7 @@ components: properties: checkSubTypeCode: type: string - $ref: '#/components/schemas/enum/checkSubtypeEnum' + $ref: '#/components/schemas/checkSubtypeEnum' description: check subtype code example: "EMOJI_ADDED" name: @@ -369,7 +369,7 @@ components: properties: severityLevelCode: type: string - $ref: '#/components/schemas/enum/severityLevelCodeEnum' + $ref: '#/components/schemas/severityLevelCodeEnum' description: severity level code example: "MEDIUM" @@ -378,7 +378,7 @@ components: properties: severityLevelCode: type: string - $ref: '#/components/schemas/enum/severityLevelCodeEnum' + $ref: '#/components/schemas/severityLevelCodeEnum' description: severity level code example: "MEDIUM" @@ -435,7 +435,7 @@ components: example: "it-IT" severityLevelCode: type: string - $ref: '#/components/schemas/enum/severityLevelCodeEnum' + $ref: '#/components/schemas/severityLevelCodeEnum' description: severity level code example: "MEDIUM" @@ -731,111 +731,111 @@ components: - $ref: 'checks/segment_completeness.yaml#/components/schemas/AccountCheckTypeApplySettingsRequest' - $ref: 'checks/open_issues.yaml#/components/schemas/AccountCheckTypeApplySettingsRequest' - enum: - checkTypeCodeEnum: - enum: - - LEADING_TRAILING_SPACES - - ORIGINAL_EQUALS_TARGET - - WHITESPACES - - SPELLCHECK - - TAG_CONSISTENCY - - TARGET_LENGTH_LIMIT - - NUMBER_CONSISTENCY - - REPEATED_WORD - - TARGET_IN_WRONG_LANGUAGE - - SOURCE_IN_WRONG_LANGUAGE - - SEGMENT_COMPLETENESS - - NON_TRANSLATABLE_TEXT - - EMOJI_CONSISTENCY - - INSERTABLE_CONSISTENCY - - TARGET_SOURCE_CONSISTENCY - - BLACKLISTED_TERMS - - GLOSSARY_COMPLIANCE - - TRADEMARK_CONSISTENCY - - GRAMMAR_CHECK - - GLOBAL_CAPITALISATION_CONSISTENCY - - PUNCTUATION_CONSISTENCY - - PLURALS_REPETITION - - REGEX_CHECK - - OPEN_ISSUES - - checkSubtypeEnum: - enum: - - EMOJI_ADDED - - EMOJI_DELETED - - EMOJI_PRESENT - - INSERTABLE_ADDED - - INSERTABLE_DELETED - - PLACEABLE_ADDED - - PLACEABLE_DELETED - - SPACES_AROUND_PLACEABLE - - PLACEABLE_FORMAT - - NUMBER_ADDED - - NUMBER_DELETED - - NUMBER_INCORRECT_CONVERSION - - TARGET_IS_EMPTY - - TARGET_IS_MUCH_SHORTER_THAN_SOURCE - - TARGET_IS_MUCH_LONGER_THAN_SOURCE - - TAG_ADDED - - TAG_DELETED - - SPACES_AROUND_TAGS - - TAG_ORDER_IS_CHANGED - - OPEN_CLOSED_TAG_ORDER_IS_CHANGED - - INVALID_TAG_NESTING - - TAG_IS_CHANGED - - SAME_SOURCE_DIFFERENT_TRANSLATIONS - - SAME_TRANSLATION_DIFFERENT_SOURCES - - severityLevelCodeEnum: - enum: - - DISABLED - - LOW - - MEDIUM - - HIGH - - severityLevelCodeEnumCopyForRequest: - enum: - - DISABLED - - LOW - - MEDIUM - - HIGH - - checkTypeCodeWithSettingsEnum: - enum: - - ORIGINAL_EQUALS_TARGET - - SPELLCHECK - - NUMBER_CONSISTENCY - - TARGET_IN_WRONG_LANGUAGE - - SOURCE_IN_WRONG_LANGUAGE - - SEGMENT_COMPLETENESS - - EMOJI_CONSISTENCY - - TARGET_SOURCE_CONSISTENCY - - GLOSSARY_COMPLIANCE - - OPEN_ISSUES - - checkTypeCodeOnlyWithSubtypesEnum: - enum: - - TAG_CONSISTENCY - - NUMBER_CONSISTENCY - - SEGMENT_COMPLETENESS - - NON_TRANSLATABLE_TEXT - - EMOJI_CONSISTENCY - - INSERTABLE_CONSISTENCY - - TARGET_SOURCE_CONSISTENCY - - ruleTypeCodeEnum: - enum: - - FORBIDDEN - - MISSING - - COUNT_MISMATCH - - ruleTypeCodeEnumCopyForRequest: - enum: - - FORBIDDEN - - MISSING - - COUNT_MISMATCH - - flavorCodeEnum: - enum: - - JAVA - - DOT_NET + + checkTypeCodeEnum: + enum: + - LEADING_TRAILING_SPACES + - ORIGINAL_EQUALS_TARGET + - WHITESPACES + - SPELLCHECK + - TAG_CONSISTENCY + - TARGET_LENGTH_LIMIT + - NUMBER_CONSISTENCY + - REPEATED_WORD + - TARGET_IN_WRONG_LANGUAGE + - SOURCE_IN_WRONG_LANGUAGE + - SEGMENT_COMPLETENESS + - NON_TRANSLATABLE_TEXT + - EMOJI_CONSISTENCY + - INSERTABLE_CONSISTENCY + - TARGET_SOURCE_CONSISTENCY + - BLACKLISTED_TERMS + - GLOSSARY_COMPLIANCE + - TRADEMARK_CONSISTENCY + - GRAMMAR_CHECK + - GLOBAL_CAPITALISATION_CONSISTENCY + - PUNCTUATION_CONSISTENCY + - PLURALS_REPETITION + - REGEX_CHECK + - OPEN_ISSUES + + checkSubtypeEnum: + enum: + - EMOJI_ADDED + - EMOJI_DELETED + - EMOJI_PRESENT + - INSERTABLE_ADDED + - INSERTABLE_DELETED + - PLACEABLE_ADDED + - PLACEABLE_DELETED + - SPACES_AROUND_PLACEABLE + - PLACEABLE_FORMAT + - NUMBER_ADDED + - NUMBER_DELETED + - NUMBER_INCORRECT_CONVERSION + - TARGET_IS_EMPTY + - TARGET_IS_MUCH_SHORTER_THAN_SOURCE + - TARGET_IS_MUCH_LONGER_THAN_SOURCE + - TAG_ADDED + - TAG_DELETED + - SPACES_AROUND_TAGS + - TAG_ORDER_IS_CHANGED + - OPEN_CLOSED_TAG_ORDER_IS_CHANGED + - INVALID_TAG_NESTING + - TAG_IS_CHANGED + - SAME_SOURCE_DIFFERENT_TRANSLATIONS + - SAME_TRANSLATION_DIFFERENT_SOURCES + + severityLevelCodeEnum: + enum: + - DISABLED + - LOW + - MEDIUM + - HIGH + + severityLevelCodeEnumCopyForRequest: + enum: + - DISABLED + - LOW + - MEDIUM + - HIGH + + checkTypeCodeWithSettingsEnum: + enum: + - ORIGINAL_EQUALS_TARGET + - SPELLCHECK + - NUMBER_CONSISTENCY + - TARGET_IN_WRONG_LANGUAGE + - SOURCE_IN_WRONG_LANGUAGE + - SEGMENT_COMPLETENESS + - EMOJI_CONSISTENCY + - TARGET_SOURCE_CONSISTENCY + - GLOSSARY_COMPLIANCE + - OPEN_ISSUES + + checkTypeCodeOnlyWithSubtypesEnum: + enum: + - TAG_CONSISTENCY + - NUMBER_CONSISTENCY + - SEGMENT_COMPLETENESS + - NON_TRANSLATABLE_TEXT + - EMOJI_CONSISTENCY + - INSERTABLE_CONSISTENCY + - TARGET_SOURCE_CONSISTENCY + + ruleTypeCodeEnum: + enum: + - FORBIDDEN + - MISSING + - COUNT_MISMATCH + + ruleTypeCodeEnumCopyForRequest: + enum: + - FORBIDDEN + - MISSING + - COUNT_MISMATCH + + flavorCodeEnum: + enum: + - JAVA + - DOT_NET From c53a2bf1468d515c0236ad746f16ee4568a7bf39 Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Tue, 22 Oct 2024 10:42:53 +0300 Subject: [PATCH 05/21] added changes --- spec/translation_quality/checks/regex_check.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/spec/translation_quality/checks/regex_check.yaml b/spec/translation_quality/checks/regex_check.yaml index 4a05749f..0d6b7a9b 100644 --- a/spec/translation_quality/checks/regex_check.yaml +++ b/spec/translation_quality/checks/regex_check.yaml @@ -51,7 +51,8 @@ components: details: type: object nullable: true - $ref: './tqc_common.yaml#/components/schemas/regexRuleWithRuleUid' + oneOf: + - $ref: '../tqc_common.yaml#/components/schemas/regexRuleWithRuleUid' positionTypeCode: type: string enum: From 5a9ccae784c305f2d74d27ec5c985b7597c5dbed Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Tue, 22 Oct 2024 10:57:24 +0300 Subject: [PATCH 06/21] added changes --- spec/openapi.yaml | 1 + spec/translation_quality/tqc_check_result.yaml | 7 ++++--- spec/translation_quality/tqc_common.yaml | 2 ++ 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/spec/openapi.yaml b/spec/openapi.yaml index 763f77c7..c8d57c64 100644 --- a/spec/openapi.yaml +++ b/spec/openapi.yaml @@ -13133,6 +13133,7 @@ components: description: When this translation was last modified. type: string pluralForm: + nullable: true description: >- Pural form of the translation. `null` if this translation is not a plural. diff --git a/spec/translation_quality/tqc_check_result.yaml b/spec/translation_quality/tqc_check_result.yaml index 58d7f7e7..46d84aed 100644 --- a/spec/translation_quality/tqc_check_result.yaml +++ b/spec/translation_quality/tqc_check_result.yaml @@ -69,6 +69,7 @@ x-paths: - type: object properties: stringUid: + nullable: true type: string description: >- it is string part unique identifier if @@ -96,6 +97,7 @@ x-paths: - type: object properties: pluralForm: + nullable: true type: string description: plural form example: ONE @@ -536,8 +538,6 @@ x-paths: properties: checkTypeCode: type: string - schema: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse' description: check type code example: LEADING_TRAILING_SPACES details: @@ -1024,7 +1024,8 @@ x-paths: details: type: object nullable: true - $ref: './tqc_common.yaml#/components/schemas/regexRuleWithRuleUid' + oneOf: + - $ref: './tqc_common.yaml#/components/schemas/regexRuleWithRuleUid' positionTypeCode: type: string enum: diff --git a/spec/translation_quality/tqc_common.yaml b/spec/translation_quality/tqc_common.yaml index c41c4a93..348b8b94 100644 --- a/spec/translation_quality/tqc_common.yaml +++ b/spec/translation_quality/tqc_common.yaml @@ -455,6 +455,7 @@ components: type: object properties: stringUid: + nullable: true type: string description: it is string part unique identifier if string is splitted on several parts example: "" @@ -496,6 +497,7 @@ components: type: object properties: pluralForm: + nullable: true type: string description: plural form example: "ONE" From 9621418277b4c55f59ffa962e4ebe0317d212a09 Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Tue, 22 Oct 2024 11:29:36 +0300 Subject: [PATCH 07/21] added changes --- .../checks/accounts_result.yaml | 1036 +++-------------- spec/translation_quality/examples.yaml | 3 +- .../translation_quality/tqc_check_result.yaml | 616 +--------- 3 files changed, 175 insertions(+), 1480 deletions(-) diff --git a/spec/translation_quality/checks/accounts_result.yaml b/spec/translation_quality/checks/accounts_result.yaml index 17923cae..7af771fa 100644 --- a/spec/translation_quality/checks/accounts_result.yaml +++ b/spec/translation_quality/checks/accounts_result.yaml @@ -59,8 +59,10 @@ x-paths: anyOf: - title: BLACKLISTED_TERMS allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -71,8 +73,10 @@ x-paths: example: BLACKLISTED_TERMS - title: EMOJI_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - &ref_15 type: object properties: @@ -103,8 +107,10 @@ x-paths: example: EMOJI_ADDED - title: GLOBAL_CAPITALISATION_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -115,8 +121,10 @@ x-paths: example: GLOBAL_CAPITALISATION_CONSISTENCY - title: GLOSSARY_COMPLIANCE allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - allOf: - &ref_21 type: object @@ -158,8 +166,10 @@ x-paths: example: GLOSSARY_COMPLIANCE - title: GRAMMAR_CHECK allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -170,8 +180,10 @@ x-paths: example: GRAMMAR_CHECK - title: INSERTABLE_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -194,8 +206,10 @@ x-paths: example: INSERTABLE_ADDED - title: LEADING_TRAILING_SPACES allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object required: - checkTypeCode @@ -208,8 +222,10 @@ x-paths: example: LEADING_TRAILING_SPACES - title: NON_TRANSLATABLE_TEXT allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -234,8 +250,10 @@ x-paths: example: PLACEABLE_ADDED - title: NUMBER_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - &ref_19 type: object properties: @@ -266,8 +284,10 @@ x-paths: example: NUMBER_ADDED - title: ORIGINAL_EQUALS_TARGET allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - &ref_23 type: object properties: @@ -291,8 +311,10 @@ x-paths: example: ORIGINAL_EQUALS_TARGET - title: REPEATED_WORD allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -303,8 +325,10 @@ x-paths: example: REPEATED_WORD - title: SEGMENT_COMPLETENESS allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - &ref_24 type: object properties: @@ -343,8 +367,10 @@ x-paths: example: TARGET_IS_EMPTY - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - &ref_17 type: object properties: @@ -363,8 +389,10 @@ x-paths: example: SOURCE_IN_WRONG_LANGUAGE - title: SPELLCHECK allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - &ref_16 type: object properties: @@ -398,8 +426,10 @@ x-paths: example: SPELLCHECK - title: TAG_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -424,8 +454,10 @@ x-paths: example: TAG_ADDED - title: TARGET_IN_WRONG_LANGUAGE allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - &ref_18 type: object properties: @@ -444,8 +476,10 @@ x-paths: example: TARGET_IN_WRONG_LANGUAGE - title: TARGET_LENGTH_LIMIT allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -456,8 +490,10 @@ x-paths: example: TARGET_LENGTH_LIMIT - title: TARGET_SOURCE_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - &ref_20 type: object properties: @@ -491,8 +527,10 @@ x-paths: example: SAME_SOURCE_DIFFERENT_TRANSLATIONS - title: TRADEMARK_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -503,8 +541,10 @@ x-paths: example: TRADEMARK_CONSISTENCY - title: WHITESPACES allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -515,8 +555,10 @@ x-paths: example: WHITESPACES - title: PUNCTUATION_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -527,8 +569,10 @@ x-paths: example: PUNCTUATION_CONSISTENCY - title: PLURALS_REPETITION allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -539,8 +583,10 @@ x-paths: example: PLURALS_REPETITION - title: REGEX_CHECK allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -552,11 +598,14 @@ x-paths: rules: type: array items: - $ref: '../tqc_common.yaml#/components/schemas/regexRuleWithRuleUid' + $ref: >- + ../tqc_common.yaml#/components/schemas/regexRuleWithRuleUid - title: OPEN_ISSUES allOf: - - $ref: '../tqc_common.yaml#/components/schemas/profileUidResponse' - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/profileUidResponse + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - &ref_25 type: object properties: @@ -579,244 +628,8 @@ x-paths: description: check type code example: OPEN_ISSUES example: - response: - code: SUCCESS - data: - totalCount: 25 - items: - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: LEADING_TRAILING_SPACES - subTypes: [] - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: ORIGINAL_EQUALS_TARGET - subTypes: [] - localeSeverityLevels: [] - groups: [] - mustHaveIdenticalTags: true - mustHaveIdenticalCapitalization: true - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: WHITESPACES - subTypes: [] - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: SPELLCHECK - subTypes: [] - localeSeverityLevels: [] - groups: [] - skipIfWordInUserDictionary: true - skipIfWordStartsWithCapitalLetter: false - skipIfWordAppearsInSourceString: true - skipIfWordValidInSourceLocale: false - runSpellcheckForSubWords: false - - profileUid: ce6d6b5dbc12 - severityLevelCode: "LOW" - checkTypeCode: TAG_CONSISTENCY - subTypes: - - checkSubTypeCode: TAG_ADDED - severityLevelCode: "LOW" - - checkSubTypeCode: TAG_DELETED - severityLevelCode: "LOW" - - checkSubTypeCode: TAG_ORDER_IS_CHANGED - severityLevelCode: "LOW" - - checkSubTypeCode: SPACES_AROUND_TAGS - severityLevelCode: "LOW" - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: HIGH - checkTypeCode: TARGET_LENGTH_LIMIT - subTypes: [] - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: NUMBER_CONSISTENCY - subTypes: - - checkSubTypeCode: NUMBER_DELETED - severityLevelCode: LOW - - checkSubTypeCode: NUMBER_ADDED - severityLevelCode: LOW - - checkSubTypeCode: NUMBER_INCORRECT_CONVERSION - severityLevelCode: LOW - localeSeverityLevels: [] - groups: - - groupUid: b0dd258b05ee - - groupUid: a853df2cf8ac - ignoreSign: true - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: REPEATED_WORD - subTypes: [] - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: TARGET_IN_WRONG_LANGUAGE - subTypes: [] - localeSeverityLevels: [] - groups: [] - minTextLengthLimit: 40 - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: SOURCE_IN_WRONG_LANGUAGE - subTypes: [] - localeSeverityLevels: [] - groups: [] - minTextLengthLimit: 40 - - profileUid: ce6d6b5dbc12 - severityLevelCode: MEDIUM - checkTypeCode: SEGMENT_COMPLETENESS - subTypes: - - checkSubTypeCode: TARGET_IS_MUCH_SHORTER_THAN_SOURCE - severityLevelCode: MEDIUM - - checkSubTypeCode: TARGET_IS_MUCH_LONGER_THAN_SOURCE - severityLevelCode: MEDIUM - - checkSubTypeCode: TARGET_IS_EMPTY - severityLevelCode: DISABLED - localeSeverityLevels: [] - groups: [] - lowerLengthThreshold: 50 - upperLengthThreshold: 250 - minLengthThreshold: 10 - - profileUid: ce6d6b5dbc12 - severityLevelCode: MEDIUM - checkTypeCode: NON_TRANSLATABLE_TEXT - subTypes: - - checkSubTypeCode: PLACEABLE_DELETED - severityLevelCode: MEDIUM - - checkSubTypeCode: SPACES_AROUND_PLACEABLE - severityLevelCode: MEDIUM - - checkSubTypeCode: PLACEABLE_ADDED - severityLevelCode: MEDIUM - - checkSubTypeCode: PLACEABLE_FORMAT - severityLevelCode: MEDIUM - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: EMOJI_CONSISTENCY - subTypes: - - checkSubTypeCode: EMOJI_PRESENT - severityLevelCode: DISABLED - - checkSubTypeCode: EMOJI_DELETED - severityLevelCode: LOW - - checkSubTypeCode: EMOJI_ADDED - severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] - noEmojisAllowedInTarget: false - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: INSERTABLE_CONSISTENCY - subTypes: - - checkSubTypeCode: INSERTABLE_DELETED - severityLevelCode: LOW - - checkSubTypeCode: INSERTABLE_ADDED - severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: TARGET_SOURCE_CONSISTENCY - subTypes: - - checkSubTypeCode: SAME_TRANSLATION_DIFFERENT_SOURCES - severityLevelCode: LOW - - checkSubTypeCode: SAME_SOURCE_DIFFERENT_TRANSLATIONS - severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] - ignoreTagsAndPlaceholders: true - ignoreCase: true - - profileUid: ce6d6b5dbc12 - severityLevelCode: MEDIUM - checkTypeCode: BLACKLISTED_TERMS - subTypes: [] - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: MEDIUM - checkTypeCode: GLOSSARY_COMPLIANCE - subTypes: [] - localeSeverityLevels: [] - groups: [] - matchMethod: MATCH_BY_PERCENTAGE - matchThreshold: 50 - sameTermCount: true - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: TRADEMARK_CONSISTENCY - subTypes: [] - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: GRAMMAR_CHECK - subTypes: [] - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: GLOBAL_CAPITALISATION_CONSISTENCY - subTypes: [] - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: PUNCTUATION_CONSISTENCY - subTypes: [] - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: MEDIUM - checkTypeCode: PLURALS_REPETITION - subTypes: [] - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: REGEX_CHECK - subTypes: [] - groups: [] - rules: - - ruleUid: 2d83ea74c848 - severityLevelCode: LOW - ruleName: ruleName1 - ruleTypeCode: FORBIDDEN - flavorCode: JAVA - originalPattern: '@mail' - translationPattern: '@gmail' - description: ruleName1 description - caseInsensitive: true - multiLine: false - warningMessage: test warning - groups: [] - - ruleUid: ac3069e2fd30 - severityLevelCode: MEDIUM - ruleName: ruleName2 - ruleTypeCode: MISSING - flavorCode: JAVA - originalPattern: '@/d' - translationPattern: '@/d' - description: ruleName2 description - caseInsensitive: true - multiLine: false - warningMessage: test warning - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: OPEN_ISSUES - subTypes: [] - localeSeverityLevels: [] - groups: [] - sourceIssuesMustBeResolved: true - translationIssuesMustBeResolved: true + $ref: >- + ../examples.yaml#/components/examples/profiles_accounts_check_types_settings_example '400': &ref_11 description: Provided request parameters are invalid. content: @@ -1701,267 +1514,8 @@ x-paths: description: check type code example: OPEN_ISSUES examples: - ORIGINAL_EQUALS_TARGET: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: ORIGINAL_EQUALS_TARGET - subTypes: [] - localeSeverityLevels: [] - groups: [] - mustHaveIdenticalTags: true - mustHaveIdenticalCapitalization: true - WHITESPACES: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: WHITESPACES - subTypes: [] - localeSeverityLevels: [] - groups: [] - SPELLCHECK: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: SPELLCHECK - subTypes: [] - localeSeverityLevels: [] - groups: [] - skipIfWordInUserDictionary: true - skipIfWordStartsWithCapitalLetter: false - skipIfWordAppearsInSourceString: true - skipIfWordValidInSourceLocale: false - runSpellcheckForSubWords: false - TAG_CONSISTENCY: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: TAG_CONSISTENCY - subTypes: - - checkSubTypeCode: TAG_ADDED - severityLevelCode: LOW - - checkSubTypeCode: TAG_DELETED - severityLevelCode: LOW - - checkSubTypeCode: TAG_ORDER_IS_CHANGED - severityLevelCode: LOW - - checkSubTypeCode: SPACES_AROUND_TAGS - severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] - TARGET_LENGTH_LIMIT: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: HIGH - checkTypeCode: TARGET_LENGTH_LIMIT - subTypes: [] - localeSeverityLevels: [] - groups: [] - NUMBER_CONSISTENCY: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: NUMBER_CONSISTENCY - subTypes: - - checkSubTypeCode: NUMBER_DELETED - severityLevelCode: LOW - - checkSubTypeCode: NUMBER_ADDED - severityLevelCode: LOW - - checkSubTypeCode: NUMBER_INCORRECT_CONVERSION - severityLevelCode: LOW - localeSeverityLevels: [] - groups: - - groupUid: b0dd258b05ee - - groupUid: a853df2cf8ac - ignoreSign: true - REPEATED_WORD: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: REPEATED_WORD - subTypes: [] - localeSeverityLevels: [] - groups: [] - TARGET_IN_WRONG_LANGUAGE: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: TARGET_IN_WRONG_LANGUAGE - subTypes: [] - localeSeverityLevels: [] - groups: [] - minTextLengthLimit: 40 - SOURCE_IN_WRONG_LANGUAGE: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: SOURCE_IN_WRONG_LANGUAGE - subTypes: [] - localeSeverityLevels: [] - groups: [] - minTextLengthLimit: 40 - SEGMENT_COMPLETENESS: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: MEDIUM - checkTypeCode: SEGMENT_COMPLETENESS - subTypes: - - checkSubTypeCode: TARGET_IS_MUCH_SHORTER_THAN_SOURCE - severityLevelCode: MEDIUM - - checkSubTypeCode: TARGET_IS_MUCH_LONGER_THAN_SOURCE - severityLevelCode: MEDIUM - - checkSubTypeCode: TARGET_IS_EMPTY - severityLevelCode: DISABLED - localeSeverityLevels: [] - groups: [] - lowerLengthThreshold: 50 - upperLengthThreshold: 250 - minLengthThreshold: 10 - NON_TRANSLATABLE_TEXT: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: MEDIUM - checkTypeCode: NON_TRANSLATABLE_TEXT - subTypes: - - checkSubTypeCode: PLACEABLE_DELETED - severityLevelCode: MEDIUM - - checkSubTypeCode: SPACES_AROUND_PLACEABLE - severityLevelCode: MEDIUM - - checkSubTypeCode: PLACEABLE_ADDED - severityLevelCode: MEDIUM - - checkSubTypeCode: PLACEABLE_FORMAT - severityLevelCode: MEDIUM - localeSeverityLevels: [] - groups: [] - EMOJI_CONSISTENCY: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: EMOJI_CONSISTENCY - subTypes: - - checkSubTypeCode: EMOJI_PRESENT - severityLevelCode: LOW - - checkSubTypeCode: EMOJI_DELETED - severityLevelCode: DISABLED - - checkSubTypeCode: EMOJI_ADDED - severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] - noEmojisAllowedInTarget: false - INSERTABLE_CONSISTENCY: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: INSERTABLE_CONSISTENCY - subTypes: - - checkSubTypeCode: INSERTABLE_DELETED - severityLevelCode: LOW - - checkSubTypeCode: INSERTABLE_ADDED - severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] - TARGET_SOURCE_CONSISTENCY: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: TARGET_SOURCE_CONSISTENCY - subTypes: - - checkSubTypeCode: SAME_TRANSLATION_DIFFERENT_SOURCES - severityLevelCode: LOW - - checkSubTypeCode: SAME_SOURCE_DIFFERENT_TRANSLATIONS - severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] - ignoreTagsAndPlaceholders: true - ignoreCase: true - BLACKLISTED_TERMS: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: MEDIUM - checkTypeCode: BLACKLISTED_TERMS - subTypes: [] - localeSeverityLevels: [] - groups: [] - GLOSSARY_COMPLIANCE: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: DISABLED - checkTypeCode: GLOSSARY_COMPLIANCE - subTypes: [] - localeSeverityLevels: [] - groups: [] - matchMethod: MATCH_BY_PERCENTAGE - matchThreshold: 50 - sameTermCount: true - TRADEMARK_CONSISTENCY: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: TRADEMARK_CONSISTENCY - subTypes: [] - localeSeverityLevels: [] - groups: [] - GRAMMAR_CHECK: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: GRAMMAR_CHECK - subTypes: [] - localeSeverityLevels: [] - groups: [] - GLOBAL_CAPITALISATION_CONSISTENCY: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: GLOBAL_CAPITALISATION_CONSISTENCY - subTypes: [] - localeSeverityLevels: [] - groups: [] - PUNCTUATION_CONSISTENCY: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: PUNCTUATION_CONSISTENCY - subTypes: [] - localeSeverityLevels: [] - groups: [] - PLURALS_REPETITION: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: MEDIUM - checkTypeCode: PLURALS_REPETITION - subTypes: [] - localeSeverityLevels: [] - groups: [] - REGEX_CHECK: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: REGEX_CHECK - subTypes: [] - groups: [] - rules: - - ruleUid: 2d83ea74c848 - severityLevelCode: LOW - ruleName: ruleName1 - ruleTypeCode: FORBIDDEN - flavorCode: JAVA - originalPattern: '@mail' - translationPattern: '@gmail' - description: ruleName1 description - caseInsensitive: true - multiLine: false - warningMessage: test warning - groups: [] - OPEN_ISSUES: - value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: OPEN_ISSUES - subTypes: [] - localeSeverityLevels: [] - groups: [] - sourceIssuesMustBeResolved: true - translationIssuesMustBeResolved: true + $ref: >- + ../examples.yaml#/components/examples/profiles_account_check_types_settings_effective_example '400': *ref_11 '401': *ref_12 '429': *ref_13 @@ -2010,7 +1564,8 @@ x-paths: allOf: - *ref_15 - &ref_28 - $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' + $ref: >- + ../tqc_common.yaml#/components/requestBodies/targetLocaleId - &ref_29 type: object required: @@ -2019,7 +1574,8 @@ x-paths: allOf: - *ref_16 - &ref_30 - $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' + $ref: >- + ../tqc_common.yaml#/components/requestBodies/targetLocaleId - &ref_31 type: object required: @@ -2032,7 +1588,8 @@ x-paths: allOf: - *ref_17 - &ref_32 - $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' + $ref: >- + ../tqc_common.yaml#/components/requestBodies/targetLocaleId - &ref_33 type: object required: @@ -2044,7 +1601,8 @@ x-paths: required: - minTextLengthLimit - &ref_35 - $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' + $ref: >- + ../tqc_common.yaml#/components/requestBodies/targetLocaleId - *ref_18 - &ref_36 title: NUMBER_CONSISTENCY @@ -2054,7 +1612,8 @@ x-paths: allOf: - *ref_20 - &ref_37 - $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' + $ref: >- + ../tqc_common.yaml#/components/requestBodies/targetLocaleId - &ref_38 type: object required: @@ -2075,7 +1634,8 @@ x-paths: allOf: - *ref_23 - &ref_40 - $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' + $ref: >- + ../tqc_common.yaml#/components/requestBodies/targetLocaleId - &ref_41 type: object required: @@ -2085,7 +1645,8 @@ x-paths: allOf: - *ref_24 - &ref_42 - $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' + $ref: >- + ../tqc_common.yaml#/components/requestBodies/targetLocaleId - &ref_43 title: OPEN_ISSUES allOf: @@ -2140,47 +1701,8 @@ x-paths: allOf: - *ref_25 examples: - EMOJI_CONSISTENCY: - value: - noEmojisAllowedInTarget: true - SPELLCHECK: - value: - skipIfWordInUserDictionary: false - skipIfWordStartsWithCapitalLetter: true - skipIfWordAppearsInSourceString: false - skipIfWordValidInSourceLocale: true - runSpellcheckForSubWords: true - SOURCE_IN_WRONG_LANGUAGE: - value: - minTextLengthLimit: 10 - TARGET_IN_WRONG_LANGUAGE: - value: - minTextLengthLimit: 15 - NUMBER_CONSISTENCY: - value: - ignoreSign: true - TARGET_SOURCE_CONSISTENCY: - value: - ignoreTagsAndPlaceholders: true - ignoreCase: true - GLOSSARY_COMPLIANCE: - value: - matchMethod: MATCH_BY_PERCENTAGE - matchThreshold: 10 - sameTermCount: true - ORIGINAL_EQUALS_TARGET: - value: - mustHaveIdenticalTags: false - mustHaveIdenticalCapitalization: false - SEGMENT_COMPLETENESS: - value: - lowerLengthThreshold: 10 - upperLengthThreshold: 20 - minLengthThreshold: 15 - OPEN_ISSUES: - value: - sourceIssuesMustBeResolved: true - translationIssuesMustBeResolved: true + $ref: >- + ../examples.yaml#/components/examples/profiles_accounts_check_types_checkType_settings_example '400': *ref_11 '401': *ref_12 '429': *ref_13 @@ -2267,47 +1789,8 @@ x-paths: properties: data: *ref_44 examples: - EMOJI_CONSISTENCY: - value: - noEmojisAllowedInTarget: true - SPELLCHECK: - value: - skipIfWordInUserDictionary: false - skipIfWordStartsWithCapitalLetter: true - skipIfWordAppearsInSourceString: false - skipIfWordValidInSourceLocale: true - runSpellcheckForSubWords: true - SOURCE_IN_WRONG_LANGUAGE: - value: - minTextLengthLimit: 10 - TARGET_IN_WRONG_LANGUAGE: - value: - minTextLengthLimit: 15 - NUMBER_CONSISTENCY: - value: - ignoreSign: true - TARGET_SOURCE_CONSISTENCY: - value: - ignoreTagsAndPlaceholders: true - ignoreCase: true - GLOSSARY_COMPLIANCE: - value: - matchMethod: MATCH_BY_PERCENTAGE - matchThreshold: 10 - sameTermCount: true - ORIGINAL_EQUALS_TARGET: - value: - mustHaveIdenticalTags: false - mustHaveIdenticalCapitalization: false - SEGMENT_COMPLETENESS: - value: - lowerLengthThreshold: 10 - upperLengthThreshold: 20 - minLengthThreshold: 15 - OPEN_ISSUES: - value: - sourceIssuesMustBeResolved: true - translationIssuesMustBeResolved: true + $ref: >- + ../examples.yaml#/components/examples/profiles_accounts_check_types_checkType_group_settings_example '400': *ref_11 '401': *ref_12 '429': *ref_13 @@ -2365,7 +1848,8 @@ x-paths: anyOf: - title: BLACKLISTED_TERMS allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -2376,7 +1860,8 @@ x-paths: example: BLACKLISTED_TERMS - title: EMOJI_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - *ref_15 - type: object properties: @@ -2401,7 +1886,8 @@ x-paths: example: EMOJI_ADDED - title: GLOBAL_CAPITALISATION_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -2412,7 +1898,8 @@ x-paths: example: GLOBAL_CAPITALISATION_CONSISTENCY - title: GLOSSARY_COMPLIANCE allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - *ref_21 - type: object properties: @@ -2434,7 +1921,8 @@ x-paths: example: GLOSSARY_COMPLIANCE - title: GRAMMAR_CHECK allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -2445,7 +1933,8 @@ x-paths: example: GRAMMAR_CHECK - title: INSERTABLE_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -2468,7 +1957,8 @@ x-paths: example: INSERTABLE_ADDED - title: LEADING_TRAILING_SPACES allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object required: - checkTypeCode @@ -2481,7 +1971,8 @@ x-paths: example: LEADING_TRAILING_SPACES - title: NON_TRANSLATABLE_TEXT allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -2506,7 +1997,8 @@ x-paths: example: PLACEABLE_ADDED - title: NUMBER_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - *ref_19 - type: object properties: @@ -2531,7 +2023,8 @@ x-paths: example: NUMBER_ADDED - title: ORIGINAL_EQUALS_TARGET allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - *ref_23 - type: object required: @@ -2545,7 +2038,8 @@ x-paths: example: ORIGINAL_EQUALS_TARGET - title: REPEATED_WORD allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -2556,7 +2050,8 @@ x-paths: example: REPEATED_WORD - title: SEGMENT_COMPLETENESS allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - *ref_24 - type: object properties: @@ -2581,7 +2076,8 @@ x-paths: example: TARGET_IS_EMPTY - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - *ref_17 - type: object properties: @@ -2593,7 +2089,8 @@ x-paths: example: SOURCE_IN_WRONG_LANGUAGE - title: SPELLCHECK allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - *ref_16 - type: object properties: @@ -2605,7 +2102,8 @@ x-paths: example: SPELLCHECK - title: TAG_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -2630,7 +2128,8 @@ x-paths: example: TAG_ADDED - title: TARGET_IN_WRONG_LANGUAGE allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - *ref_18 - type: object properties: @@ -2642,7 +2141,8 @@ x-paths: example: TARGET_IN_WRONG_LANGUAGE - title: TARGET_LENGTH_LIMIT allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -2653,7 +2153,8 @@ x-paths: example: TARGET_LENGTH_LIMIT - title: TARGET_SOURCE_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - *ref_20 - type: object properties: @@ -2677,7 +2178,8 @@ x-paths: example: SAME_SOURCE_DIFFERENT_TRANSLATIONS - title: TRADEMARK_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -2688,7 +2190,8 @@ x-paths: example: TRADEMARK_CONSISTENCY - title: WHITESPACES allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -2699,7 +2202,8 @@ x-paths: example: WHITESPACES - title: PUNCTUATION_CONSISTENCY allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -2710,7 +2214,8 @@ x-paths: example: PUNCTUATION_CONSISTENCY - title: PLURALS_REPETITION allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -2721,7 +2226,8 @@ x-paths: example: PLURALS_REPETITION - title: REGEX_CHECK allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - type: object properties: checkTypeCode: @@ -2733,10 +2239,12 @@ x-paths: rules: type: array items: - $ref: '../tqc_common.yaml#/components/schemas/regexRuleWithRuleUid' + $ref: >- + ../tqc_common.yaml#/components/schemas/regexRuleWithRuleUid - title: OPEN_ISSUES allOf: - - $ref: '../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective' + - $ref: >- + ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - *ref_25 - type: object required: @@ -2749,208 +2257,8 @@ x-paths: description: check type code example: OPEN_ISSUES example: - response: - code: SUCCESS - data: - totalCount: 24 - items: - - severityLevelCode: LOW - checkTypeCode: LEADING_TRAILING_SPACES - subTypes: [] - localeSeverityLevels: [] - groups: [] - - severityLevelCode: LOW - checkTypeCode: ORIGINAL_EQUALS_TARGET - subTypes: [] - localeSeverityLevels: [] - groups: [] - mustHaveIdenticalTags: true - mustHaveIdenticalCapitalization: true - - severityLevelCode: LOW - checkTypeCode: WHITESPACES - subTypes: [] - localeSeverityLevels: [] - groups: [] - - severityLevelCode: LOW - checkTypeCode: SPELLCHECK - subTypes: [] - localeSeverityLevels: [] - groups: [] - skipIfWordInUserDictionary: true - skipIfWordStartsWithCapitalLetter: false - skipIfWordAppearsInSourceString: true - skipIfWordValidInSourceLocale: false - runSpellcheckForSubWords: false - - severityLevelCode: LOW - checkTypeCode: TAG_CONSISTENCY - subTypes: - - checkSubTypeCode: TAG_ADDED - severityLevelCode: LOW - - checkSubTypeCode: TAG_DELETED - severityLevelCode: LOW - - checkSubTypeCode: TAG_ORDER_IS_CHANGED - severityLevelCode: LOW - - checkSubTypeCode: SPACES_AROUND_TAGS - severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] - - severityLevelCode: HIGH - checkTypeCode: TARGET_LENGTH_LIMIT - subTypes: [] - localeSeverityLevels: [] - groups: [] - - severityLevelCode: LOW - checkTypeCode: NUMBER_CONSISTENCY - subTypes: - - checkSubTypeCode: NUMBER_DELETED - severityLevelCode: LOW - - checkSubTypeCode: NUMBER_ADDED - severityLevelCode: LOW - - checkSubTypeCode: NUMBER_INCORRECT_CONVERSION - severityLevelCode: LOW - localeSeverityLevels: [] - groups: - - groupUid: b0dd258b05ee - - groupUid: a853df2cf8ac - ignoreSign: true - - severityLevelCode: LOW - checkTypeCode: REPEATED_WORD - subTypes: [] - localeSeverityLevels: [] - groups: [] - - severityLevelCode: LOW - checkTypeCode: TARGET_IN_WRONG_LANGUAGE - subTypes: [] - localeSeverityLevels: [] - groups: [] - minTextLengthLimit: 40 - - severityLevelCode: LOW - checkTypeCode: SOURCE_IN_WRONG_LANGUAGE - subTypes: [] - localeSeverityLevels: [] - groups: [] - minTextLengthLimit: 40 - - severityLevelCode: MEDIUM - checkTypeCode: SEGMENT_COMPLETENESS - subTypes: - - checkSubTypeCode: TARGET_IS_MUCH_SHORTER_THAN_SOURCE - severityLevelCode: MEDIUM - - checkSubTypeCode: TARGET_IS_MUCH_LONGER_THAN_SOURCE - severityLevelCode: MEDIUM - - checkSubTypeCode: TARGET_IS_EMPTY - severityLevelCode: DISABLED - localeSeverityLevels: [] - groups: [] - lowerLengthThreshold: 50 - upperLengthThreshold: 250 - minLengthThreshold: 10 - - severityLevelCode: MEDIUM - checkTypeCode: NON_TRANSLATABLE_TEXT - subTypes: - - checkSubTypeCode: PLACEABLE_DELETED - severityLevelCode: MEDIUM - - checkSubTypeCode: SPACES_AROUND_PLACEABLE - severityLevelCode: MEDIUM - - checkSubTypeCode: PLACEABLE_ADDED - severityLevelCode: MEDIUM - - checkSubTypeCode: PLACEABLE_FORMAT - severityLevelCode: MEDIUM - localeSeverityLevels: [] - groups: [] - - severityLevelCode: LOW - checkTypeCode: EMOJI_CONSISTENCY - subTypes: - - checkSubTypeCode: EMOJI_PRESENT - severityLevelCode: DISABLED - - checkSubTypeCode: EMOJI_DELETED - severityLevelCode: LOW - - checkSubTypeCode: EMOJI_ADDED - severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] - noEmojisAllowedInTarget: false - - severityLevelCode: LOW - checkTypeCode: INSERTABLE_CONSISTENCY - subTypes: - - checkSubTypeCode: INSERTABLE_DELETED - severityLevelCode: LOW - - checkSubTypeCode: INSERTABLE_ADDED - severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] - - severityLevelCode: LOW - checkTypeCode: TARGET_SOURCE_CONSISTENCY - subTypes: - - checkSubTypeCode: SAME_TRANSLATION_DIFFERENT_SOURCES - severityLevelCode: LOW - - checkSubTypeCode: SAME_SOURCE_DIFFERENT_TRANSLATIONS - severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] - ignoreTagsAndPlaceholders: true - ignoreCase: true - - severityLevelCode: MEDIUM - checkTypeCode: BLACKLISTED_TERMS - subTypes: [] - localeSeverityLevels: [] - groups: [] - - severityLevelCode: MEDIUM - checkTypeCode: GLOSSARY_COMPLIANCE - subTypes: [] - localeSeverityLevels: [] - groups: [] - matchMethod: MATCH_BY_PERCENTAGE - matchThreshold: 50 - sameTermCount: true - - severityLevelCode: LOW - checkTypeCode: TRADEMARK_CONSISTENCY - subTypes: [] - localeSeverityLevels: [] - groups: [] - - severityLevelCode: LOW - checkTypeCode: GRAMMAR_CHECK - subTypes: [] - localeSeverityLevels: [] - groups: [] - - severityLevelCode: LOW - checkTypeCode: GLOBAL_CAPITALISATION_CONSISTENCY - subTypes: [] - localeSeverityLevels: [] - groups: [] - - severityLevelCode: LOW - checkTypeCode: PUNCTUATION_CONSISTENCY - subTypes: [] - localeSeverityLevels: [] - groups: [] - - severityLevelCode: MEDIUM - checkTypeCode: PLURALS_REPETITION - subTypes: [] - localeSeverityLevels: [] - groups: [] - - severityLevelCode: LOW - checkTypeCode: REGEX_CHECK - subTypes: [] - groups: [] - rules: - - ruleUid: 2d83ea74c848 - severityLevelCode: LOW - ruleName: ruleName1 - ruleTypeCode: FORBIDDEN - flavorCode: JAVA - originalPattern: '@mail' - translationPattern: '@gmail' - description: ruleName1 description - caseInsensitive: true - multiLine: false - warningMessage: test warning - groups: [] - - severityLevelCode: LOW - checkTypeCode: OPEN_ISSUES - subTypes: [] - localeSeverityLevels: [] - groups: [] - sourceIssuesMustBeResolved: true - translationIssuesMustBeResolved: true + $ref: >- + ../examples.yaml#/components/examples/projects_check_types_settings_example '400': *ref_11 '401': *ref_12 '429': *ref_13 diff --git a/spec/translation_quality/examples.yaml b/spec/translation_quality/examples.yaml index c1dcfdd3..27c99e89 100644 --- a/spec/translation_quality/examples.yaml +++ b/spec/translation_quality/examples.yaml @@ -465,8 +465,7 @@ components: "pluralForm": null "useDefaultSettings": false "checkTypeCodes": - - "BLACKLISTED_TERMS" - - "EMOJI_CONSISTENCY" + - $ref: './tqc_common.yaml#/components/schemas/checkTypeCodeEnum' tqc_check_response_example: BLACKLISTED_TERMS: diff --git a/spec/translation_quality/tqc_check_result.yaml b/spec/translation_quality/tqc_check_result.yaml index 46d84aed..d9152a8e 100644 --- a/spec/translation_quality/tqc_check_result.yaml +++ b/spec/translation_quality/tqc_check_result.yaml @@ -143,26 +143,7 @@ x-paths: [check type codes](#operation/getTranslationQualityCheckTypes) example: - targetLocaleId: en-US - sourceLocaleId: fr-FR - skipSuggestions: false - strings: - - originalString: Bonjour © - translation: Hello - hashcode: 9091152182c69d9b72069ac1290fe2345 - stringUid: null - pluralFormGroupUid: null - pluralForm: null - - originalString: Bonjour 100 - translation: Hello 100 - hashcode: 1091152182c69d9b72069ac1290fe23999 - stringUid: null - pluralFormGroupUid: null - pluralForm: null - useDefaultSettings: false - checkTypeCodes: - - BLACKLISTED_TERMS - - EMOJI_CONSISTENCY + $ref: './examples.yaml#/components/examples/tqc_check_request_body_example' responses: '200': description: OK @@ -1063,600 +1044,7 @@ x-paths: description: position type code example: TARGET examples: - BLACKLISTED_TERMS: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: blacklist_term - translation: blacklist_term - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: BLACKLISTED_TERMS - severityLevelCode: MEDIUM - positions: - - from: 0 - to: 14 - details: - blacklistedTermUid: uidgj1 - termText: blacklist_term - alternatives: [] - notes: '' - positionTypeCode: TARGET - EMOJI_CONSISTENCY: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Bonjour 😀 - translation: Hello - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: EMOJI_CONSISTENCY - severityLevelCode: LOW - positions: - - from: 14 - to: 16 - details: - emoji: 😀 - type: EMOJI_DELETED - positionTypeCode: SOURCE - GLOBAL_CAPITALISATION_CONSISTENCY: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: ATTENTION - translation: WARNINg - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: GLOBAL_CAPITALISATION_CONSISTENCY - severityLevelCode: LOW - positions: - - from: 0 - to: 7 - details: null - positionTypeCode: TARGET - GLOSSARY_COMPLIANCE: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: resize - translation: поменять - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: GLOSSARY_COMPLIANCE - severityLevelCode: MEDIUM - positions: - - from: 0 - to: 6 - details: - glossaryTerm: - termUid: cdd443b9-814f-442c-9ba6-4d97e0afce74 - translation: - localeId: ru-RU - translatedTerm: изменить размер - notes: '' - translatorUserUid: null - lockTranslation: false - submittedForTranslation: false - createdDate: '2018-11-16T16:06:53Z' - modifiedDate: '2018-11-16T16:06:53Z' - termText: resize - caseSensitive: false - exactMatch: false - definition: '' - variations: '' - synonyms: '' - antonyms: '' - seo: false - doNotTranslate: false - notes: '' - partOfSpeechCode: UNSPECIFIED - createdByUserUid: f64d50d91867 - createdDate: '2018-11-16T16:06:05Z' - modifiedDate: '2018-11-16T16:06:05Z' - positionTypeCode: SOURCE - INSERTABLE_CONSISTENCY: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Bonjour
- translation: Hello - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: INSERTABLE_CONSISTENCY - severityLevelCode: LOW - positions: - - from: 13 - to: 17 - details: - insertable:
- insertableType: BR_TAG - type: INSERTABLE_DELETED - positionTypeCode: SOURCE - LEADING_TRAILING_SPACES: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Bonjour - translation: ' Hello ' - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: LEADING_TRAILING_SPACES - severityLevelCode: LOW - positions: - - from: 0 - to: 1 - - from: 6 - to: 7 - details: null - positionTypeCode: TARGET - NON_TRANSLATABLE_TEXT: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Bonjour {0} - translation: Hello - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: NON_TRANSLATABLE_TEXT - severityLevelCode: MEDIUM - positions: - - from: 6 - to: 9 - details: - placeable: '{0}' - type: PLACEABLE_DELETED - positionTypeCode: SOURCE - NUMBER_CONSISTENCY: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Bonjour 1000 - translation: Hello 20 - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: NUMBER_CONSISTENCY - severityLevelCode: LOW - positions: - - from: 6 - to: 10 - details: - type: NUMBER_DELETED - number: '1000' - positionTypeCode: SOURCE - - checkTypeCode: NUMBER_CONSISTENCY - severityLevelCode: LOW - positions: - from: 5 - to: 7 - details: - type: NUMBER_ADDED - number: '20' - positionTypeCode: TARGET - REPEATED_WORD: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Bonjour - translation: Hello Hello - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: REPEATED_WORD - severityLevelCode: LOW - positions: - from: 5 - to: 9 - details: - word: Hello - positionTypeCode: TARGET - SEGMENT_COMPLETENESS: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Le chien a mangé mes devoirs. - translation: The dog ate - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: SEGMENT_COMPLETENESS - severityLevelCode: MEDIUM - positions: - from: 0 - to: 10 - details: - type: TARGET_IS_MUCH_SHORTER_THAN_SOURCE - positionTypeCode: TARGET - SOURCE_IN_WRONG_LANGUAGE: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Der Hund hat meine Hausaufgaben gegessen. - translation: The dog ate my homework. - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: SOURCE_IN_WRONG_LANGUAGE - severityLevelCode: LOW - positions: - from: 0 - to: 63 - details: null - positionTypeCode: SOURCE - SPELLCHECK: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Le chien a mangé mes devoirs. - translation: The dog ate my homewrk. - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: SPELLCHECK - severityLevelCode: MEDIUM - positions: - from: 0 - to: 5 - details: - word: homewrk - suggestions: - - homework - positionTypeCode: TARGET - TAG_CONSISTENCY: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString:

Bonjour

- translation:

Hello - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: TAG_CONSISTENCY - severityLevelCode: MEDIUM - positions: - from: 8 - to: 12 - details: - tag:

- type: TAG_DELETED - positionTypeCode: SOURCE - TARGET_LENGTH_LIMIT: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Bonjour - translation: Hello - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: TARGET_LENGTH_LIMIT - severityLevelCode: HIGH - positions: - from: 0 - to: 4 - details: null - positionTypeCode: TARGET - TARGET_IN_WRONG_LANGUAGE: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Le chien a mangé mes devoirs. - translation: Der Hund hat meine Hausaufgaben gegessen. - hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: TARGET_IN_WRONG_LANGUAGE - severityLevelCode: LOW - positions: - from: 0 - to: 64 - details: null - positionTypeCode: TARGET - TARGET_SOURCE_CONSISTENCY: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Le chien a mangé mes devoirs. - translation: The dog have ate my homework. - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: TARGET_SOURCE_CONSISTENCY - severityLevelCode: LOW - positions: - from: 0 - to: 27 - details: - type: SAME_SOURCE_DIFFERENT_TRANSLATIONS - originalString: Le chien a mangé mes devoirs. - translation: The dog have ate my homework. - positionTypeCode: TARGET - TRADEMARK_CONSISTENCY: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Bonjour © - translation: Hello - hashcode: 9091152182c69d9b72069ac1290fe2345 - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: TRADEMARK_CONSISTENCY - severityLevelCode: LOW - positions: - from: 6 - to: 7 - details: - trademarkTypeCode: COPYRIGHT - positionTypeCode: SOURCE - WHITESPACES: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Bonjour 100 - translation: Hello 100 - hashcode: 1091152182c69d9b72069ac1290fe23999 - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: WHITESPACES - severityLevelCode: LOW - positions: - from: 4 - to: 6 - details: null - positionTypeCode: TARGET - GRAMMAR_CHECK: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Le chien a mangé mes devoirs. - translation: The dog have ate my homework. - hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: GRAMMAR_CHECK - severityLevelCode: LOW - positions: - from: 9 - to: 13 - details: - text: ate - message: Possible agreement error - description: 'Agreement: ''have'' + past/present tense' - mistakeTypeCode: Grammar - suggestions: - - eaten - positionTypeCode: TARGET - ORIGINAL_EQUALS_TARGET: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: hello - translation: hello - hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: ORIGINAL_EQUALS_TARGET - severityLevelCode: LOW - positions: - from: 0 - to: 5 - details: - types: - - IDENTICAL_CAPITALIZATION - - IDENTICAL_TAGS - positionTypeCode: TARGET - PUNCTUATION_CONSISTENCY: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Hello! - translation: Привет. Как дела? - hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: PUNCTUATION_CONSISTENCY - severityLevelCode: LOW - positions: - from: 5 - to: 6 - details: - punctuationMark: '!' - type: PUNCTUATION_MARK_DELETED - punctuationMarkType: TERMINAL - positionTypeCode: SOURCE - PLURALS_REPETITION: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: 2 rows - translation: 2 rows - hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 - stringUid: null - pluralFormGroupUid: a0b1acda22fc97da9c2b9ae5f3b25888 - pluralForm: MANY - mistakes: - - checkTypeCode: PLURALS_REPETITION - severityLevelCode: MEDIUM - positions: - from: 0 - to: 5 - details: - pluralFormGroupUid: a0b1acda22fc97da9c2b9ae5f3b25888 - repeatedPluralForms: - - MANY - - FEW - positionTypeCode: TARGET - REGEX_CHECK: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: test@gmail - translation: test@mail - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: REGEX_CHECK - severityLevelCode: LOW - positions: - - from: 5 - to: 10 - details: - ruleUid: 30606c59ee92 - severityLevelCode: LOW - ruleName: name1 - ruleTypeCode: FORBIDDEN - flavorCode: JAVA - originalPattern: '@f1' - translationPattern: '@f1' - description: name1 description - caseInsensitive: true - multiLine: false - warningMessage: test warning - positionTypeCode: TARGET - ignored: false - OPEN_ISSUES: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: hello - translation: hello - hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: OPEN_ISSUES - severityLevelCode: LOW - positions: - from: 0 - to: 5 - details: - sourceIssuesCount: 5 - translationIssuesCount: 3 - positionTypeCode: TARGET + $ref: './examples.yaml#/components/examples/tqc_check_response_example' '400': description: Provided request parameters are invalid. content: From a22c95ee742b4cf6c10cc559bea6dacd4c19cb90 Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Tue, 22 Oct 2024 15:16:17 +0300 Subject: [PATCH 08/21] added changes --- spec/openapi.yaml | 10 +- spec/process-yaml.js | 3 +- .../{checks => }/accounts.yaml | 160 +- .../{checks => }/accounts_result.yaml | 1669 +++++++---- spec/translation_quality/examples.yaml | 3 +- spec/translation_quality/tqc_check.yaml | 7 +- .../translation_quality/tqc_check_result.yaml | 2450 +++++++++++------ 7 files changed, 2868 insertions(+), 1434 deletions(-) rename spec/translation_quality/{checks => }/accounts.yaml (51%) rename spec/translation_quality/{checks => }/accounts_result.yaml (65%) diff --git a/spec/openapi.yaml b/spec/openapi.yaml index c8d57c64..ed429f9e 100644 --- a/spec/openapi.yaml +++ b/spec/openapi.yaml @@ -8843,13 +8843,13 @@ paths: $ref: './translation_quality/profiles_result.yaml#/x-paths/default_profile' /translation-quality-api/v2/accounts/{accountUid}/profiles/{profileUid}/check-types: - $ref: './translation_quality/checks/accounts_result.yaml#/x-paths/profiles_check_types_settings' + $ref: './translation_quality/accounts_result.yaml#/x-paths/profiles_check_types_settings' /translation-quality-api/v2/accounts/{accountUid}/profiles/{profileUid}/check-types/{checkTypeCode}: - $ref: './translation_quality/checks/accounts_result.yaml#/x-paths/profiles_check_types_settings_effective' + $ref: './translation_quality/accounts_result.yaml#/x-paths/profiles_check_types_settings_effective' /translation-quality-api/v2/accounts/{accountUid}/profiles/{profileUid}/check-types/{checkTypeCode}/settings: - $ref: './translation_quality/checks/accounts_result.yaml#/x-paths/profiles_check_types_checkType_settings' + $ref: './translation_quality/accounts_result.yaml#/x-paths/profiles_check_types_checkType_settings' /translation-quality-api/v2/accounts/{accountUid}/profiles/{profileUid}/check-types/{checkTypeCode}/severity-level: $ref: './translation_quality/check_type_severity_level_result.yaml#/x-paths/profiles_check_type_severity_level' @@ -8864,7 +8864,7 @@ paths: $ref: './translation_quality/account_settings_result.yaml#/x-paths/profiles_check_type_groups_group' /translation-quality-api/v2/accounts/{accountUid}/profiles/{profileUid}/check-types/{checkTypeCode}/groups/{groupUid}/settings: - $ref: './translation_quality/checks/accounts_result.yaml#/x-paths/profiles_check_types_checkType_group_settings' + $ref: './translation_quality/accounts_result.yaml#/x-paths/profiles_check_types_checkType_group_settings' /translation-quality-api/v2/accounts/{accountUid}/profiles/{profileUid}/check-types/{checkTypeCode}/groups/{groupUid}/locales: $ref: './translation_quality/account_settings_result.yaml#/x-paths/profiles_check_type_groups_group_locales' @@ -8903,7 +8903,7 @@ paths: $ref: './translation_quality/regex_check_settings_result.yaml#/x-paths/profiles_regex_check_type_rule_group_severity_level' /translation-quality-api/v2/projects/{projectId}/locales/{localeId}/check-types: - $ref: './translation_quality/checks/accounts_result.yaml#/x-paths/get_project_check_types_settings' + $ref: './translation_quality/accounts_result.yaml#/x-paths/get_project_check_types_settings' /translation-quality-api/v2/accounts/{accountUid}/projects/{projectId}/check: $ref: './translation_quality/tqc_check_result.yaml#/x-paths/tqc_check' diff --git a/spec/process-yaml.js b/spec/process-yaml.js index ee3ec928..5b767cd9 100644 --- a/spec/process-yaml.js +++ b/spec/process-yaml.js @@ -41,10 +41,11 @@ try { const makeResultFunction = async() => { await makeResultForCertainFileFunction("./spec/translation_quality/dictionaries.yaml", "./spec/translation_quality/dictionaries_result.yaml", "./spec/translation_quality"); await makeResultForCertainFileFunction("./spec/translation_quality/profiles.yaml", "./spec/translation_quality/profiles_result.yaml", "./spec/translation_quality"); - await makeResultForCertainFileFunction("./spec/translation_quality/checks/accounts.yaml", "./spec/translation_quality/checks/accounts_result.yaml", "./spec/translation_quality/checks"); + await makeResultForCertainFileFunction("./spec/translation_quality/accounts.yaml", "./spec/translation_quality/accounts_result.yaml", "./spec/translation_quality"); await makeResultForCertainFileFunction("./spec/translation_quality/check_type_severity_level.yaml", "./spec/translation_quality/check_type_severity_level_result.yaml", "./spec/translation_quality"); await makeResultForCertainFileFunction("./spec/translation_quality/account_settings.yaml", "./spec/translation_quality/account_settings_result.yaml", "./spec/translation_quality"); await makeResultForCertainFileFunction("./spec/translation_quality/tqc_check.yaml", "./spec/translation_quality/tqc_check_result.yaml", "./spec/translation_quality"); + // await makeResultForCertainFileFunction("/Users/alubenskyi/Documents/repos/api-docs/spec/translation_quality/tqc_check.yaml", "./spec/translation_quality/tqc_check_result.yaml", "./spec/translation_quality"); await makeResultForCertainFileFunction("./spec/translation_quality/regex_check_settings.yaml", "./spec/translation_quality/regex_check_settings_result.yaml", "./spec/translation_quality"); } makeResultFunction(); diff --git a/spec/translation_quality/checks/accounts.yaml b/spec/translation_quality/accounts.yaml similarity index 51% rename from spec/translation_quality/checks/accounts.yaml rename to spec/translation_quality/accounts.yaml index a2ae4535..b7772be9 100644 --- a/spec/translation_quality/checks/accounts.yaml +++ b/spec/translation_quality/accounts.yaml @@ -9,8 +9,8 @@ x-paths: - Translation quality checks operationId: getProfilesAccountCheckTypesSettings parameters: - - $ref: '../../api_common.yaml#/components/parameters/accountUid' - - $ref: './../tqc_common.yaml#/components/parameters/profileUidPathParameter' + - $ref: '../api_common.yaml#/components/parameters/accountUid' + - $ref: './tqc_common.yaml#/components/parameters/profileUidPathParameter' responses: 200: @@ -20,15 +20,15 @@ x-paths: schema: $ref: '#/components/schemas/ProfilesTqcAccountGetCheckTypesResponse' example: - $ref: '../examples.yaml#/components/examples/profiles_accounts_check_types_settings_example' + $ref: 'examples.yaml#/components/examples/profiles_accounts_check_types_settings_example' 400: - $ref: '../../openapi.yaml#/components/responses/Error400ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' 401: - $ref: '../../openapi.yaml#/components/responses/Error401ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' 429: - $ref: '../../openapi.yaml#/components/responses/Error429ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' 500: - $ref: '../../openapi.yaml#/components/responses/Error500ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -43,9 +43,9 @@ x-paths: - Translation quality checks operationId: getProfilesSingleCheckTypeSettings parameters: - - $ref: '../../api_common.yaml#/components/parameters/accountUid' - - $ref: './../tqc_common.yaml#/components/parameters/profileUidPathParameter' - - $ref: '../tqc_common.yaml#/components/parameters/checkTypeCodePathParameter' + - $ref: '../api_common.yaml#/components/parameters/accountUid' + - $ref: './tqc_common.yaml#/components/parameters/profileUidPathParameter' + - $ref: './tqc_common.yaml#/components/parameters/checkTypeCodePathParameter' responses: 200: @@ -56,15 +56,15 @@ x-paths: allOf: - $ref: '#/components/schemas/ProfilesAccountCheckTypeEffectiveResponse' examples: - $ref: '../examples.yaml#/components/examples/profiles_account_check_types_settings_effective_example' + $ref: './examples.yaml#/components/examples/profiles_account_check_types_settings_effective_example' 400: - $ref: '../../openapi.yaml#/components/responses/Error400ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' 401: - $ref: '../../openapi.yaml#/components/responses/Error401ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' 429: - $ref: '../../openapi.yaml#/components/responses/Error429ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' 500: - $ref: '../../openapi.yaml#/components/responses/Error500ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -79,16 +79,16 @@ x-paths: - Translation quality checks operationId: profilesUpdateAccountCheckTypesSettings parameters: - - $ref: '../../api_common.yaml#/components/parameters/accountUid' - - $ref: './../tqc_common.yaml#/components/parameters/profileUidPathParameter' - - $ref: '../tqc_common.yaml#/components/parameters/checkTypeCodeWithSettingsPathParameter' + - $ref: '../api_common.yaml#/components/parameters/accountUid' + - $ref: './tqc_common.yaml#/components/parameters/profileUidPathParameter' + - $ref: './tqc_common.yaml#/components/parameters/checkTypeCodeWithSettingsPathParameter' requestBody: description: '' required: true content: application/json: schema: - $ref: '../tqc_common.yaml#/components/schemas/ProfilesAccountCheckTypeApplySettingsRequestOneOf' + $ref: './tqc_common.yaml#/components/schemas/ProfilesAccountCheckTypeApplySettingsRequestOneOf' responses: 200: @@ -98,15 +98,15 @@ x-paths: schema: $ref: '#/components/schemas/ProfilesAccountCheckTypeApplySettingsResponse' examples: - $ref: '../examples.yaml#/components/examples/profiles_accounts_check_types_checkType_settings_example' + $ref: './examples.yaml#/components/examples/profiles_accounts_check_types_checkType_settings_example' 400: - $ref: '../../openapi.yaml#/components/responses/Error400ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' 401: - $ref: '../../openapi.yaml#/components/responses/Error401ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' 429: - $ref: '../../openapi.yaml#/components/responses/Error429ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' 500: - $ref: '../../openapi.yaml#/components/responses/Error500ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -121,17 +121,17 @@ x-paths: - Translation quality checks operationId: updateProfilesCheckTypeGroupSettings parameters: - - $ref: '../../api_common.yaml#/components/parameters/accountUid' - - $ref: './../tqc_common.yaml#/components/parameters/profileUidPathParameter' - - $ref: '../tqc_common.yaml#/components/parameters/checkTypeCodeWithSettingsPathParameter' - - $ref: '../tqc_common.yaml#/components/parameters/groupUidPathParameter' + - $ref: '../api_common.yaml#/components/parameters/accountUid' + - $ref: './tqc_common.yaml#/components/parameters/profileUidPathParameter' + - $ref: './tqc_common.yaml#/components/parameters/checkTypeCodeWithSettingsPathParameter' + - $ref: './tqc_common.yaml#/components/parameters/groupUidPathParameter' requestBody: description: '' required: true content: application/json: schema: - $ref: '../tqc_common.yaml#/components/schemas/ProfilesAccountCheckTypeApplyGroupSettingsRequestOneOf' + $ref: './tqc_common.yaml#/components/schemas/ProfilesAccountCheckTypeApplyGroupSettingsRequestOneOf' responses: 200: @@ -141,15 +141,15 @@ x-paths: schema: $ref: '#/components/schemas/ProfilesAccountCheckTypeApplyGroupSettingsResponse' examples: - $ref: '../examples.yaml#/components/examples/profiles_accounts_check_types_checkType_group_settings_example' + $ref: './examples.yaml#/components/examples/profiles_accounts_check_types_checkType_group_settings_example' 400: - $ref: '../../openapi.yaml#/components/responses/Error400ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' 401: - $ref: '../../openapi.yaml#/components/responses/Error401ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' 429: - $ref: '../../openapi.yaml#/components/responses/Error429ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' 500: - $ref: '../../openapi.yaml#/components/responses/Error500ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -164,8 +164,8 @@ x-paths: - Translation quality checks operationId: getProjectCheckTypesSettings parameters: - - $ref: '../../api_common.yaml#/components/parameters/projectId' - - $ref: '../../api_common.yaml#/components/parameters/localeId' + - $ref: '../api_common.yaml#/components/parameters/projectId' + - $ref: '../api_common.yaml#/components/parameters/localeId' responses: 200: @@ -175,15 +175,15 @@ x-paths: schema: $ref: '#/components/schemas/TqcProjectGetCheckTypesResponse' example: - $ref: '../examples.yaml#/components/examples/projects_check_types_settings_example' + $ref: './examples.yaml#/components/examples/projects_check_types_settings_example' 400: - $ref: '../../openapi.yaml#/components/responses/Error400ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition' 401: - $ref: '../../openapi.yaml#/components/responses/Error401ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition' 429: - $ref: '../../openapi.yaml#/components/responses/Error429ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition' 500: - $ref: '../../openapi.yaml#/components/responses/Error500ResponseDefinition' + $ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition' x-code-samples: - lang: curl source: | @@ -197,51 +197,51 @@ components: properties: response: allOf: - - $ref: '../../api_common.yaml#/components/schemas/SuccessResponse' + - $ref: '../api_common.yaml#/components/schemas/SuccessResponse' - type: object properties: data: - $ref: '../tqc_common.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponseOneOf' + $ref: './tqc_common.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponseOneOf' ProfilesAccountCheckTypeApplySettingsResponse: type: object properties: response: allOf: - - $ref: '../../api_common.yaml#/components/schemas/SuccessResponse' + - $ref: '../api_common.yaml#/components/schemas/SuccessResponse' - type: object properties: data: - $ref: '../tqc_common.yaml#/components/schemas/ProfilesAccountCheckTypeApplySettingsDTOResponseOneOf' + $ref: './tqc_common.yaml#/components/schemas/ProfilesAccountCheckTypeApplySettingsDTOResponseOneOf' AccountCheckTypeApplyGroupSettingsResponse: type: object properties: response: allOf: - - $ref: '../../api_common.yaml#/components/schemas/SuccessResponse' + - $ref: '../api_common.yaml#/components/schemas/SuccessResponse' - type: object properties: data: - $ref: '../tqc_common.yaml#/components/schemas/AccountCheckTypeApplyGroupSettingsDTOResponseOneOf' + $ref: './tqc_common.yaml#/components/schemas/AccountCheckTypeApplyGroupSettingsDTOResponseOneOf' ProfilesAccountCheckTypeApplyGroupSettingsResponse: type: object properties: response: allOf: - - $ref: '../../api_common.yaml#/components/schemas/SuccessResponse' + - $ref: '../api_common.yaml#/components/schemas/SuccessResponse' - type: object properties: data: - $ref: '../tqc_common.yaml#/components/schemas/ProfilesAccountCheckTypeApplyGroupSettingsDTOResponseOneOf' + $ref: './tqc_common.yaml#/components/schemas/ProfilesAccountCheckTypeApplyGroupSettingsDTOResponseOneOf' TqcProjectGetCheckTypesResponse: type: object properties: response: allOf: - - $ref: '../../api_common.yaml#/components/schemas/SuccessResponse' + - $ref: '../api_common.yaml#/components/schemas/SuccessResponse' - type: object properties: data: @@ -253,14 +253,14 @@ components: items: type: array items: - $ref: '../tqc_common.yaml#/components/schemas/ProjectCheckTypeEffectiveDTOAnyOf' + $ref: './tqc_common.yaml#/components/schemas/ProjectCheckTypeEffectiveDTOAnyOf' TqcAccountGetCheckTypesResponse: type: object properties: response: allOf: - - $ref: '../../api_common.yaml#/components/schemas/SuccessResponse' + - $ref: '../api_common.yaml#/components/schemas/SuccessResponse' - type: object properties: data: @@ -272,14 +272,14 @@ components: items: type: array items: - $ref: '../tqc_common.yaml#/components/schemas/AccountCheckTypeEffectiveDTOAnyOf' + $ref: './tqc_common.yaml#/components/schemas/AccountCheckTypeEffectiveDTOAnyOf' ProfilesTqcAccountGetCheckTypesResponse: type: object properties: response: allOf: - - $ref: '../../api_common.yaml#/components/schemas/SuccessResponse' + - $ref: '../api_common.yaml#/components/schemas/SuccessResponse' - type: object properties: data: @@ -291,7 +291,7 @@ components: items: type: array items: - $ref: '../tqc_common.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTOAnyOf' + $ref: './tqc_common.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTOAnyOf' AccountCheckTypeEffectiveAbstractDTO: allOf: @@ -309,33 +309,33 @@ components: properties: response: allOf: - - $ref: '../../api_common.yaml#/components/schemas/SuccessResponse' + - $ref: '../api_common.yaml#/components/schemas/SuccessResponse' - type: object properties: data: anyOf: - - $ref: './leading_trailing_spaces.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './whitespaces.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './original_equals_target.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './spellcheck.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './tag_consistency.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './target_length_limit.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './number_consistency.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './repeated_word.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './target_in_wrong_language.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './source_in_wrong_language.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './segment_completeness.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './non_translatable_text.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './emoji_consistency.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './insertable_consistency.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './target_source_consistency.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './blacklisted_terms.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './glossary_compliance.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './trademark_consistency.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './grammar_check.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './global_capitalisation_consistency.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './punctuation_consistency.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './plurals_repetition.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './regex_check.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' - - $ref: './open_issues.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/leading_trailing_spaces.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/whitespaces.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/original_equals_target.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/spellcheck.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/tag_consistency.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/target_length_limit.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/number_consistency.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/repeated_word.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/target_in_wrong_language.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/source_in_wrong_language.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/segment_completeness.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/non_translatable_text.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/emoji_consistency.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/insertable_consistency.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/target_source_consistency.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/blacklisted_terms.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/glossary_compliance.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/trademark_consistency.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/grammar_check.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/global_capitalisation_consistency.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/punctuation_consistency.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/plurals_repetition.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/regex_check.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' + - $ref: './checks/open_issues.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTO' diff --git a/spec/translation_quality/checks/accounts_result.yaml b/spec/translation_quality/accounts_result.yaml similarity index 65% rename from spec/translation_quality/checks/accounts_result.yaml rename to spec/translation_quality/accounts_result.yaml index 7af771fa..bc512b21 100644 --- a/spec/translation_quality/checks/accounts_result.yaml +++ b/spec/translation_quality/accounts_result.yaml @@ -7,7 +7,7 @@ x-paths: - Translation quality checks operationId: getProfilesAccountCheckTypesSettings parameters: - - &ref_1 + - &ref_8 name: accountUid in: path schema: @@ -16,7 +16,7 @@ x-paths: description: >- The account’s unique identifier. This can be found in the Smartling Dashboard under Account Settings > API. - - &ref_2 + - &ref_9 name: profileUid in: path required: true @@ -33,7 +33,7 @@ x-paths: properties: response: allOf: - - &ref_3 + - &ref_10 type: object required: - code @@ -59,10 +59,64 @@ x-paths: anyOf: - title: BLACKLISTED_TERMS allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - &ref_1 + type: object + properties: + profileUid: + type: string + description: >- + Unique identifier of corresponding + profile. + example: ce6d6b5dbc12 + - &ref_5 + allOf: + - &ref_2 + type: object + properties: + severityLevelCode: &ref_0 + enum: + - DISABLED + - LOW + - MEDIUM + - HIGH + - type: object + properties: + subTypes: + type: array + items: + type: object + properties: + checkSubTypeCode: + type: string + description: check subtype code + example: '' + - &ref_3 + type: object + properties: + localeSeverityLevels: + type: array + items: + type: object + properties: + targetLocaleId: + type: string + description: >- + Smartling locale identifier of the + translation + example: it-IT + severityLevelCode: *ref_0 + - &ref_4 + type: object + properties: + groups: + type: array + items: + type: object + properties: + groupUid: + type: string + description: unique identifier of group + example: 12dsd344ds - type: object properties: checkTypeCode: @@ -73,11 +127,13 @@ x-paths: example: BLACKLISTED_TERMS - title: EMOJI_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_15 + - *ref_1 + - &ref_6 + allOf: + - *ref_2 + - *ref_3 + - *ref_4 + - &ref_16 type: object properties: noEmojisAllowedInTarget: @@ -107,10 +163,8 @@ x-paths: example: EMOJI_ADDED - title: GLOBAL_CAPITALISATION_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_1 + - *ref_5 - type: object properties: checkTypeCode: @@ -121,12 +175,10 @@ x-paths: example: GLOBAL_CAPITALISATION_CONSISTENCY - title: GLOSSARY_COMPLIANCE allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_1 + - *ref_5 - allOf: - - &ref_21 + - &ref_23 type: object properties: matchMethod: @@ -145,7 +197,7 @@ x-paths: minimum: 0 maximum: 100 example: 10 - - &ref_22 + - &ref_24 type: object properties: sameTermCount: @@ -166,10 +218,8 @@ x-paths: example: GLOSSARY_COMPLIANCE - title: GRAMMAR_CHECK allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_1 + - *ref_5 - type: object properties: checkTypeCode: @@ -180,10 +230,8 @@ x-paths: example: GRAMMAR_CHECK - title: INSERTABLE_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_1 + - *ref_6 - type: object properties: checkTypeCode: @@ -206,10 +254,8 @@ x-paths: example: INSERTABLE_ADDED - title: LEADING_TRAILING_SPACES allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_1 + - *ref_5 - type: object required: - checkTypeCode @@ -222,10 +268,8 @@ x-paths: example: LEADING_TRAILING_SPACES - title: NON_TRANSLATABLE_TEXT allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_1 + - *ref_5 - type: object properties: checkTypeCode: @@ -250,11 +294,9 @@ x-paths: example: PLACEABLE_ADDED - title: NUMBER_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_19 + - *ref_1 + - *ref_6 + - &ref_21 type: object properties: ignoreSign: @@ -284,11 +326,9 @@ x-paths: example: NUMBER_ADDED - title: ORIGINAL_EQUALS_TARGET allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_23 + - *ref_1 + - *ref_5 + - &ref_25 type: object properties: mustHaveIdenticalTags: @@ -311,10 +351,8 @@ x-paths: example: ORIGINAL_EQUALS_TARGET - title: REPEATED_WORD allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_1 + - *ref_5 - type: object properties: checkTypeCode: @@ -325,11 +363,9 @@ x-paths: example: REPEATED_WORD - title: SEGMENT_COMPLETENESS allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_24 + - *ref_1 + - *ref_6 + - &ref_26 type: object properties: lowerLengthThreshold: @@ -367,11 +403,9 @@ x-paths: example: TARGET_IS_EMPTY - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_17 + - *ref_1 + - *ref_5 + - &ref_19 type: object properties: minTextLengthLimit: @@ -389,11 +423,9 @@ x-paths: example: SOURCE_IN_WRONG_LANGUAGE - title: SPELLCHECK allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_16 + - *ref_1 + - *ref_5 + - &ref_17 type: object properties: skipIfWordInUserDictionary: @@ -426,10 +458,8 @@ x-paths: example: SPELLCHECK - title: TAG_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_1 + - *ref_6 - type: object properties: checkTypeCode: @@ -454,11 +484,9 @@ x-paths: example: TAG_ADDED - title: TARGET_IN_WRONG_LANGUAGE allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_18 + - *ref_1 + - *ref_5 + - &ref_20 type: object properties: minTextLengthLimit: @@ -476,10 +504,8 @@ x-paths: example: TARGET_IN_WRONG_LANGUAGE - title: TARGET_LENGTH_LIMIT allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_1 + - *ref_5 - type: object properties: checkTypeCode: @@ -490,11 +516,9 @@ x-paths: example: TARGET_LENGTH_LIMIT - title: TARGET_SOURCE_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_20 + - *ref_1 + - *ref_6 + - &ref_22 type: object properties: ignoreTagsAndPlaceholders: @@ -527,10 +551,8 @@ x-paths: example: SAME_SOURCE_DIFFERENT_TRANSLATIONS - title: TRADEMARK_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_1 + - *ref_5 - type: object properties: checkTypeCode: @@ -541,10 +563,8 @@ x-paths: example: TRADEMARK_CONSISTENCY - title: WHITESPACES allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_1 + - *ref_5 - type: object properties: checkTypeCode: @@ -555,10 +575,8 @@ x-paths: example: WHITESPACES - title: PUNCTUATION_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_1 + - *ref_5 - type: object properties: checkTypeCode: @@ -569,10 +587,8 @@ x-paths: example: PUNCTUATION_CONSISTENCY - title: PLURALS_REPETITION allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_1 + - *ref_5 - type: object properties: checkTypeCode: @@ -583,10 +599,8 @@ x-paths: example: PLURALS_REPETITION - title: REGEX_CHECK allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_1 + - *ref_5 - type: object properties: checkTypeCode: @@ -597,16 +611,117 @@ x-paths: example: REGEX_CHECK rules: type: array - items: - $ref: >- - ../tqc_common.yaml#/components/schemas/regexRuleWithRuleUid + items: &ref_11 + allOf: + - type: object + properties: + ruleUid: + type: string + description: >- + Unique identifier of corresponding check + rule + example: ce6d6b5dbc12 + - type: object + properties: + ruleName: + type: string + description: Rule name + example: ruleName + severityLevelCode: + enum: + - DISABLED + - LOW + - MEDIUM + - HIGH + ruleTypeCode: + enum: + - FORBIDDEN + - MISSING + - COUNT_MISMATCH + flavorCode: + enum: + - JAVA + - DOT_NET + originalPattern: + type: string + description: >- + Regular expression to evaluate against + the source string. + example: '@mail' + translationPattern: + type: string + description: >- + Regular expression to evaluate against + the translation. + example: '@gmail' + caseInsensitive: + type: boolean + description: Enable case insensitive search + example: true + multiLine: + type: boolean + description: >- + Enables multine search. If true then + search will span newlines in a string. + Users can use ^ and $ characters with + special meaning for beginning of line + and end of line match. + example: true + description: + type: string + description: >- + Human readable description of the role; + shown in the the dashboard UI. + example: rule description + warningMessage: + type: string + description: >- + Human readable warning message appended + to the standard message that is shown in + the CAT tool when the check fails. + example: ' test warning message' + required: + - ruleName + - severityLevelCode + - ruleTypeCode + - flavorCode + - originalPattern + - translationPattern + - caseInsensitive + - multiLine + - type: object + properties: + groups: + type: array + items: + allOf: + - type: object + properties: + groupUid: + type: string + description: >- + Smartling rule group identifier of the + translation + example: ce6d6b5dbc12 + ruleUid: + type: string + description: >- + Smartling rule identifier of the + translation + example: ce6d6b5dbcs2 + targetLocaleIds: + description: The list of target locales. + example: + - ru-RU + items: + type: string + type: array + severityLevelCode: *ref_0 - title: OPEN_ISSUES allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_25 + - *ref_1 + - *ref_5 + - &ref_27 type: object properties: sourceIssuesMustBeResolved: @@ -628,9 +743,245 @@ x-paths: description: check type code example: OPEN_ISSUES example: - $ref: >- - ../examples.yaml#/components/examples/profiles_accounts_check_types_settings_example - '400': &ref_11 + response: + code: SUCCESS + data: + totalCount: 25 + items: + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: LEADING_TRAILING_SPACES + subTypes: [] + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: ORIGINAL_EQUALS_TARGET + subTypes: [] + localeSeverityLevels: [] + groups: [] + mustHaveIdenticalTags: true + mustHaveIdenticalCapitalization: true + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: WHITESPACES + subTypes: [] + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: SPELLCHECK + subTypes: [] + localeSeverityLevels: [] + groups: [] + skipIfWordInUserDictionary: true + skipIfWordStartsWithCapitalLetter: false + skipIfWordAppearsInSourceString: true + skipIfWordValidInSourceLocale: false + runSpellcheckForSubWords: false + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: TAG_CONSISTENCY + subTypes: + - checkSubTypeCode: TAG_ADDED + severityLevelCode: LOW + - checkSubTypeCode: TAG_DELETED + severityLevelCode: LOW + - checkSubTypeCode: TAG_ORDER_IS_CHANGED + severityLevelCode: LOW + - checkSubTypeCode: SPACES_AROUND_TAGS + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: HIGH + checkTypeCode: TARGET_LENGTH_LIMIT + subTypes: [] + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: NUMBER_CONSISTENCY + subTypes: + - checkSubTypeCode: NUMBER_DELETED + severityLevelCode: LOW + - checkSubTypeCode: NUMBER_ADDED + severityLevelCode: LOW + - checkSubTypeCode: NUMBER_INCORRECT_CONVERSION + severityLevelCode: LOW + localeSeverityLevels: [] + groups: + - groupUid: b0dd258b05ee + - groupUid: a853df2cf8ac + ignoreSign: true + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: REPEATED_WORD + subTypes: [] + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: TARGET_IN_WRONG_LANGUAGE + subTypes: [] + localeSeverityLevels: [] + groups: [] + minTextLengthLimit: 40 + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: SOURCE_IN_WRONG_LANGUAGE + subTypes: [] + localeSeverityLevels: [] + groups: [] + minTextLengthLimit: 40 + - profileUid: ce6d6b5dbc12 + severityLevelCode: MEDIUM + checkTypeCode: SEGMENT_COMPLETENESS + subTypes: + - checkSubTypeCode: TARGET_IS_MUCH_SHORTER_THAN_SOURCE + severityLevelCode: MEDIUM + - checkSubTypeCode: TARGET_IS_MUCH_LONGER_THAN_SOURCE + severityLevelCode: MEDIUM + - checkSubTypeCode: TARGET_IS_EMPTY + severityLevelCode: DISABLED + localeSeverityLevels: [] + groups: [] + lowerLengthThreshold: 50 + upperLengthThreshold: 250 + minLengthThreshold: 10 + - profileUid: ce6d6b5dbc12 + severityLevelCode: MEDIUM + checkTypeCode: NON_TRANSLATABLE_TEXT + subTypes: + - checkSubTypeCode: PLACEABLE_DELETED + severityLevelCode: MEDIUM + - checkSubTypeCode: SPACES_AROUND_PLACEABLE + severityLevelCode: MEDIUM + - checkSubTypeCode: PLACEABLE_ADDED + severityLevelCode: MEDIUM + - checkSubTypeCode: PLACEABLE_FORMAT + severityLevelCode: MEDIUM + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: EMOJI_CONSISTENCY + subTypes: + - checkSubTypeCode: EMOJI_PRESENT + severityLevelCode: DISABLED + - checkSubTypeCode: EMOJI_DELETED + severityLevelCode: LOW + - checkSubTypeCode: EMOJI_ADDED + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] + noEmojisAllowedInTarget: false + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: INSERTABLE_CONSISTENCY + subTypes: + - checkSubTypeCode: INSERTABLE_DELETED + severityLevelCode: LOW + - checkSubTypeCode: INSERTABLE_ADDED + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: TARGET_SOURCE_CONSISTENCY + subTypes: + - checkSubTypeCode: SAME_TRANSLATION_DIFFERENT_SOURCES + severityLevelCode: LOW + - checkSubTypeCode: SAME_SOURCE_DIFFERENT_TRANSLATIONS + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] + ignoreTagsAndPlaceholders: true + ignoreCase: true + - profileUid: ce6d6b5dbc12 + severityLevelCode: MEDIUM + checkTypeCode: BLACKLISTED_TERMS + subTypes: [] + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: MEDIUM + checkTypeCode: GLOSSARY_COMPLIANCE + subTypes: [] + localeSeverityLevels: [] + groups: [] + matchMethod: MATCH_BY_PERCENTAGE + matchThreshold: 50 + sameTermCount: true + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: TRADEMARK_CONSISTENCY + subTypes: [] + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: GRAMMAR_CHECK + subTypes: [] + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: GLOBAL_CAPITALISATION_CONSISTENCY + subTypes: [] + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: PUNCTUATION_CONSISTENCY + subTypes: [] + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: MEDIUM + checkTypeCode: PLURALS_REPETITION + subTypes: [] + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: REGEX_CHECK + subTypes: [] + groups: [] + rules: + - ruleUid: 2d83ea74c848 + severityLevelCode: LOW + ruleName: ruleName1 + ruleTypeCode: FORBIDDEN + flavorCode: JAVA + originalPattern: '@mail' + translationPattern: '@gmail' + description: ruleName1 description + caseInsensitive: true + multiLine: false + warningMessage: test warning + groups: [] + - ruleUid: ac3069e2fd30 + severityLevelCode: MEDIUM + ruleName: ruleName2 + ruleTypeCode: MISSING + flavorCode: JAVA + originalPattern: '@/d' + translationPattern: '@/d' + description: ruleName2 description + caseInsensitive: true + multiLine: false + warningMessage: test warning + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: OPEN_ISSUES + subTypes: [] + localeSeverityLevels: [] + groups: [] + sourceIssuesMustBeResolved: true + translationIssuesMustBeResolved: true + '400': &ref_12 description: Provided request parameters are invalid. content: application/json: @@ -647,7 +998,7 @@ x-paths: - VALIDATION_ERROR type: string errors: - items: &ref_0 + items: &ref_7 type: object properties: key: @@ -681,7 +1032,7 @@ x-paths: consult the documentation to verify the fields you are submitting. details: {} - '401': &ref_12 + '401': &ref_13 description: Provided credentials are not valid. content: application/json: @@ -698,7 +1049,7 @@ x-paths: - AUTHORIZATION_ERROR type: string errors: - items: *ref_0 + items: *ref_7 type: array required: - code @@ -716,7 +1067,7 @@ x-paths: - key: invalid_token details: {} message: Invalid token - '429': &ref_13 + '429': &ref_14 description: Too many simultaneous API requests. content: application/json: @@ -732,7 +1083,7 @@ x-paths: - MAX_OPERATIONS_LIMIT_EXCEEDED type: string errors: - items: *ref_0 + items: *ref_7 type: array required: - code @@ -751,7 +1102,7 @@ x-paths: message: >- The limit of 10 concurrent Smartling file API operations for this project has been exceeded. - '500': &ref_14 + '500': &ref_15 description: Unexpected error content: application/json: @@ -768,7 +1119,7 @@ x-paths: - MAINTENANCE_MODE_ERROR type: string errors: - items: *ref_0 + items: *ref_7 type: array required: - code @@ -791,8 +1142,8 @@ x-paths: - Translation quality checks operationId: getProfilesSingleCheckTypeSettings parameters: - - *ref_1 - - *ref_2 + - *ref_8 + - *ref_9 - name: checkTypeCode in: path required: true @@ -834,71 +1185,15 @@ x-paths: properties: response: allOf: - - *ref_3 + - *ref_10 - type: object properties: data: anyOf: - title: LEADING_TRAILING_SPACES allOf: - - &ref_5 - type: object - properties: - profileUid: - type: string - description: >- - Unique identifier of corresponding - profile. - example: ce6d6b5dbc12 - - &ref_6 - allOf: - - &ref_7 - type: object - properties: - severityLevelCode: &ref_4 - enum: - - DISABLED - - LOW - - MEDIUM - - HIGH - - type: object - properties: - subTypes: - type: array - items: - type: object - properties: - checkSubTypeCode: - type: string - description: check subtype code - example: '' - - &ref_8 - type: object - properties: - localeSeverityLevels: - type: array - items: - type: object - properties: - targetLocaleId: - type: string - description: >- - Smartling locale identifier of the - translation - example: it-IT - severityLevelCode: *ref_4 - - &ref_9 - type: object - properties: - groups: - type: array - items: - type: object - properties: - groupUid: - type: string - description: unique identifier of group - example: 12dsd344ds + - *ref_1 + - *ref_5 - type: object required: - checkTypeCode @@ -911,8 +1206,8 @@ x-paths: example: LEADING_TRAILING_SPACES - title: WHITESPACES allOf: + - *ref_1 - *ref_5 - - *ref_6 - type: object properties: checkTypeCode: @@ -923,8 +1218,8 @@ x-paths: example: WHITESPACES - title: ORIGINAL_EQUALS_TARGET allOf: + - *ref_1 - *ref_5 - - *ref_6 - type: object properties: mustHaveIdenticalTags: @@ -947,8 +1242,8 @@ x-paths: example: ORIGINAL_EQUALS_TARGET - title: SPELLCHECK allOf: + - *ref_1 - *ref_5 - - *ref_6 - type: object properties: skipIfWordInUserDictionary: @@ -981,12 +1276,8 @@ x-paths: example: SPELLCHECK - title: TAG_CONSISTENCY allOf: - - *ref_5 - - &ref_10 - allOf: - - *ref_7 - - *ref_8 - - *ref_9 + - *ref_1 + - *ref_6 - type: object properties: checkTypeCode: @@ -1011,8 +1302,8 @@ x-paths: example: TAG_ADDED - title: TARGET_LENGTH_LIMIT allOf: + - *ref_1 - *ref_5 - - *ref_6 - type: object properties: checkTypeCode: @@ -1023,8 +1314,8 @@ x-paths: example: TARGET_LENGTH_LIMIT - title: NUMBER_CONSISTENCY allOf: - - *ref_5 - - *ref_10 + - *ref_1 + - *ref_6 - type: object properties: ignoreSign: @@ -1054,8 +1345,8 @@ x-paths: example: NUMBER_ADDED - title: REPEATED_WORD allOf: + - *ref_1 - *ref_5 - - *ref_6 - type: object properties: checkTypeCode: @@ -1066,8 +1357,8 @@ x-paths: example: REPEATED_WORD - title: TARGET_IN_WRONG_LANGUAGE allOf: + - *ref_1 - *ref_5 - - *ref_6 - type: object properties: minTextLengthLimit: @@ -1085,8 +1376,8 @@ x-paths: example: TARGET_IN_WRONG_LANGUAGE - title: SOURCE_IN_WRONG_LANGUAGE allOf: + - *ref_1 - *ref_5 - - *ref_6 - type: object properties: minTextLengthLimit: @@ -1104,8 +1395,8 @@ x-paths: example: SOURCE_IN_WRONG_LANGUAGE - title: SEGMENT_COMPLETENESS allOf: - - *ref_5 - - *ref_10 + - *ref_1 + - *ref_6 - type: object properties: lowerLengthThreshold: @@ -1143,8 +1434,8 @@ x-paths: example: TARGET_IS_EMPTY - title: NON_TRANSLATABLE_TEXT allOf: + - *ref_1 - *ref_5 - - *ref_6 - type: object properties: checkTypeCode: @@ -1169,8 +1460,8 @@ x-paths: example: PLACEABLE_ADDED - title: EMOJI_CONSISTENCY allOf: - - *ref_5 - - *ref_10 + - *ref_1 + - *ref_6 - type: object properties: noEmojisAllowedInTarget: @@ -1200,8 +1491,8 @@ x-paths: example: EMOJI_ADDED - title: INSERTABLE_CONSISTENCY allOf: - - *ref_5 - - *ref_10 + - *ref_1 + - *ref_6 - type: object properties: checkTypeCode: @@ -1224,8 +1515,8 @@ x-paths: example: INSERTABLE_ADDED - title: TARGET_SOURCE_CONSISTENCY allOf: - - *ref_5 - - *ref_10 + - *ref_1 + - *ref_6 - type: object properties: ignoreTagsAndPlaceholders: @@ -1258,8 +1549,8 @@ x-paths: example: SAME_SOURCE_DIFFERENT_TRANSLATIONS - title: BLACKLISTED_TERMS allOf: + - *ref_1 - *ref_5 - - *ref_6 - type: object properties: checkTypeCode: @@ -1270,8 +1561,8 @@ x-paths: example: BLACKLISTED_TERMS - title: GLOSSARY_COMPLIANCE allOf: + - *ref_1 - *ref_5 - - *ref_6 - allOf: - type: object properties: @@ -1311,8 +1602,8 @@ x-paths: example: GLOSSARY_COMPLIANCE - title: TRADEMARK_CONSISTENCY allOf: + - *ref_1 - *ref_5 - - *ref_6 - type: object properties: checkTypeCode: @@ -1323,8 +1614,8 @@ x-paths: example: TRADEMARK_CONSISTENCY - title: GRAMMAR_CHECK allOf: + - *ref_1 - *ref_5 - - *ref_6 - type: object properties: checkTypeCode: @@ -1335,8 +1626,8 @@ x-paths: example: GRAMMAR_CHECK - title: GLOBAL_CAPITALISATION_CONSISTENCY allOf: + - *ref_1 - *ref_5 - - *ref_6 - type: object properties: checkTypeCode: @@ -1347,8 +1638,8 @@ x-paths: example: GLOBAL_CAPITALISATION_CONSISTENCY - title: PUNCTUATION_CONSISTENCY allOf: + - *ref_1 - *ref_5 - - *ref_6 - type: object properties: checkTypeCode: @@ -1359,8 +1650,8 @@ x-paths: example: PUNCTUATION_CONSISTENCY - title: PLURALS_REPETITION allOf: + - *ref_1 - *ref_5 - - *ref_6 - type: object properties: checkTypeCode: @@ -1371,8 +1662,8 @@ x-paths: example: PLURALS_REPETITION - title: REGEX_CHECK allOf: + - *ref_1 - *ref_5 - - *ref_6 - type: object properties: checkTypeCode: @@ -1383,116 +1674,11 @@ x-paths: example: REGEX_CHECK rules: type: array - items: - allOf: - - type: object - properties: - ruleUid: - type: string - description: >- - Unique identifier of corresponding check - rule - example: ce6d6b5dbc12 - - type: object - properties: - ruleName: - type: string - description: Rule name - example: ruleName - severityLevelCode: - enum: - - DISABLED - - LOW - - MEDIUM - - HIGH - ruleTypeCode: - enum: - - FORBIDDEN - - MISSING - - COUNT_MISMATCH - flavorCode: - enum: - - JAVA - - DOT_NET - originalPattern: - type: string - description: >- - Regular expression to evaluate against - the source string. - example: '@mail' - translationPattern: - type: string - description: >- - Regular expression to evaluate against - the translation. - example: '@gmail' - caseInsensitive: - type: boolean - description: Enable case insensitive search - example: true - multiLine: - type: boolean - description: >- - Enables multine search. If true then - search will span newlines in a string. - Users can use ^ and $ characters with - special meaning for beginning of line - and end of line match. - example: true - description: - type: string - description: >- - Human readable description of the role; - shown in the the dashboard UI. - example: rule description - warningMessage: - type: string - description: >- - Human readable warning message appended - to the standard message that is shown in - the CAT tool when the check fails. - example: ' test warning message' - required: - - ruleName - - severityLevelCode - - ruleTypeCode - - flavorCode - - originalPattern - - translationPattern - - caseInsensitive - - multiLine - - type: object - properties: - groups: - type: array - items: - allOf: - - type: object - properties: - groupUid: - type: string - description: >- - Smartling rule group identifier of the - translation - example: ce6d6b5dbc12 - ruleUid: - type: string - description: >- - Smartling rule identifier of the - translation - example: ce6d6b5dbcs2 - targetLocaleIds: - description: The list of target locales. - example: - - ru-RU - items: - type: string - type: array - severityLevelCode: *ref_4 + items: *ref_11 - title: OPEN_ISSUES allOf: + - *ref_1 - *ref_5 - - *ref_6 - type: object properties: sourceIssuesMustBeResolved: @@ -1514,12 +1700,271 @@ x-paths: description: check type code example: OPEN_ISSUES examples: - $ref: >- - ../examples.yaml#/components/examples/profiles_account_check_types_settings_effective_example - '400': *ref_11 - '401': *ref_12 - '429': *ref_13 - '500': *ref_14 + ORIGINAL_EQUALS_TARGET: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: ORIGINAL_EQUALS_TARGET + subTypes: [] + localeSeverityLevels: [] + groups: [] + mustHaveIdenticalTags: true + mustHaveIdenticalCapitalization: true + WHITESPACES: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: WHITESPACES + subTypes: [] + localeSeverityLevels: [] + groups: [] + SPELLCHECK: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: SPELLCHECK + subTypes: [] + localeSeverityLevels: [] + groups: [] + skipIfWordInUserDictionary: true + skipIfWordStartsWithCapitalLetter: false + skipIfWordAppearsInSourceString: true + skipIfWordValidInSourceLocale: false + runSpellcheckForSubWords: false + TAG_CONSISTENCY: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: TAG_CONSISTENCY + subTypes: + - checkSubTypeCode: TAG_ADDED + severityLevelCode: LOW + - checkSubTypeCode: TAG_DELETED + severityLevelCode: LOW + - checkSubTypeCode: TAG_ORDER_IS_CHANGED + severityLevelCode: LOW + - checkSubTypeCode: SPACES_AROUND_TAGS + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] + TARGET_LENGTH_LIMIT: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: HIGH + checkTypeCode: TARGET_LENGTH_LIMIT + subTypes: [] + localeSeverityLevels: [] + groups: [] + NUMBER_CONSISTENCY: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: NUMBER_CONSISTENCY + subTypes: + - checkSubTypeCode: NUMBER_DELETED + severityLevelCode: LOW + - checkSubTypeCode: NUMBER_ADDED + severityLevelCode: LOW + - checkSubTypeCode: NUMBER_INCORRECT_CONVERSION + severityLevelCode: LOW + localeSeverityLevels: [] + groups: + - groupUid: b0dd258b05ee + - groupUid: a853df2cf8ac + ignoreSign: true + REPEATED_WORD: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: REPEATED_WORD + subTypes: [] + localeSeverityLevels: [] + groups: [] + TARGET_IN_WRONG_LANGUAGE: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: TARGET_IN_WRONG_LANGUAGE + subTypes: [] + localeSeverityLevels: [] + groups: [] + minTextLengthLimit: 40 + SOURCE_IN_WRONG_LANGUAGE: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: SOURCE_IN_WRONG_LANGUAGE + subTypes: [] + localeSeverityLevels: [] + groups: [] + minTextLengthLimit: 40 + SEGMENT_COMPLETENESS: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: MEDIUM + checkTypeCode: SEGMENT_COMPLETENESS + subTypes: + - checkSubTypeCode: TARGET_IS_MUCH_SHORTER_THAN_SOURCE + severityLevelCode: MEDIUM + - checkSubTypeCode: TARGET_IS_MUCH_LONGER_THAN_SOURCE + severityLevelCode: MEDIUM + - checkSubTypeCode: TARGET_IS_EMPTY + severityLevelCode: DISABLED + localeSeverityLevels: [] + groups: [] + lowerLengthThreshold: 50 + upperLengthThreshold: 250 + minLengthThreshold: 10 + NON_TRANSLATABLE_TEXT: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: MEDIUM + checkTypeCode: NON_TRANSLATABLE_TEXT + subTypes: + - checkSubTypeCode: PLACEABLE_DELETED + severityLevelCode: MEDIUM + - checkSubTypeCode: SPACES_AROUND_PLACEABLE + severityLevelCode: MEDIUM + - checkSubTypeCode: PLACEABLE_ADDED + severityLevelCode: MEDIUM + - checkSubTypeCode: PLACEABLE_FORMAT + severityLevelCode: MEDIUM + localeSeverityLevels: [] + groups: [] + EMOJI_CONSISTENCY: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: EMOJI_CONSISTENCY + subTypes: + - checkSubTypeCode: EMOJI_PRESENT + severityLevelCode: LOW + - checkSubTypeCode: EMOJI_DELETED + severityLevelCode: DISABLED + - checkSubTypeCode: EMOJI_ADDED + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] + noEmojisAllowedInTarget: false + INSERTABLE_CONSISTENCY: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: INSERTABLE_CONSISTENCY + subTypes: + - checkSubTypeCode: INSERTABLE_DELETED + severityLevelCode: LOW + - checkSubTypeCode: INSERTABLE_ADDED + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] + TARGET_SOURCE_CONSISTENCY: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: TARGET_SOURCE_CONSISTENCY + subTypes: + - checkSubTypeCode: SAME_TRANSLATION_DIFFERENT_SOURCES + severityLevelCode: LOW + - checkSubTypeCode: SAME_SOURCE_DIFFERENT_TRANSLATIONS + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] + ignoreTagsAndPlaceholders: true + ignoreCase: true + BLACKLISTED_TERMS: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: MEDIUM + checkTypeCode: BLACKLISTED_TERMS + subTypes: [] + localeSeverityLevels: [] + groups: [] + GLOSSARY_COMPLIANCE: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: DISABLED + checkTypeCode: GLOSSARY_COMPLIANCE + subTypes: [] + localeSeverityLevels: [] + groups: [] + matchMethod: MATCH_BY_PERCENTAGE + matchThreshold: 50 + sameTermCount: true + TRADEMARK_CONSISTENCY: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: TRADEMARK_CONSISTENCY + subTypes: [] + localeSeverityLevels: [] + groups: [] + GRAMMAR_CHECK: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: GRAMMAR_CHECK + subTypes: [] + localeSeverityLevels: [] + groups: [] + GLOBAL_CAPITALISATION_CONSISTENCY: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: GLOBAL_CAPITALISATION_CONSISTENCY + subTypes: [] + localeSeverityLevels: [] + groups: [] + PUNCTUATION_CONSISTENCY: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: PUNCTUATION_CONSISTENCY + subTypes: [] + localeSeverityLevels: [] + groups: [] + PLURALS_REPETITION: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: MEDIUM + checkTypeCode: PLURALS_REPETITION + subTypes: [] + localeSeverityLevels: [] + groups: [] + REGEX_CHECK: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: REGEX_CHECK + subTypes: [] + groups: [] + rules: + - ruleUid: 2d83ea74c848 + severityLevelCode: LOW + ruleName: ruleName1 + ruleTypeCode: FORBIDDEN + flavorCode: JAVA + originalPattern: '@mail' + translationPattern: '@gmail' + description: ruleName1 description + caseInsensitive: true + multiLine: false + warningMessage: test warning + groups: [] + OPEN_ISSUES: + value: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: OPEN_ISSUES + subTypes: [] + localeSeverityLevels: [] + groups: [] + sourceIssuesMustBeResolved: true + translationIssuesMustBeResolved: true + '400': *ref_12 + '401': *ref_13 + '429': *ref_14 + '500': *ref_15 x-code-samples: - lang: curl source: > @@ -1534,9 +1979,9 @@ x-paths: - Translation quality checks operationId: profilesUpdateAccountCheckTypesSettings parameters: - - *ref_1 - - *ref_2 - - &ref_27 + - *ref_8 + - *ref_9 + - &ref_29 name: checkTypeCode in: path required: true @@ -1562,20 +2007,26 @@ x-paths: oneOf: - title: EMOJI_CONSISTENCY allOf: - - *ref_15 - - &ref_28 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId - - &ref_29 + - *ref_16 + - &ref_18 + type: object + properties: + targetLocaleId: + type: string + description: >- + Smartling ID for the language you want to translate + to. + example: it-IT + required: + - targetLocaleId + - &ref_30 type: object required: - noEmojisAllowedInTarget - title: SPELLCHECK allOf: - - *ref_16 - - &ref_30 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId + - *ref_17 + - *ref_18 - &ref_31 type: object required: @@ -1586,71 +2037,61 @@ x-paths: - runSpellcheckForSubWords - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - *ref_17 + - *ref_19 + - *ref_18 - &ref_32 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId - - &ref_33 type: object required: - minTextLengthLimit - title: TARGET_IN_WRONG_LANGUAGE allOf: - - &ref_34 + - &ref_33 type: object required: - minTextLengthLimit - - &ref_35 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId - *ref_18 - - &ref_36 + - *ref_20 + - &ref_34 title: NUMBER_CONSISTENCY allOf: - - *ref_19 + - *ref_21 - title: TARGET_SOURCE_CONSISTENCY allOf: - - *ref_20 - - &ref_37 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId - - &ref_38 + - *ref_22 + - *ref_18 + - &ref_35 type: object required: - ignoreTagsAndPlaceholders - ignoreCase - - &ref_39 + - &ref_36 title: GLOSSARY_COMPLIANCE allOf: - - &ref_26 + - &ref_28 allOf: - - *ref_21 - - *ref_22 + - *ref_23 + - *ref_24 - type: object required: - matchMethod - matchThreshold - title: ORIGINAL_EQUALS_TARGET allOf: - - *ref_23 - - &ref_40 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId - - &ref_41 + - *ref_25 + - *ref_18 + - &ref_37 type: object required: - mustHaveIdenticalTags - mustHaveIdenticalCapitalization - title: SEGMENT_COMPLETENESS allOf: - - *ref_24 - - &ref_42 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId - - &ref_43 + - *ref_26 + - *ref_18 + - &ref_38 title: OPEN_ISSUES allOf: - - *ref_25 + - *ref_27 - type: object required: - sourceIssuesMustBeResolved @@ -1665,48 +2106,87 @@ x-paths: properties: response: allOf: - - *ref_3 + - *ref_10 - type: object properties: - data: &ref_44 + data: &ref_39 oneOf: - title: EMOJI_CONSISTENCY allOf: - - *ref_15 + - *ref_16 - title: SPELLCHECK allOf: - - *ref_16 + - *ref_17 - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - *ref_17 + - *ref_19 - title: TARGET_IN_WRONG_LANGUAGE allOf: - - *ref_18 + - *ref_20 - title: NUMBER_CONSISTENCY allOf: - - *ref_19 + - *ref_21 - title: TARGET_SOURCE_CONSISTENCY allOf: - - *ref_20 + - *ref_22 - title: GLOSSARY_COMPLIANCE allOf: - - *ref_26 + - *ref_28 - title: ORIGINAL_EQUALS_TARGET allOf: - - *ref_23 + - *ref_25 - title: SEGMENT_COMPLETENESS allOf: - - *ref_24 + - *ref_26 - title: OPEN_ISSUES allOf: - - *ref_25 + - *ref_27 examples: - $ref: >- - ../examples.yaml#/components/examples/profiles_accounts_check_types_checkType_settings_example - '400': *ref_11 - '401': *ref_12 - '429': *ref_13 - '500': *ref_14 + EMOJI_CONSISTENCY: + value: + noEmojisAllowedInTarget: true + SPELLCHECK: + value: + skipIfWordInUserDictionary: false + skipIfWordStartsWithCapitalLetter: true + skipIfWordAppearsInSourceString: false + skipIfWordValidInSourceLocale: true + runSpellcheckForSubWords: true + SOURCE_IN_WRONG_LANGUAGE: + value: + minTextLengthLimit: 10 + TARGET_IN_WRONG_LANGUAGE: + value: + minTextLengthLimit: 15 + NUMBER_CONSISTENCY: + value: + ignoreSign: true + TARGET_SOURCE_CONSISTENCY: + value: + ignoreTagsAndPlaceholders: true + ignoreCase: true + GLOSSARY_COMPLIANCE: + value: + matchMethod: MATCH_BY_PERCENTAGE + matchThreshold: 10 + sameTermCount: true + ORIGINAL_EQUALS_TARGET: + value: + mustHaveIdenticalTags: false + mustHaveIdenticalCapitalization: false + SEGMENT_COMPLETENESS: + value: + lowerLengthThreshold: 10 + upperLengthThreshold: 20 + minLengthThreshold: 15 + OPEN_ISSUES: + value: + sourceIssuesMustBeResolved: true + translationIssuesMustBeResolved: true + '400': *ref_12 + '401': *ref_13 + '429': *ref_14 + '500': *ref_15 x-code-samples: - lang: curl source: > @@ -1721,9 +2201,9 @@ x-paths: - Translation quality checks operationId: updateProfilesCheckTypeGroupSettings parameters: - - *ref_1 - - *ref_2 - - *ref_27 + - *ref_8 + - *ref_9 + - *ref_29 - name: groupUid in: path schema: @@ -1738,42 +2218,42 @@ x-paths: schema: oneOf: - title: EMOJI_CONSISTENCY - allOf: - - *ref_15 - - *ref_28 - - *ref_29 - - title: SPELLCHECK allOf: - *ref_16 + - *ref_18 - *ref_30 + - title: SPELLCHECK + allOf: + - *ref_17 + - *ref_18 - *ref_31 - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - *ref_17 + - *ref_19 + - *ref_18 - *ref_32 - - *ref_33 - title: TARGET_IN_WRONG_LANGUAGE allOf: - - *ref_34 - - *ref_35 + - *ref_33 - *ref_18 - - *ref_36 + - *ref_20 + - *ref_34 - title: TARGET_SOURCE_CONSISTENCY allOf: - - *ref_20 - - *ref_37 - - *ref_38 - - *ref_39 + - *ref_22 + - *ref_18 + - *ref_35 + - *ref_36 - title: ORIGINAL_EQUALS_TARGET allOf: - - *ref_23 - - *ref_40 - - *ref_41 + - *ref_25 + - *ref_18 + - *ref_37 - title: SEGMENT_COMPLETENESS allOf: - - *ref_24 - - *ref_42 - - *ref_43 + - *ref_26 + - *ref_18 + - *ref_38 responses: '200': description: OK @@ -1784,17 +2264,56 @@ x-paths: properties: response: allOf: - - *ref_3 + - *ref_10 - type: object properties: - data: *ref_44 + data: *ref_39 examples: - $ref: >- - ../examples.yaml#/components/examples/profiles_accounts_check_types_checkType_group_settings_example - '400': *ref_11 - '401': *ref_12 - '429': *ref_13 - '500': *ref_14 + EMOJI_CONSISTENCY: + value: + noEmojisAllowedInTarget: true + SPELLCHECK: + value: + skipIfWordInUserDictionary: false + skipIfWordStartsWithCapitalLetter: true + skipIfWordAppearsInSourceString: false + skipIfWordValidInSourceLocale: true + runSpellcheckForSubWords: true + SOURCE_IN_WRONG_LANGUAGE: + value: + minTextLengthLimit: 10 + TARGET_IN_WRONG_LANGUAGE: + value: + minTextLengthLimit: 15 + NUMBER_CONSISTENCY: + value: + ignoreSign: true + TARGET_SOURCE_CONSISTENCY: + value: + ignoreTagsAndPlaceholders: true + ignoreCase: true + GLOSSARY_COMPLIANCE: + value: + matchMethod: MATCH_BY_PERCENTAGE + matchThreshold: 10 + sameTermCount: true + ORIGINAL_EQUALS_TARGET: + value: + mustHaveIdenticalTags: false + mustHaveIdenticalCapitalization: false + SEGMENT_COMPLETENESS: + value: + lowerLengthThreshold: 10 + upperLengthThreshold: 20 + minLengthThreshold: 15 + OPEN_ISSUES: + value: + sourceIssuesMustBeResolved: true + translationIssuesMustBeResolved: true + '400': *ref_12 + '401': *ref_13 + '429': *ref_14 + '500': *ref_15 x-code-samples: - lang: curl source: > @@ -1833,7 +2352,7 @@ x-paths: properties: response: allOf: - - *ref_3 + - *ref_10 - type: object properties: data: @@ -1848,8 +2367,7 @@ x-paths: anyOf: - title: BLACKLISTED_TERMS allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -1860,9 +2378,8 @@ x-paths: example: BLACKLISTED_TERMS - title: EMOJI_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_15 + - *ref_6 + - *ref_16 - type: object properties: checkTypeCode: @@ -1886,8 +2403,7 @@ x-paths: example: EMOJI_ADDED - title: GLOBAL_CAPITALISATION_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -1898,9 +2414,8 @@ x-paths: example: GLOBAL_CAPITALISATION_CONSISTENCY - title: GLOSSARY_COMPLIANCE allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_21 + - *ref_5 + - *ref_23 - type: object properties: sameTermCount: @@ -1921,8 +2436,7 @@ x-paths: example: GLOSSARY_COMPLIANCE - title: GRAMMAR_CHECK allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -1933,8 +2447,7 @@ x-paths: example: GRAMMAR_CHECK - title: INSERTABLE_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_6 - type: object properties: checkTypeCode: @@ -1957,8 +2470,7 @@ x-paths: example: INSERTABLE_ADDED - title: LEADING_TRAILING_SPACES allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object required: - checkTypeCode @@ -1971,8 +2483,7 @@ x-paths: example: LEADING_TRAILING_SPACES - title: NON_TRANSLATABLE_TEXT allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -1997,9 +2508,8 @@ x-paths: example: PLACEABLE_ADDED - title: NUMBER_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_19 + - *ref_6 + - *ref_21 - type: object properties: checkTypeCode: @@ -2023,9 +2533,8 @@ x-paths: example: NUMBER_ADDED - title: ORIGINAL_EQUALS_TARGET allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_23 + - *ref_5 + - *ref_25 - type: object required: - checkTypeCode @@ -2038,8 +2547,7 @@ x-paths: example: ORIGINAL_EQUALS_TARGET - title: REPEATED_WORD allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -2050,9 +2558,8 @@ x-paths: example: REPEATED_WORD - title: SEGMENT_COMPLETENESS allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_24 + - *ref_6 + - *ref_26 - type: object properties: checkTypeCode: @@ -2076,9 +2583,8 @@ x-paths: example: TARGET_IS_EMPTY - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_17 + - *ref_5 + - *ref_19 - type: object properties: checkTypeCode: @@ -2089,9 +2595,8 @@ x-paths: example: SOURCE_IN_WRONG_LANGUAGE - title: SPELLCHECK allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_16 + - *ref_5 + - *ref_17 - type: object properties: checkTypeCode: @@ -2102,8 +2607,7 @@ x-paths: example: SPELLCHECK - title: TAG_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_6 - type: object properties: checkTypeCode: @@ -2128,9 +2632,8 @@ x-paths: example: TAG_ADDED - title: TARGET_IN_WRONG_LANGUAGE allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_18 + - *ref_5 + - *ref_20 - type: object properties: checkTypeCode: @@ -2141,8 +2644,7 @@ x-paths: example: TARGET_IN_WRONG_LANGUAGE - title: TARGET_LENGTH_LIMIT allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -2153,9 +2655,8 @@ x-paths: example: TARGET_LENGTH_LIMIT - title: TARGET_SOURCE_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_20 + - *ref_6 + - *ref_22 - type: object properties: checkTypeCode: @@ -2178,8 +2679,7 @@ x-paths: example: SAME_SOURCE_DIFFERENT_TRANSLATIONS - title: TRADEMARK_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -2190,8 +2690,7 @@ x-paths: example: TRADEMARK_CONSISTENCY - title: WHITESPACES allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -2202,8 +2701,7 @@ x-paths: example: WHITESPACES - title: PUNCTUATION_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -2214,8 +2712,7 @@ x-paths: example: PUNCTUATION_CONSISTENCY - title: PLURALS_REPETITION allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -2226,8 +2723,7 @@ x-paths: example: PLURALS_REPETITION - title: REGEX_CHECK allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -2238,14 +2734,11 @@ x-paths: example: REGEX_CHECK rules: type: array - items: - $ref: >- - ../tqc_common.yaml#/components/schemas/regexRuleWithRuleUid + items: *ref_11 - title: OPEN_ISSUES allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_25 + - *ref_5 + - *ref_27 - type: object required: - checkTypeCode @@ -2257,12 +2750,212 @@ x-paths: description: check type code example: OPEN_ISSUES example: - $ref: >- - ../examples.yaml#/components/examples/projects_check_types_settings_example - '400': *ref_11 - '401': *ref_12 - '429': *ref_13 - '500': *ref_14 + response: + code: SUCCESS + data: + totalCount: 24 + items: + - severityLevelCode: LOW + checkTypeCode: LEADING_TRAILING_SPACES + subTypes: [] + localeSeverityLevels: [] + groups: [] + - severityLevelCode: LOW + checkTypeCode: ORIGINAL_EQUALS_TARGET + subTypes: [] + localeSeverityLevels: [] + groups: [] + mustHaveIdenticalTags: true + mustHaveIdenticalCapitalization: true + - severityLevelCode: LOW + checkTypeCode: WHITESPACES + subTypes: [] + localeSeverityLevels: [] + groups: [] + - severityLevelCode: LOW + checkTypeCode: SPELLCHECK + subTypes: [] + localeSeverityLevels: [] + groups: [] + skipIfWordInUserDictionary: true + skipIfWordStartsWithCapitalLetter: false + skipIfWordAppearsInSourceString: true + skipIfWordValidInSourceLocale: false + runSpellcheckForSubWords: false + - severityLevelCode: LOW + checkTypeCode: TAG_CONSISTENCY + subTypes: + - checkSubTypeCode: TAG_ADDED + severityLevelCode: LOW + - checkSubTypeCode: TAG_DELETED + severityLevelCode: LOW + - checkSubTypeCode: TAG_ORDER_IS_CHANGED + severityLevelCode: LOW + - checkSubTypeCode: SPACES_AROUND_TAGS + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] + - severityLevelCode: HIGH + checkTypeCode: TARGET_LENGTH_LIMIT + subTypes: [] + localeSeverityLevels: [] + groups: [] + - severityLevelCode: LOW + checkTypeCode: NUMBER_CONSISTENCY + subTypes: + - checkSubTypeCode: NUMBER_DELETED + severityLevelCode: LOW + - checkSubTypeCode: NUMBER_ADDED + severityLevelCode: LOW + - checkSubTypeCode: NUMBER_INCORRECT_CONVERSION + severityLevelCode: LOW + localeSeverityLevels: [] + groups: + - groupUid: b0dd258b05ee + - groupUid: a853df2cf8ac + ignoreSign: true + - severityLevelCode: LOW + checkTypeCode: REPEATED_WORD + subTypes: [] + localeSeverityLevels: [] + groups: [] + - severityLevelCode: LOW + checkTypeCode: TARGET_IN_WRONG_LANGUAGE + subTypes: [] + localeSeverityLevels: [] + groups: [] + minTextLengthLimit: 40 + - severityLevelCode: LOW + checkTypeCode: SOURCE_IN_WRONG_LANGUAGE + subTypes: [] + localeSeverityLevels: [] + groups: [] + minTextLengthLimit: 40 + - severityLevelCode: MEDIUM + checkTypeCode: SEGMENT_COMPLETENESS + subTypes: + - checkSubTypeCode: TARGET_IS_MUCH_SHORTER_THAN_SOURCE + severityLevelCode: MEDIUM + - checkSubTypeCode: TARGET_IS_MUCH_LONGER_THAN_SOURCE + severityLevelCode: MEDIUM + - checkSubTypeCode: TARGET_IS_EMPTY + severityLevelCode: DISABLED + localeSeverityLevels: [] + groups: [] + lowerLengthThreshold: 50 + upperLengthThreshold: 250 + minLengthThreshold: 10 + - severityLevelCode: MEDIUM + checkTypeCode: NON_TRANSLATABLE_TEXT + subTypes: + - checkSubTypeCode: PLACEABLE_DELETED + severityLevelCode: MEDIUM + - checkSubTypeCode: SPACES_AROUND_PLACEABLE + severityLevelCode: MEDIUM + - checkSubTypeCode: PLACEABLE_ADDED + severityLevelCode: MEDIUM + - checkSubTypeCode: PLACEABLE_FORMAT + severityLevelCode: MEDIUM + localeSeverityLevels: [] + groups: [] + - severityLevelCode: LOW + checkTypeCode: EMOJI_CONSISTENCY + subTypes: + - checkSubTypeCode: EMOJI_PRESENT + severityLevelCode: DISABLED + - checkSubTypeCode: EMOJI_DELETED + severityLevelCode: LOW + - checkSubTypeCode: EMOJI_ADDED + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] + noEmojisAllowedInTarget: false + - severityLevelCode: LOW + checkTypeCode: INSERTABLE_CONSISTENCY + subTypes: + - checkSubTypeCode: INSERTABLE_DELETED + severityLevelCode: LOW + - checkSubTypeCode: INSERTABLE_ADDED + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] + - severityLevelCode: LOW + checkTypeCode: TARGET_SOURCE_CONSISTENCY + subTypes: + - checkSubTypeCode: SAME_TRANSLATION_DIFFERENT_SOURCES + severityLevelCode: LOW + - checkSubTypeCode: SAME_SOURCE_DIFFERENT_TRANSLATIONS + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] + ignoreTagsAndPlaceholders: true + ignoreCase: true + - severityLevelCode: MEDIUM + checkTypeCode: BLACKLISTED_TERMS + subTypes: [] + localeSeverityLevels: [] + groups: [] + - severityLevelCode: MEDIUM + checkTypeCode: GLOSSARY_COMPLIANCE + subTypes: [] + localeSeverityLevels: [] + groups: [] + matchMethod: MATCH_BY_PERCENTAGE + matchThreshold: 50 + sameTermCount: true + - severityLevelCode: LOW + checkTypeCode: TRADEMARK_CONSISTENCY + subTypes: [] + localeSeverityLevels: [] + groups: [] + - severityLevelCode: LOW + checkTypeCode: GRAMMAR_CHECK + subTypes: [] + localeSeverityLevels: [] + groups: [] + - severityLevelCode: LOW + checkTypeCode: GLOBAL_CAPITALISATION_CONSISTENCY + subTypes: [] + localeSeverityLevels: [] + groups: [] + - severityLevelCode: LOW + checkTypeCode: PUNCTUATION_CONSISTENCY + subTypes: [] + localeSeverityLevels: [] + groups: [] + - severityLevelCode: MEDIUM + checkTypeCode: PLURALS_REPETITION + subTypes: [] + localeSeverityLevels: [] + groups: [] + - severityLevelCode: LOW + checkTypeCode: REGEX_CHECK + subTypes: [] + groups: [] + rules: + - ruleUid: 2d83ea74c848 + severityLevelCode: LOW + ruleName: ruleName1 + ruleTypeCode: FORBIDDEN + flavorCode: JAVA + originalPattern: '@mail' + translationPattern: '@gmail' + description: ruleName1 description + caseInsensitive: true + multiLine: false + warningMessage: test warning + groups: [] + - severityLevelCode: LOW + checkTypeCode: OPEN_ISSUES + subTypes: [] + localeSeverityLevels: [] + groups: [] + sourceIssuesMustBeResolved: true + translationIssuesMustBeResolved: true + '400': *ref_12 + '401': *ref_13 + '429': *ref_14 + '500': *ref_15 x-code-samples: - lang: curl source: > diff --git a/spec/translation_quality/examples.yaml b/spec/translation_quality/examples.yaml index 27c99e89..c1dcfdd3 100644 --- a/spec/translation_quality/examples.yaml +++ b/spec/translation_quality/examples.yaml @@ -465,7 +465,8 @@ components: "pluralForm": null "useDefaultSettings": false "checkTypeCodes": - - $ref: './tqc_common.yaml#/components/schemas/checkTypeCodeEnum' + - "BLACKLISTED_TERMS" + - "EMOJI_CONSISTENCY" tqc_check_response_example: BLACKLISTED_TERMS: diff --git a/spec/translation_quality/tqc_check.yaml b/spec/translation_quality/tqc_check.yaml index ded54bae..8d707c16 100644 --- a/spec/translation_quality/tqc_check.yaml +++ b/spec/translation_quality/tqc_check.yaml @@ -76,8 +76,9 @@ components: maxItems: 100 type: array items: - allOf: - - $ref: './tqc_common.yaml#/components/requestBodies/checkTypeCode' + - type: string + allOf: + - $ref: './tqc_common.yaml#/components/requestBodies/checkTypeCode' description: '[check type codes](#operation/getTranslationQualityCheckTypes)' TqcCheckResponse: @@ -129,4 +130,4 @@ components: mistakes: type: array items: - $ref: 'tqc_common.yaml#/components/schemas/TqcCheckMistakeDTOs' + - $ref: './tqc_common.yaml#/components/schemas/TqcCheckMistakeDTOs' diff --git a/spec/translation_quality/tqc_check_result.yaml b/spec/translation_quality/tqc_check_result.yaml index d9152a8e..b6259ff5 100644 --- a/spec/translation_quality/tqc_check_result.yaml +++ b/spec/translation_quality/tqc_check_result.yaml @@ -110,40 +110,60 @@ x-paths: maxItems: 100 type: array items: - allOf: - - type: object - properties: - checkTypeCode: - enum: - - LEADING_TRAILING_SPACES - - ORIGINAL_EQUALS_TARGET - - WHITESPACES - - SPELLCHECK - - TAG_CONSISTENCY - - TARGET_LENGTH_LIMIT - - NUMBER_CONSISTENCY - - REPEATED_WORD - - TARGET_IN_WRONG_LANGUAGE - - SOURCE_IN_WRONG_LANGUAGE - - SEGMENT_COMPLETENESS - - NON_TRANSLATABLE_TEXT - - EMOJI_CONSISTENCY - - INSERTABLE_CONSISTENCY - - TARGET_SOURCE_CONSISTENCY - - BLACKLISTED_TERMS - - GLOSSARY_COMPLIANCE - - TRADEMARK_CONSISTENCY - - GRAMMAR_CHECK - - GLOBAL_CAPITALISATION_CONSISTENCY - - PUNCTUATION_CONSISTENCY - - PLURALS_REPETITION - - REGEX_CHECK - - OPEN_ISSUES + - type: string + allOf: + - type: object + properties: + checkTypeCode: + enum: + - LEADING_TRAILING_SPACES + - ORIGINAL_EQUALS_TARGET + - WHITESPACES + - SPELLCHECK + - TAG_CONSISTENCY + - TARGET_LENGTH_LIMIT + - NUMBER_CONSISTENCY + - REPEATED_WORD + - TARGET_IN_WRONG_LANGUAGE + - SOURCE_IN_WRONG_LANGUAGE + - SEGMENT_COMPLETENESS + - NON_TRANSLATABLE_TEXT + - EMOJI_CONSISTENCY + - INSERTABLE_CONSISTENCY + - TARGET_SOURCE_CONSISTENCY + - BLACKLISTED_TERMS + - GLOSSARY_COMPLIANCE + - TRADEMARK_CONSISTENCY + - GRAMMAR_CHECK + - GLOBAL_CAPITALISATION_CONSISTENCY + - PUNCTUATION_CONSISTENCY + - PLURALS_REPETITION + - REGEX_CHECK + - OPEN_ISSUES description: >- [check type codes](#operation/getTranslationQualityCheckTypes) example: - $ref: './examples.yaml#/components/examples/tqc_check_request_body_example' + targetLocaleId: en-US + sourceLocaleId: fr-FR + skipSuggestions: false + strings: + - originalString: Bonjour © + translation: Hello + hashcode: 9091152182c69d9b72069ac1290fe2345 + stringUid: null + pluralFormGroupUid: null + pluralForm: null + - originalString: Bonjour 100 + translation: Hello 100 + hashcode: 1091152182c69d9b72069ac1290fe23999 + stringUid: null + pluralFormGroupUid: null + pluralForm: null + useDefaultSettings: false + checkTypeCodes: + - BLACKLISTED_TERMS + - EMOJI_CONSISTENCY responses: '200': description: OK @@ -210,841 +230,1559 @@ x-paths: mistakes: type: array items: - oneOf: - - title: BLACKLISTED_TERMS - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - BLACKLISTED_TERMS - description: check type code - example: BLACKLISTED_TERMS - details: - type: object - nullable: true - properties: - blacklistedTermUid: - type: string - description: black listed term unique identifier - example: uidgj1 - termText: - type: string - description: term text - example: blacklist_term - alternatives: - type: array - items: - type: string - example: alternative 1 - notes: - type: string - description: notes - example: '' - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: EMOJI_CONSISTENCY - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - EMOJI_CONSISTENCY - description: check type code - example: EMOJI_CONSISTENCY - details: - nullable: true - type: object - properties: - emoji: - type: string - description: emoji symbol - example: 😀 - type: - type: string - enum: - - EMOJI_ADDED - - EMOJI_DELETED - - EMOJI_PRESENT - description: emoji defect type - example: EMOJI_DELETED - positionTypeCode: - type: string - enum: - - SOURCE - - TARGET - description: position type code - example: SOURCE - - title: GLOBAL_CAPITALISATION_CONSISTENCY - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - GLOBAL_CAPITALISATION_CONSISTENCY - description: check type code - example: GLOBAL_CAPITALISATION_CONSISTENCY - details: - nullable: true - type: object - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: GLOSSARY_COMPLIANCE - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - GLOSSARY_COMPLIANCE - description: check type code - example: GLOSSARY_COMPLIANCE - details: - type: object - nullable: true - properties: - glossaryTerm: + - oneOf: + - title: BLACKLISTED_TERMS + allOf: + - &ref_0 + type: object + properties: + severityLevelCode: &ref_2 + enum: + - DISABLED + - LOW + - MEDIUM + - HIGH + - &ref_1 + type: object + properties: + positions: + type: array + items: type: object properties: - termUid: - type: string - description: term uid - example: cdd443b9-814f-442c-9ba6-4d97e0afce74 - translation: - type: object - properties: - localeId: - type: string - description: locale identifier - example: ru-RU - translatedTerm: - type: string - description: translated term - example: изменить размер - notes: - type: string - description: notes - example: '' - translatorUserUid: - type: string - description: translator user identifier - example: 23ddd32e - lockTranslation: - type: boolean - description: lock translation - example: false - submittedForTranslation: - type: boolean - description: submitted for translation - example: false - createdDate: - type: string - description: created date - example: '2018-11-16T16:06:53Z' - modifiedDate: - type: string - description: modified date - example: '2018-11-17T16:06:53Z' - termText: - type: string - description: term text - example: resize - caseSensitive: - type: boolean - description: case sensitive - example: false - exactMatch: - type: boolean - description: exact match - example: false - definition: - type: string - description: definition - example: '' - variations: - type: string - description: variations - example: '' - synonyms: - type: string - description: synonyms - example: '' - antonyms: - type: string - description: antonyms - example: '' - seo: - type: boolean - description: seo - example: false - doNotTranslate: - type: boolean - description: do not translate - example: false - notes: - type: string - description: notes - example: '' - partOfSpeechCode: - type: string - description: part of speech code - example: UNSPECIFIED - createdByUserUid: - type: string - description: created by user identifier - example: xas344dsd3 - createdDate: - type: string - description: created date - example: '2018-11-16T16:06:53Z' - modifiedDate: - type: string - description: modified date - example: '2018-11-17T16:06:53Z' - positionTypeCode: - type: string - enum: - - TARGET - - SOURCE - description: position type code - example: SOURCE - - title: GRAMMAR_CHECK - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - GRAMMAR_CHECK - description: check type code - example: GRAMMAR_CHECK - details: - nullable: true - type: object - properties: - text: - type: string - description: text - example: play - message: - type: string - description: message - example: >- - Possible agreement error -- use past - participle here: - played. - description: - type: string - description: description - example: Had + verb present tense - mistakeTypeCode: - type: string - description: mistake type code - example: Grammar - suggestions: - type: array - items: + from: + type: integer + description: start position in the string + to: + type: integer + description: end position in the string + - type: object + properties: + checkTypeCode: + type: string + enum: + - BLACKLISTED_TERMS + description: check type code + example: BLACKLISTED_TERMS + details: + type: object + nullable: true + properties: + blacklistedTermUid: type: string - example: played - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: INSERTABLE_CONSISTENCY - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - INSERTABLE_CONSISTENCY - description: check type code - example: INSERTABLE_CONSISTENCY - details: - type: object - nullable: true - properties: - insertable: - type: string - description: insertable - example:
- insertableType: - type: string - description: insertable type - example: BR_TAG - type: - type: string - enum: - - INSERTABLE_ADDED - - INSERTABLE_DELETED - description: insertable - example: INSERTABLE_DELETED - positionTypeCode: - type: string - enum: - - TARGET - - SOURCE - description: position type code - example: SOURCE - - title: LEADING_TRAILING_SPACES - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - description: check type code - example: LEADING_TRAILING_SPACES - details: - type: object - nullable: true - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: NON_TRANSLATABLE_TEXT - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - NON_TRANSLATABLE_TEXT - description: check type code - example: NON_TRANSLATABLE_TEXT - details: - type: object - nullable: true - properties: - placeable: - type: string - description: placeable - example: '{0}' - type: - type: string - enum: - - PLACEABLE_ADDED - - PLACEABLE_DELETED - - SPACES_AROUND_PLACEABLE - - PLACEABLE_FORMAT - description: type - example: PLACEABLE_DELETED - positionTypeCode: - type: string - enum: - - TARGET - - SOURCE - description: position type code - example: SOURCE - - title: NUMBER_CONSISTENCY - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - NUMBER_CONSISTENCY - description: check type code - example: NUMBER_CONSISTENCY - details: - type: object - nullable: true - oneOf: - - type: object - title: NUMBER_ADDED - properties: - type: - type: string - enum: - - NUMBER_ADDED - example: NUMBER_ADDED - number: - type: string - description: number - example: '1000' - - type: object - title: NUMBER_DELETED - properties: - type: + description: black listed term unique identifier + example: uidgj1 + termText: + type: string + description: term text + example: blacklist_term + alternatives: + type: array + items: type: string - enum: - - NUMBER_DELETED - example: NUMBER_DELETED - number: + example: alternative 1 + notes: + type: string + description: notes + example: '' + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: EMOJI_CONSISTENCY + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - EMOJI_CONSISTENCY + description: check type code + example: EMOJI_CONSISTENCY + details: + nullable: true + type: object + properties: + emoji: + type: string + description: emoji symbol + example: 😀 + type: + type: string + enum: + - EMOJI_ADDED + - EMOJI_DELETED + - EMOJI_PRESENT + description: emoji defect type + example: EMOJI_DELETED + positionTypeCode: + type: string + enum: + - SOURCE + - TARGET + description: position type code + example: SOURCE + - title: GLOBAL_CAPITALISATION_CONSISTENCY + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - GLOBAL_CAPITALISATION_CONSISTENCY + description: check type code + example: GLOBAL_CAPITALISATION_CONSISTENCY + details: + nullable: true + type: object + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: GLOSSARY_COMPLIANCE + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - GLOSSARY_COMPLIANCE + description: check type code + example: GLOSSARY_COMPLIANCE + details: + type: object + nullable: true + properties: + glossaryTerm: + type: object + properties: + termUid: + type: string + description: term uid + example: cdd443b9-814f-442c-9ba6-4d97e0afce74 + translation: + type: object + properties: + localeId: + type: string + description: locale identifier + example: ru-RU + translatedTerm: + type: string + description: translated term + example: изменить размер + notes: + type: string + description: notes + example: '' + translatorUserUid: + type: string + description: translator user identifier + example: 23ddd32e + lockTranslation: + type: boolean + description: lock translation + example: false + submittedForTranslation: + type: boolean + description: submitted for translation + example: false + createdDate: + type: string + description: created date + example: '2018-11-16T16:06:53Z' + modifiedDate: + type: string + description: modified date + example: '2018-11-17T16:06:53Z' + termText: + type: string + description: term text + example: resize + caseSensitive: + type: boolean + description: case sensitive + example: false + exactMatch: + type: boolean + description: exact match + example: false + definition: + type: string + description: definition + example: '' + variations: + type: string + description: variations + example: '' + synonyms: + type: string + description: synonyms + example: '' + antonyms: + type: string + description: antonyms + example: '' + seo: + type: boolean + description: seo + example: false + doNotTranslate: + type: boolean + description: do not translate + example: false + notes: + type: string + description: notes + example: '' + partOfSpeechCode: + type: string + description: part of speech code + example: UNSPECIFIED + createdByUserUid: + type: string + description: created by user identifier + example: xas344dsd3 + createdDate: + type: string + description: created date + example: '2018-11-16T16:06:53Z' + modifiedDate: + type: string + description: modified date + example: '2018-11-17T16:06:53Z' + positionTypeCode: + type: string + enum: + - TARGET + - SOURCE + description: position type code + example: SOURCE + - title: GRAMMAR_CHECK + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - GRAMMAR_CHECK + description: check type code + example: GRAMMAR_CHECK + details: + nullable: true + type: object + properties: + text: + type: string + description: text + example: play + message: + type: string + description: message + example: >- + Possible agreement error -- use past + participle here: + played. + description: + type: string + description: description + example: Had + verb present tense + mistakeTypeCode: + type: string + description: mistake type code + example: Grammar + suggestions: + type: array + items: type: string - description: number - example: '1000' - - type: object - title: NUMBER_INCORRECT_CONVERSION - properties: - type: + example: played + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: INSERTABLE_CONSISTENCY + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - INSERTABLE_CONSISTENCY + description: check type code + example: INSERTABLE_CONSISTENCY + details: + type: object + nullable: true + properties: + insertable: + type: string + description: insertable + example:
+ insertableType: + type: string + description: insertable type + example: BR_TAG + type: + type: string + enum: + - INSERTABLE_ADDED + - INSERTABLE_DELETED + description: insertable + example: INSERTABLE_DELETED + positionTypeCode: + type: string + enum: + - TARGET + - SOURCE + description: position type code + example: SOURCE + - title: LEADING_TRAILING_SPACES + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + description: check type code + example: LEADING_TRAILING_SPACES + details: + type: object + nullable: true + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: NON_TRANSLATABLE_TEXT + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - NON_TRANSLATABLE_TEXT + description: check type code + example: NON_TRANSLATABLE_TEXT + details: + type: object + nullable: true + properties: + placeable: + type: string + description: placeable + example: '{0}' + type: + type: string + enum: + - PLACEABLE_ADDED + - PLACEABLE_DELETED + - SPACES_AROUND_PLACEABLE + - PLACEABLE_FORMAT + description: type + example: PLACEABLE_DELETED + positionTypeCode: + type: string + enum: + - TARGET + - SOURCE + description: position type code + example: SOURCE + - title: NUMBER_CONSISTENCY + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - NUMBER_CONSISTENCY + description: check type code + example: NUMBER_CONSISTENCY + details: + type: object + nullable: true + oneOf: + - type: object + title: NUMBER_ADDED + properties: + type: + type: string + enum: + - NUMBER_ADDED + example: NUMBER_ADDED + number: + type: string + description: number + example: '1000' + - type: object + title: NUMBER_DELETED + properties: + type: + type: string + enum: + - NUMBER_DELETED + example: NUMBER_DELETED + number: + type: string + description: number + example: '1000' + - type: object + title: NUMBER_INCORRECT_CONVERSION + properties: + type: + type: string + enum: + - NUMBER_INCORRECT_CONVERSION + example: NUMBER_INCORRECT_CONVERSION + number: + type: string + description: number + example: 1000,1 + expectedFormat: + type: string + description: number expected format + example: 1,000.10 + positionTypeCode: + type: string + enum: + - TARGET + - SOURCE + description: position type code + example: SOURCE + - title: ORIGINAL_EQUALS_TARGET + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - ORIGINAL_EQUALS_TARGET + description: check type code + example: ORIGINAL_EQUALS_TARGET + details: + nullable: true + type: object + properties: + types: + type: array + items: type: string enum: - - NUMBER_INCORRECT_CONVERSION - example: NUMBER_INCORRECT_CONVERSION - number: - type: string - description: number - example: 1000,1 - expectedFormat: - type: string - description: number expected format - example: 1,000.10 - positionTypeCode: - type: string - enum: - - TARGET - - SOURCE - description: position type code - example: SOURCE - - title: ORIGINAL_EQUALS_TARGET - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - ORIGINAL_EQUALS_TARGET - description: check type code - example: ORIGINAL_EQUALS_TARGET - details: - nullable: true - type: object - properties: - types: - type: array - items: + - IDENTICAL_CAPITALIZATION + - IDENTICAL_TAGS + example: >- + ["IDENTICAL_CAPITALIZATION", + "IDENTICAL_TAGS"] + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: REPEATED_WORD + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - REPEATED_WORD + description: check type code + example: REPEATED_WORD + details: + nullable: true + type: object + properties: + word: + type: string + description: word + example: szia + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: SEGMENT_COMPLETENESS + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - SEGMENT_COMPLETENESS + description: check type code + example: SEGMENT_COMPLETENESS + details: + type: object + nullable: true + properties: + type: type: string enum: - - IDENTICAL_CAPITALIZATION - - IDENTICAL_TAGS + - TARGET_IS_EMPTY + - TARGET_IS_MUCH_SHORTER_THAN_SOURCE + - TARGET_IS_MUCH_LONGER_THAN_SOURCE + description: word + example: TARGET_IS_MUCH_SHORTER_THAN_SOURCE + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: SOURCE_IN_WRONG_LANGUAGE + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - SOURCE_IN_WRONG_LANGUAGE + description: check type code + example: SOURCE_IN_WRONG_LANGUAGE + details: + nullable: true + type: object + positionTypeCode: + type: string + enum: + - SOURCE + description: position type code + example: SOURCE + - title: SPELLCHECK + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - SPELLCHECK + description: check type code + example: SPELLCHECK + details: + type: object + nullable: true + properties: + word: + type: string + description: word + example: Sziaa + suggestions: + type: array + items: + type: string + description: suggestions example: >- - ["IDENTICAL_CAPITALIZATION", - "IDENTICAL_TAGS"] - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: REPEATED_WORD - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - REPEATED_WORD - description: check type code - example: REPEATED_WORD - details: - nullable: true - type: object - properties: - word: - type: string - description: word - example: szia - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: SEGMENT_COMPLETENESS - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - SEGMENT_COMPLETENESS - description: check type code - example: SEGMENT_COMPLETENESS - details: - type: object - nullable: true - properties: - type: - type: string - enum: - - TARGET_IS_EMPTY - - TARGET_IS_MUCH_SHORTER_THAN_SOURCE - - TARGET_IS_MUCH_LONGER_THAN_SOURCE - description: word - example: TARGET_IS_MUCH_SHORTER_THAN_SOURCE - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: SOURCE_IN_WRONG_LANGUAGE - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - SOURCE_IN_WRONG_LANGUAGE - description: check type code - example: SOURCE_IN_WRONG_LANGUAGE - details: - nullable: true - type: object - positionTypeCode: - type: string - enum: - - SOURCE - description: position type code - example: SOURCE - - title: SPELLCHECK - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - SPELLCHECK - description: check type code - example: SPELLCHECK - details: - type: object - nullable: true - properties: - word: - type: string - description: word - example: Sziaa - suggestions: - type: array - items: + ["Szia", "Szita", "Szila", "Szia a", + "Szilvia"] + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: TAG_CONSISTENCY + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - TAG_CONSISTENCY + description: check type code + example: TAG_CONSISTENCY + details: + type: object + nullable: true + properties: + tag: + type: string + description: tag + example:

+ type: + type: string + enum: + - TAG_ADDED + - TAG_DELETED + - SPACES_AROUND_TAGS + - TAG_ORDER_IS_CHANGED + example: TAG_DELETED + positionTypeCode: + type: string + enum: + - TARGET + - SOURCE + description: position type code + example: SOURCE + - title: TARGET_IN_WRONG_LANGUAGE + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - TARGET_IN_WRONG_LANGUAGE + description: check type code + example: TARGET_IN_WRONG_LANGUAGE + details: + type: object + nullable: true + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: TARGET_LENGTH_LIMIT + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - TARGET_LENGTH_LIMIT + description: check type code + example: TARGET_LENGTH_LIMIT + details: + type: object + nullable: true + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: TARGET_SOURCE_CONSISTENCY + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - TARGET_SOURCE_CONSISTENCY + description: check type code + example: TARGET_SOURCE_CONSISTENCY + details: + type: object + nullable: true + properties: + type: + type: string + enum: + - SAME_SOURCE_DIFFERENT_TRANSLATIONS + - SAME_TRANSLATION_DIFFERENT_SOURCES + description: type + example: SAME_SOURCE_DIFFERENT_TRANSLATIONS + originalString: + type: string + description: original string + example: I like to go to the mountains very much. + translation: type: string - description: suggestions - example: >- - ["Szia", "Szita", "Szila", "Szia a", - "Szilvia"] - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: TAG_CONSISTENCY - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - TAG_CONSISTENCY - description: check type code - example: TAG_CONSISTENCY - details: - type: object - nullable: true - properties: - tag: - type: string - description: tag - example:

- type: - type: string - enum: - - TAG_ADDED - - TAG_DELETED - - SPACES_AROUND_TAGS - - TAG_ORDER_IS_CHANGED - example: TAG_DELETED - positionTypeCode: - type: string - enum: - - TARGET - - SOURCE - description: position type code - example: SOURCE - - title: TARGET_IN_WRONG_LANGUAGE - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - TARGET_IN_WRONG_LANGUAGE - description: check type code - example: TARGET_IN_WRONG_LANGUAGE - details: - type: object - nullable: true - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: TARGET_LENGTH_LIMIT - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - TARGET_LENGTH_LIMIT - description: check type code - example: TARGET_LENGTH_LIMIT - details: - type: object - nullable: true - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: TARGET_SOURCE_CONSISTENCY - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - TARGET_SOURCE_CONSISTENCY - description: check type code - example: TARGET_SOURCE_CONSISTENCY - details: - type: object - nullable: true - properties: - type: - type: string - enum: - - SAME_SOURCE_DIFFERENT_TRANSLATIONS - - SAME_TRANSLATION_DIFFERENT_SOURCES - description: type - example: SAME_SOURCE_DIFFERENT_TRANSLATIONS - originalString: - type: string - description: original string - example: I like to go to the mountains very much. - translation: - type: string - description: translation - example: Ich möchte an den Strand gehen. - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: TRADEMARK_CONSISTENCY - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - TRADEMARK_CONSISTENCY - description: check type code - example: TRADEMARK_CONSISTENCY - details: - type: object - nullable: true - properties: - trademarkTypeCode: - type: string - enum: - - SERVICE_MARK - - COPYRIGHT - - REGISTERED - - TRADEMARK - description: trademark type code - example: COPYRIGHT - positionTypeCode: - type: string - enum: - - SOURCE - description: position type code - example: SOURCE - - title: WHITESPACES - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - WHITESPACES - description: check type code - example: WHITESPACES - details: - type: object - nullable: true - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: PUNCTUATION_CONSISTENCY - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - PUNCTUATION_CONSISTENCY - description: check type code - example: PUNCTUATION_CONSISTENCY - details: - nullable: true - type: object - positionTypeCode: - type: string - enum: - - SOURCE - description: position type code - example: SOURCE - - title: PLURALS_REPETITION - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - PLURALS_REPETITION - description: check type code - example: PLURALS_REPETITION - details: - nullable: true - type: object - properties: - pluralFormGroupUid: - type: string - description: unique identifier of plural form - example: 7191152182c69d9b72069ac1290fe24b - repeatedPluralForms: - type: array - items: + description: translation + example: Ich möchte an den Strand gehen. + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: TRADEMARK_CONSISTENCY + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - TRADEMARK_CONSISTENCY + description: check type code + example: TRADEMARK_CONSISTENCY + details: + type: object + nullable: true + properties: + trademarkTypeCode: type: string - example: ONE - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: REGEX_CHECK - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - REGEX_CHECK - description: check type code - example: REGEX_CHECK - details: - type: object - nullable: true - oneOf: - - $ref: './tqc_common.yaml#/components/schemas/regexRuleWithRuleUid' - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: OPEN_ISSUES - allOf: - - $ref: './tqc_common.yaml#/components/schemas/severityLevelCodeResponse' - - $ref: './tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO' - - type: object - properties: - checkTypeCode: - type: string - enum: - - OPEN_ISSUES - description: check type code - example: OPEN_ISSUES - details: - nullable: true - type: object - properties: - sourceIssuesCount: - type: integer - description: text - example: 2 - translationIssuesCount: - type: integer - description: message - example: 3 - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET + enum: + - SERVICE_MARK + - COPYRIGHT + - REGISTERED + - TRADEMARK + description: trademark type code + example: COPYRIGHT + positionTypeCode: + type: string + enum: + - SOURCE + description: position type code + example: SOURCE + - title: WHITESPACES + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - WHITESPACES + description: check type code + example: WHITESPACES + details: + type: object + nullable: true + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: PUNCTUATION_CONSISTENCY + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - PUNCTUATION_CONSISTENCY + description: check type code + example: PUNCTUATION_CONSISTENCY + details: + nullable: true + type: object + positionTypeCode: + type: string + enum: + - SOURCE + description: position type code + example: SOURCE + - title: PLURALS_REPETITION + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - PLURALS_REPETITION + description: check type code + example: PLURALS_REPETITION + details: + nullable: true + type: object + properties: + pluralFormGroupUid: + type: string + description: unique identifier of plural form + example: 7191152182c69d9b72069ac1290fe24b + repeatedPluralForms: + type: array + items: + type: string + example: ONE + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: REGEX_CHECK + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - REGEX_CHECK + description: check type code + example: REGEX_CHECK + details: + type: object + nullable: true + oneOf: + - allOf: + - type: object + properties: + ruleUid: + type: string + description: >- + Unique identifier of corresponding check + rule + example: ce6d6b5dbc12 + - type: object + properties: + ruleName: + type: string + description: Rule name + example: ruleName + severityLevelCode: + enum: + - DISABLED + - LOW + - MEDIUM + - HIGH + ruleTypeCode: + enum: + - FORBIDDEN + - MISSING + - COUNT_MISMATCH + flavorCode: + enum: + - JAVA + - DOT_NET + originalPattern: + type: string + description: >- + Regular expression to evaluate against + the source string. + example: '@mail' + translationPattern: + type: string + description: >- + Regular expression to evaluate against + the translation. + example: '@gmail' + caseInsensitive: + type: boolean + description: Enable case insensitive search + example: true + multiLine: + type: boolean + description: >- + Enables multine search. If true then + search will span newlines in a string. + Users can use ^ and $ characters with + special meaning for beginning of line + and end of line match. + example: true + description: + type: string + description: >- + Human readable description of the role; + shown in the the dashboard UI. + example: rule description + warningMessage: + type: string + description: >- + Human readable warning message appended + to the standard message that is shown in + the CAT tool when the check fails. + example: ' test warning message' + required: + - ruleName + - severityLevelCode + - ruleTypeCode + - flavorCode + - originalPattern + - translationPattern + - caseInsensitive + - multiLine + - type: object + properties: + groups: + type: array + items: + allOf: + - type: object + properties: + groupUid: + type: string + description: >- + Smartling rule group identifier of the + translation + example: ce6d6b5dbc12 + ruleUid: + type: string + description: >- + Smartling rule identifier of the + translation + example: ce6d6b5dbcs2 + targetLocaleIds: + description: The list of target locales. + example: + - ru-RU + items: + type: string + type: array + severityLevelCode: *ref_2 + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: OPEN_ISSUES + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - OPEN_ISSUES + description: check type code + example: OPEN_ISSUES + details: + nullable: true + type: object + properties: + sourceIssuesCount: + type: integer + description: text + example: 2 + translationIssuesCount: + type: integer + description: message + example: 3 + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET examples: - $ref: './examples.yaml#/components/examples/tqc_check_response_example' + BLACKLISTED_TERMS: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: blacklist_term + translation: blacklist_term + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: BLACKLISTED_TERMS + severityLevelCode: MEDIUM + positions: + - from: 0 + to: 14 + details: + blacklistedTermUid: uidgj1 + termText: blacklist_term + alternatives: [] + notes: '' + positionTypeCode: TARGET + EMOJI_CONSISTENCY: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Bonjour 😀 + translation: Hello + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: EMOJI_CONSISTENCY + severityLevelCode: LOW + positions: + - from: 14 + to: 16 + details: + emoji: 😀 + type: EMOJI_DELETED + positionTypeCode: SOURCE + GLOBAL_CAPITALISATION_CONSISTENCY: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: ATTENTION + translation: WARNINg + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: GLOBAL_CAPITALISATION_CONSISTENCY + severityLevelCode: LOW + positions: + - from: 0 + to: 7 + details: null + positionTypeCode: TARGET + GLOSSARY_COMPLIANCE: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: resize + translation: поменять + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: GLOSSARY_COMPLIANCE + severityLevelCode: MEDIUM + positions: + - from: 0 + to: 6 + details: + glossaryTerm: + termUid: cdd443b9-814f-442c-9ba6-4d97e0afce74 + translation: + localeId: ru-RU + translatedTerm: изменить размер + notes: '' + translatorUserUid: null + lockTranslation: false + submittedForTranslation: false + createdDate: '2018-11-16T16:06:53Z' + modifiedDate: '2018-11-16T16:06:53Z' + termText: resize + caseSensitive: false + exactMatch: false + definition: '' + variations: '' + synonyms: '' + antonyms: '' + seo: false + doNotTranslate: false + notes: '' + partOfSpeechCode: UNSPECIFIED + createdByUserUid: f64d50d91867 + createdDate: '2018-11-16T16:06:05Z' + modifiedDate: '2018-11-16T16:06:05Z' + positionTypeCode: SOURCE + INSERTABLE_CONSISTENCY: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Bonjour
+ translation: Hello + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: INSERTABLE_CONSISTENCY + severityLevelCode: LOW + positions: + - from: 13 + to: 17 + details: + insertable:
+ insertableType: BR_TAG + type: INSERTABLE_DELETED + positionTypeCode: SOURCE + LEADING_TRAILING_SPACES: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Bonjour + translation: ' Hello ' + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: LEADING_TRAILING_SPACES + severityLevelCode: LOW + positions: + - from: 0 + to: 1 + - from: 6 + to: 7 + details: null + positionTypeCode: TARGET + NON_TRANSLATABLE_TEXT: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Bonjour {0} + translation: Hello + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: NON_TRANSLATABLE_TEXT + severityLevelCode: MEDIUM + positions: + - from: 6 + to: 9 + details: + placeable: '{0}' + type: PLACEABLE_DELETED + positionTypeCode: SOURCE + NUMBER_CONSISTENCY: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Bonjour 1000 + translation: Hello 20 + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: NUMBER_CONSISTENCY + severityLevelCode: LOW + positions: + - from: 6 + to: 10 + details: + type: NUMBER_DELETED + number: '1000' + positionTypeCode: SOURCE + - checkTypeCode: NUMBER_CONSISTENCY + severityLevelCode: LOW + positions: + from: 5 + to: 7 + details: + type: NUMBER_ADDED + number: '20' + positionTypeCode: TARGET + REPEATED_WORD: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Bonjour + translation: Hello Hello + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: REPEATED_WORD + severityLevelCode: LOW + positions: + from: 5 + to: 9 + details: + word: Hello + positionTypeCode: TARGET + SEGMENT_COMPLETENESS: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Le chien a mangé mes devoirs. + translation: The dog ate + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: SEGMENT_COMPLETENESS + severityLevelCode: MEDIUM + positions: + from: 0 + to: 10 + details: + type: TARGET_IS_MUCH_SHORTER_THAN_SOURCE + positionTypeCode: TARGET + SOURCE_IN_WRONG_LANGUAGE: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Der Hund hat meine Hausaufgaben gegessen. + translation: The dog ate my homework. + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: SOURCE_IN_WRONG_LANGUAGE + severityLevelCode: LOW + positions: + from: 0 + to: 63 + details: null + positionTypeCode: SOURCE + SPELLCHECK: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Le chien a mangé mes devoirs. + translation: The dog ate my homewrk. + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: SPELLCHECK + severityLevelCode: MEDIUM + positions: + from: 0 + to: 5 + details: + word: homewrk + suggestions: + - homework + positionTypeCode: TARGET + TAG_CONSISTENCY: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString:

Bonjour

+ translation:

Hello + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: TAG_CONSISTENCY + severityLevelCode: MEDIUM + positions: + from: 8 + to: 12 + details: + tag:

+ type: TAG_DELETED + positionTypeCode: SOURCE + TARGET_LENGTH_LIMIT: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Bonjour + translation: Hello + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: TARGET_LENGTH_LIMIT + severityLevelCode: HIGH + positions: + from: 0 + to: 4 + details: null + positionTypeCode: TARGET + TARGET_IN_WRONG_LANGUAGE: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Le chien a mangé mes devoirs. + translation: Der Hund hat meine Hausaufgaben gegessen. + hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: TARGET_IN_WRONG_LANGUAGE + severityLevelCode: LOW + positions: + from: 0 + to: 64 + details: null + positionTypeCode: TARGET + TARGET_SOURCE_CONSISTENCY: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Le chien a mangé mes devoirs. + translation: The dog have ate my homework. + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: TARGET_SOURCE_CONSISTENCY + severityLevelCode: LOW + positions: + from: 0 + to: 27 + details: + type: SAME_SOURCE_DIFFERENT_TRANSLATIONS + originalString: Le chien a mangé mes devoirs. + translation: The dog have ate my homework. + positionTypeCode: TARGET + TRADEMARK_CONSISTENCY: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Bonjour © + translation: Hello + hashcode: 9091152182c69d9b72069ac1290fe2345 + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: TRADEMARK_CONSISTENCY + severityLevelCode: LOW + positions: + from: 6 + to: 7 + details: + trademarkTypeCode: COPYRIGHT + positionTypeCode: SOURCE + WHITESPACES: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Bonjour 100 + translation: Hello 100 + hashcode: 1091152182c69d9b72069ac1290fe23999 + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: WHITESPACES + severityLevelCode: LOW + positions: + from: 4 + to: 6 + details: null + positionTypeCode: TARGET + GRAMMAR_CHECK: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Le chien a mangé mes devoirs. + translation: The dog have ate my homework. + hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: GRAMMAR_CHECK + severityLevelCode: LOW + positions: + from: 9 + to: 13 + details: + text: ate + message: Possible agreement error + description: 'Agreement: ''have'' + past/present tense' + mistakeTypeCode: Grammar + suggestions: + - eaten + positionTypeCode: TARGET + ORIGINAL_EQUALS_TARGET: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: hello + translation: hello + hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: ORIGINAL_EQUALS_TARGET + severityLevelCode: LOW + positions: + from: 0 + to: 5 + details: + types: + - IDENTICAL_CAPITALIZATION + - IDENTICAL_TAGS + positionTypeCode: TARGET + PUNCTUATION_CONSISTENCY: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Hello! + translation: Привет. Как дела? + hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: PUNCTUATION_CONSISTENCY + severityLevelCode: LOW + positions: + from: 5 + to: 6 + details: + punctuationMark: '!' + type: PUNCTUATION_MARK_DELETED + punctuationMarkType: TERMINAL + positionTypeCode: SOURCE + PLURALS_REPETITION: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: 2 rows + translation: 2 rows + hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 + stringUid: null + pluralFormGroupUid: a0b1acda22fc97da9c2b9ae5f3b25888 + pluralForm: MANY + mistakes: + - checkTypeCode: PLURALS_REPETITION + severityLevelCode: MEDIUM + positions: + from: 0 + to: 5 + details: + pluralFormGroupUid: a0b1acda22fc97da9c2b9ae5f3b25888 + repeatedPluralForms: + - MANY + - FEW + positionTypeCode: TARGET + REGEX_CHECK: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: test@gmail + translation: test@mail + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: REGEX_CHECK + severityLevelCode: LOW + positions: + - from: 5 + to: 10 + details: + ruleUid: 30606c59ee92 + severityLevelCode: LOW + ruleName: name1 + ruleTypeCode: FORBIDDEN + flavorCode: JAVA + originalPattern: '@f1' + translationPattern: '@f1' + description: name1 description + caseInsensitive: true + multiLine: false + warningMessage: test warning + positionTypeCode: TARGET + ignored: false + OPEN_ISSUES: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: hello + translation: hello + hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: OPEN_ISSUES + severityLevelCode: LOW + positions: + from: 0 + to: 5 + details: + sourceIssuesCount: 5 + translationIssuesCount: 3 + positionTypeCode: TARGET '400': description: Provided request parameters are invalid. content: @@ -1062,7 +1800,7 @@ x-paths: - VALIDATION_ERROR type: string errors: - items: &ref_0 + items: &ref_3 type: object properties: key: @@ -1113,7 +1851,7 @@ x-paths: - AUTHORIZATION_ERROR type: string errors: - items: *ref_0 + items: *ref_3 type: array required: - code @@ -1147,7 +1885,7 @@ x-paths: - MAX_OPERATIONS_LIMIT_EXCEEDED type: string errors: - items: *ref_0 + items: *ref_3 type: array required: - code @@ -1183,7 +1921,7 @@ x-paths: - MAINTENANCE_MODE_ERROR type: string errors: - items: *ref_0 + items: *ref_3 type: array required: - code From 2bc12eac09a4cae885ae3d200c52516c9bfed79a Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Tue, 22 Oct 2024 16:13:14 +0300 Subject: [PATCH 09/21] added hcnages --- spec/translation_quality/accounts_result.yaml | 191 ++++++++++++++++++ .../checks/emoji_consistency.yaml | 27 +++ .../checks/insertable_consistency.yaml | 18 ++ .../checks/non_translatable_text.yaml | 18 ++ .../checks/number_consistency.yaml | 18 ++ .../checks/segment_completeness.yaml | 18 ++ .../checks/tag_consistency.yaml | 19 ++ .../checks/target_source_consistency.yaml | 18 ++ .../translation_quality/tqc_check_result.yaml | 9 + 9 files changed, 336 insertions(+) diff --git a/spec/translation_quality/accounts_result.yaml b/spec/translation_quality/accounts_result.yaml index bc512b21..2e40a70a 100644 --- a/spec/translation_quality/accounts_result.yaml +++ b/spec/translation_quality/accounts_result.yaml @@ -161,6 +161,15 @@ x-paths: - EMOJI_PRESENT description: check subtype code example: EMOJI_ADDED + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: GLOBAL_CAPITALISATION_CONSISTENCY allOf: - *ref_1 @@ -252,6 +261,15 @@ x-paths: - INSERTABLE_DELETED description: check subtype code example: INSERTABLE_ADDED + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: LEADING_TRAILING_SPACES allOf: - *ref_1 @@ -292,6 +310,15 @@ x-paths: - PLACEABLE_FORMAT description: check subtype code example: PLACEABLE_ADDED + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: NUMBER_CONSISTENCY allOf: - *ref_1 @@ -324,6 +351,15 @@ x-paths: - NUMBER_INCORRECT_CONVERSION description: check subtype code example: NUMBER_ADDED + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: ORIGINAL_EQUALS_TARGET allOf: - *ref_1 @@ -401,6 +437,15 @@ x-paths: - TARGET_IS_MUCH_LONGER_THAN_SOURCE description: check subtype code example: TARGET_IS_EMPTY + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: SOURCE_IN_WRONG_LANGUAGE allOf: - *ref_1 @@ -469,6 +514,7 @@ x-paths: description: check type code example: TAG_CONSISTENCY subTypes: + nullable: true type: array items: type: object @@ -482,6 +528,15 @@ x-paths: - TAG_ORDER_IS_CHANGED description: check subtype code example: TAG_ADDED + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: TARGET_IN_WRONG_LANGUAGE allOf: - *ref_1 @@ -549,6 +604,15 @@ x-paths: - SAME_TRANSLATION_DIFFERENT_SOURCES description: check subtype code example: SAME_SOURCE_DIFFERENT_TRANSLATIONS + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: TRADEMARK_CONSISTENCY allOf: - *ref_1 @@ -1287,6 +1351,7 @@ x-paths: description: check type code example: TAG_CONSISTENCY subTypes: + nullable: true type: array items: type: object @@ -1300,6 +1365,15 @@ x-paths: - TAG_ORDER_IS_CHANGED description: check subtype code example: TAG_ADDED + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: TARGET_LENGTH_LIMIT allOf: - *ref_1 @@ -1343,6 +1417,15 @@ x-paths: - NUMBER_INCORRECT_CONVERSION description: check subtype code example: NUMBER_ADDED + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: REPEATED_WORD allOf: - *ref_1 @@ -1432,6 +1515,15 @@ x-paths: - TARGET_IS_MUCH_LONGER_THAN_SOURCE description: check subtype code example: TARGET_IS_EMPTY + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: NON_TRANSLATABLE_TEXT allOf: - *ref_1 @@ -1458,6 +1550,15 @@ x-paths: - PLACEABLE_FORMAT description: check subtype code example: PLACEABLE_ADDED + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: EMOJI_CONSISTENCY allOf: - *ref_1 @@ -1489,6 +1590,15 @@ x-paths: - EMOJI_PRESENT description: check subtype code example: EMOJI_ADDED + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: INSERTABLE_CONSISTENCY allOf: - *ref_1 @@ -1513,6 +1623,15 @@ x-paths: - INSERTABLE_DELETED description: check subtype code example: INSERTABLE_ADDED + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: TARGET_SOURCE_CONSISTENCY allOf: - *ref_1 @@ -1547,6 +1666,15 @@ x-paths: - SAME_TRANSLATION_DIFFERENT_SOURCES description: check subtype code example: SAME_SOURCE_DIFFERENT_TRANSLATIONS + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: BLACKLISTED_TERMS allOf: - *ref_1 @@ -2401,6 +2529,15 @@ x-paths: - EMOJI_PRESENT description: check subtype code example: EMOJI_ADDED + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: GLOBAL_CAPITALISATION_CONSISTENCY allOf: - *ref_5 @@ -2468,6 +2605,15 @@ x-paths: - INSERTABLE_DELETED description: check subtype code example: INSERTABLE_ADDED + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: LEADING_TRAILING_SPACES allOf: - *ref_5 @@ -2506,6 +2652,15 @@ x-paths: - PLACEABLE_FORMAT description: check subtype code example: PLACEABLE_ADDED + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: NUMBER_CONSISTENCY allOf: - *ref_6 @@ -2531,6 +2686,15 @@ x-paths: - NUMBER_INCORRECT_CONVERSION description: check subtype code example: NUMBER_ADDED + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: ORIGINAL_EQUALS_TARGET allOf: - *ref_5 @@ -2581,6 +2745,15 @@ x-paths: - TARGET_IS_MUCH_LONGER_THAN_SOURCE description: check subtype code example: TARGET_IS_EMPTY + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: SOURCE_IN_WRONG_LANGUAGE allOf: - *ref_5 @@ -2630,6 +2803,15 @@ x-paths: - TAG_ORDER_IS_CHANGED description: check subtype code example: TAG_ADDED + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: TARGET_IN_WRONG_LANGUAGE allOf: - *ref_5 @@ -2677,6 +2859,15 @@ x-paths: - SAME_TRANSLATION_DIFFERENT_SOURCES description: check subtype code example: SAME_SOURCE_DIFFERENT_TRANSLATIONS + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW - title: TRADEMARK_CONSISTENCY allOf: - *ref_5 diff --git a/spec/translation_quality/checks/emoji_consistency.yaml b/spec/translation_quality/checks/emoji_consistency.yaml index 3e2d2939..ca3ebb9c 100644 --- a/spec/translation_quality/checks/emoji_consistency.yaml +++ b/spec/translation_quality/checks/emoji_consistency.yaml @@ -49,6 +49,15 @@ components: - EMOJI_PRESENT description: check subtype code example: "EMOJI_ADDED" + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: "LOW" ProfilesAccountCheckTypeEffectiveDTO: title: EMOJI_CONSISTENCY @@ -77,6 +86,15 @@ components: - EMOJI_PRESENT description: check subtype code example: "EMOJI_ADDED" + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: "LOW" ProfilesAccountCheckTypeEffectiveResponse: allOf: @@ -117,6 +135,15 @@ components: - EMOJI_PRESENT description: emoji defect type example: "EMOJI_DELETED" + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: "LOW" positionTypeCode: type: string enum: diff --git a/spec/translation_quality/checks/insertable_consistency.yaml b/spec/translation_quality/checks/insertable_consistency.yaml index 1b02440f..0fb37962 100644 --- a/spec/translation_quality/checks/insertable_consistency.yaml +++ b/spec/translation_quality/checks/insertable_consistency.yaml @@ -25,6 +25,15 @@ components: - INSERTABLE_DELETED description: check subtype code example: "INSERTABLE_ADDED" + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: "LOW" ProfilesAccountCheckTypeEffectiveDTO: title: INSERTABLE_CONSISTENCY @@ -51,6 +60,15 @@ components: - INSERTABLE_DELETED description: check subtype code example: "INSERTABLE_ADDED" + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: "LOW" ProfilesAccountCheckTypeEffectiveResponse: allOf: diff --git a/spec/translation_quality/checks/non_translatable_text.yaml b/spec/translation_quality/checks/non_translatable_text.yaml index 4931f746..ebc44e8a 100644 --- a/spec/translation_quality/checks/non_translatable_text.yaml +++ b/spec/translation_quality/checks/non_translatable_text.yaml @@ -27,6 +27,15 @@ components: - PLACEABLE_FORMAT description: check subtype code example: "PLACEABLE_ADDED" + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: "LOW" ProfilesAccountCheckTypeEffectiveDTO: title: NON_TRANSLATABLE_TEXT @@ -55,6 +64,15 @@ components: - PLACEABLE_FORMAT description: check subtype code example: "PLACEABLE_ADDED" + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: "LOW" ProfilesAccountCheckTypeEffectiveResponse: allOf: diff --git a/spec/translation_quality/checks/number_consistency.yaml b/spec/translation_quality/checks/number_consistency.yaml index 2cc9fbea..a8b74f71 100644 --- a/spec/translation_quality/checks/number_consistency.yaml +++ b/spec/translation_quality/checks/number_consistency.yaml @@ -45,6 +45,15 @@ components: - NUMBER_INCORRECT_CONVERSION description: check subtype code example: "NUMBER_ADDED" + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: "LOW" ProfilesAccountCheckTypeEffectiveDTO: title: NUMBER_CONSISTENCY @@ -73,6 +82,15 @@ components: - NUMBER_INCORRECT_CONVERSION description: check subtype code example: "NUMBER_ADDED" + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: "LOW" ProfilesAccountCheckTypeEffectiveResponse: allOf: diff --git a/spec/translation_quality/checks/segment_completeness.yaml b/spec/translation_quality/checks/segment_completeness.yaml index e08b219e..156a8e52 100644 --- a/spec/translation_quality/checks/segment_completeness.yaml +++ b/spec/translation_quality/checks/segment_completeness.yaml @@ -54,6 +54,15 @@ components: - TARGET_IS_MUCH_LONGER_THAN_SOURCE description: check subtype code example: "TARGET_IS_EMPTY" + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: "LOW" ProfilesAccountCheckTypeEffectiveDTO: title: SEGMENT_COMPLETENESS @@ -82,6 +91,15 @@ components: - TARGET_IS_MUCH_LONGER_THAN_SOURCE description: check subtype code example: "TARGET_IS_EMPTY" + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: "LOW" ProfilesAccountCheckTypeEffectiveResponse: allOf: diff --git a/spec/translation_quality/checks/tag_consistency.yaml b/spec/translation_quality/checks/tag_consistency.yaml index 6185a295..69edf87b 100644 --- a/spec/translation_quality/checks/tag_consistency.yaml +++ b/spec/translation_quality/checks/tag_consistency.yaml @@ -26,6 +26,15 @@ components: - TAG_ORDER_IS_CHANGED description: check subtype code example: "TAG_ADDED" + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: "LOW" ProfilesAccountCheckTypeEffectiveDTO: title: TAG_CONSISTENCY @@ -41,6 +50,7 @@ components: description: check type code example: "TAG_CONSISTENCY" subTypes: + nullable: true type: array items: type: object @@ -54,6 +64,15 @@ components: - TAG_ORDER_IS_CHANGED description: check subtype code example: "TAG_ADDED" + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: "LOW" ProfilesAccountCheckTypeEffectiveResponse: allOf: diff --git a/spec/translation_quality/checks/target_source_consistency.yaml b/spec/translation_quality/checks/target_source_consistency.yaml index 69d8f62d..5813e8f9 100644 --- a/spec/translation_quality/checks/target_source_consistency.yaml +++ b/spec/translation_quality/checks/target_source_consistency.yaml @@ -52,6 +52,15 @@ components: - SAME_TRANSLATION_DIFFERENT_SOURCES description: check subtype code example: "SAME_SOURCE_DIFFERENT_TRANSLATIONS" + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: "LOW" ProfilesAccountCheckTypeEffectiveDTO: title: TARGET_SOURCE_CONSISTENCY @@ -79,6 +88,15 @@ components: - SAME_TRANSLATION_DIFFERENT_SOURCES description: check subtype code example: "SAME_SOURCE_DIFFERENT_TRANSLATIONS" + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: "LOW" ProfilesAccountCheckTypeEffectiveResponse: allOf: diff --git a/spec/translation_quality/tqc_check_result.yaml b/spec/translation_quality/tqc_check_result.yaml index b6259ff5..e1e33dc8 100644 --- a/spec/translation_quality/tqc_check_result.yaml +++ b/spec/translation_quality/tqc_check_result.yaml @@ -319,6 +319,15 @@ x-paths: - EMOJI_PRESENT description: emoji defect type example: EMOJI_DELETED + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW positionTypeCode: type: string enum: From 05e148d17c83fd46cdc40fb1608b8808e1f404fc Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Wed, 23 Oct 2024 10:26:56 +0300 Subject: [PATCH 10/21] added changes --- .../translation_quality/tqc_check_result.yaml | 2131 ++++++++--------- 1 file changed, 1064 insertions(+), 1067 deletions(-) diff --git a/spec/translation_quality/tqc_check_result.yaml b/spec/translation_quality/tqc_check_result.yaml index e1e33dc8..62f9d2fd 100644 --- a/spec/translation_quality/tqc_check_result.yaml +++ b/spec/translation_quality/tqc_check_result.yaml @@ -30,119 +30,116 @@ x-paths: application/json: schema: allOf: - - allOf: - - type: object - properties: - targetLocaleId: - type: string - description: >- - Smartling ID for the language you want to translate - to. - example: it-IT - required: - - targetLocaleId - - type: object - properties: - sourceLocaleId: - type: string - description: >- - The locale identifier for the source locale of the - project. This indicates the base locale for which - content should be uploaded to the project. - example: en-US - - type: object - properties: - skipSuggestions: - type: boolean - description: skip suggestions - example: false - strings: - type: array - items: - allOf: - - type: object - properties: - hashcode: - type: string - description: string hashcode - example: 7191152182c69d9b72069ac1290fe24b - - type: object - properties: - stringUid: - nullable: true - type: string - description: >- - it is string part unique identifier if - string is splitted on several parts - example: '' - - type: object - properties: - originalString: - type: string - description: original string - example: blacklist_term - - type: object - properties: - translation: - type: string - description: translation of the original string - example: blacklist_term - - type: object - properties: - pluralFormGroupUid: - type: string - nullable: true - description: unique identifier of plural form - example: 7191152182c69d9b72069ac1290fe24b - - type: object - properties: - pluralForm: - nullable: true - type: string - description: plural form - example: ONE - useDefaultSettings: - type: boolean - description: use default settings - example: false - checkTypeCodes: - minItems: 1 - maxItems: 100 - type: array - items: - - type: string - allOf: - - type: object - properties: - checkTypeCode: - enum: - - LEADING_TRAILING_SPACES - - ORIGINAL_EQUALS_TARGET - - WHITESPACES - - SPELLCHECK - - TAG_CONSISTENCY - - TARGET_LENGTH_LIMIT - - NUMBER_CONSISTENCY - - REPEATED_WORD - - TARGET_IN_WRONG_LANGUAGE - - SOURCE_IN_WRONG_LANGUAGE - - SEGMENT_COMPLETENESS - - NON_TRANSLATABLE_TEXT - - EMOJI_CONSISTENCY - - INSERTABLE_CONSISTENCY - - TARGET_SOURCE_CONSISTENCY - - BLACKLISTED_TERMS - - GLOSSARY_COMPLIANCE - - TRADEMARK_CONSISTENCY - - GRAMMAR_CHECK - - GLOBAL_CAPITALISATION_CONSISTENCY - - PUNCTUATION_CONSISTENCY - - PLURALS_REPETITION - - REGEX_CHECK - - OPEN_ISSUES - description: >- - [check type - codes](#operation/getTranslationQualityCheckTypes) + - type: object + properties: + targetLocaleId: + type: string + description: Smartling ID for the language you want to translate to. + example: it-IT + required: + - targetLocaleId + - type: object + properties: + sourceLocaleId: + type: string + description: >- + The locale identifier for the source locale of the + project. This indicates the base locale for which + content should be uploaded to the project. + example: en-US + - type: object + properties: + skipSuggestions: + type: boolean + description: skip suggestions + example: false + strings: + type: array + items: + allOf: + - type: object + properties: + hashcode: + type: string + description: string hashcode + example: 7191152182c69d9b72069ac1290fe24b + - type: object + properties: + stringUid: + nullable: true + type: string + description: >- + it is string part unique identifier if string + is splitted on several parts + example: '' + - type: object + properties: + originalString: + type: string + description: original string + example: blacklist_term + - type: object + properties: + translation: + type: string + description: translation of the original string + example: blacklist_term + - type: object + properties: + pluralFormGroupUid: + type: string + nullable: true + description: unique identifier of plural form + example: 7191152182c69d9b72069ac1290fe24b + - type: object + properties: + pluralForm: + nullable: true + type: string + description: plural form + example: ONE + useDefaultSettings: + type: boolean + description: use default settings + example: false + checkTypeCodes: + minItems: 1 + maxItems: 100 + type: array + items: + type: string + description: >- + [check type + code](#operation/getTranslationQualityCheckTypes) + example: LEADING_TRAILING_SPACES + enum: + - LEADING_TRAILING_SPACES + - ORIGINAL_EQUALS_TARGET + - WHITESPACES + - SPELLCHECK + - TAG_CONSISTENCY + - TARGET_LENGTH_LIMIT + - NUMBER_CONSISTENCY + - REPEATED_WORD + - TARGET_IN_WRONG_LANGUAGE + - SOURCE_IN_WRONG_LANGUAGE + - SEGMENT_COMPLETENESS + - NON_TRANSLATABLE_TEXT + - EMOJI_CONSISTENCY + - INSERTABLE_CONSISTENCY + - TARGET_SOURCE_CONSISTENCY + - BLACKLISTED_TERMS + - GLOSSARY_COMPLIANCE + - TRADEMARK_CONSISTENCY + - GRAMMAR_CHECK + - GLOBAL_CAPITALISATION_CONSISTENCY + - PUNCTUATION_CONSISTENCY + - PLURALS_REPETITION + - REGEX_CHECK + - OPEN_ISSUES + description: >- + [check type + codes](#operation/getTranslationQualityCheckTypes) example: targetLocaleId: en-US sourceLocaleId: fr-FR @@ -230,973 +227,973 @@ x-paths: mistakes: type: array items: - - oneOf: - - title: BLACKLISTED_TERMS - allOf: - - &ref_0 - type: object - properties: - severityLevelCode: &ref_2 - enum: - - DISABLED - - LOW - - MEDIUM - - HIGH - - &ref_1 - type: object - properties: - positions: - type: array - items: - type: object - properties: - from: - type: integer - description: start position in the string - to: - type: integer - description: end position in the string - - type: object - properties: - checkTypeCode: - type: string - enum: - - BLACKLISTED_TERMS - description: check type code - example: BLACKLISTED_TERMS - details: + oneOf: + - title: BLACKLISTED_TERMS + allOf: + - &ref_0 + type: object + properties: + severityLevelCode: &ref_2 + enum: + - DISABLED + - LOW + - MEDIUM + - HIGH + - &ref_1 + type: object + properties: + positions: + type: array + items: type: object - nullable: true properties: - blacklistedTermUid: - type: string - description: black listed term unique identifier - example: uidgj1 - termText: + from: + type: integer + description: start position in the string + to: + type: integer + description: end position in the string + - type: object + properties: + checkTypeCode: + type: string + enum: + - BLACKLISTED_TERMS + description: check type code + example: BLACKLISTED_TERMS + details: + type: object + nullable: true + properties: + blacklistedTermUid: + type: string + description: black listed term unique identifier + example: uidgj1 + termText: + type: string + description: term text + example: blacklist_term + alternatives: + type: array + items: type: string - description: term text - example: blacklist_term - alternatives: - type: array - items: + example: alternative 1 + notes: + type: string + description: notes + example: '' + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: EMOJI_CONSISTENCY + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - EMOJI_CONSISTENCY + description: check type code + example: EMOJI_CONSISTENCY + details: + nullable: true + type: object + properties: + emoji: + type: string + description: emoji symbol + example: 😀 + type: + type: string + enum: + - EMOJI_ADDED + - EMOJI_DELETED + - EMOJI_PRESENT + description: emoji defect type + example: EMOJI_DELETED + severityLevelCode: + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: LOW + positionTypeCode: + type: string + enum: + - SOURCE + - TARGET + description: position type code + example: SOURCE + - title: GLOBAL_CAPITALISATION_CONSISTENCY + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - GLOBAL_CAPITALISATION_CONSISTENCY + description: check type code + example: GLOBAL_CAPITALISATION_CONSISTENCY + details: + nullable: true + type: object + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: GLOSSARY_COMPLIANCE + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - GLOSSARY_COMPLIANCE + description: check type code + example: GLOSSARY_COMPLIANCE + details: + type: object + nullable: true + properties: + glossaryTerm: + type: object + properties: + termUid: type: string - example: alternative 1 - notes: - type: string - description: notes - example: '' - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: EMOJI_CONSISTENCY - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - EMOJI_CONSISTENCY - description: check type code - example: EMOJI_CONSISTENCY - details: - nullable: true - type: object - properties: - emoji: - type: string - description: emoji symbol - example: 😀 - type: - type: string - enum: - - EMOJI_ADDED - - EMOJI_DELETED - - EMOJI_PRESENT - description: emoji defect type - example: EMOJI_DELETED - severityLevelCode: - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW - positionTypeCode: - type: string - enum: - - SOURCE - - TARGET - description: position type code - example: SOURCE - - title: GLOBAL_CAPITALISATION_CONSISTENCY - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - GLOBAL_CAPITALISATION_CONSISTENCY - description: check type code - example: GLOBAL_CAPITALISATION_CONSISTENCY - details: - nullable: true - type: object - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: GLOSSARY_COMPLIANCE - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - GLOSSARY_COMPLIANCE - description: check type code - example: GLOSSARY_COMPLIANCE - details: - type: object - nullable: true - properties: - glossaryTerm: - type: object - properties: - termUid: - type: string - description: term uid - example: cdd443b9-814f-442c-9ba6-4d97e0afce74 - translation: - type: object - properties: - localeId: - type: string - description: locale identifier - example: ru-RU - translatedTerm: - type: string - description: translated term - example: изменить размер - notes: - type: string - description: notes - example: '' - translatorUserUid: - type: string - description: translator user identifier - example: 23ddd32e - lockTranslation: - type: boolean - description: lock translation - example: false - submittedForTranslation: - type: boolean - description: submitted for translation - example: false - createdDate: - type: string - description: created date - example: '2018-11-16T16:06:53Z' - modifiedDate: - type: string - description: modified date - example: '2018-11-17T16:06:53Z' - termText: - type: string - description: term text - example: resize - caseSensitive: - type: boolean - description: case sensitive - example: false - exactMatch: - type: boolean - description: exact match - example: false - definition: - type: string - description: definition - example: '' - variations: - type: string - description: variations - example: '' - synonyms: - type: string - description: synonyms - example: '' - antonyms: - type: string - description: antonyms - example: '' - seo: - type: boolean - description: seo - example: false - doNotTranslate: - type: boolean - description: do not translate - example: false - notes: - type: string - description: notes - example: '' - partOfSpeechCode: - type: string - description: part of speech code - example: UNSPECIFIED - createdByUserUid: - type: string - description: created by user identifier - example: xas344dsd3 - createdDate: - type: string - description: created date - example: '2018-11-16T16:06:53Z' - modifiedDate: - type: string - description: modified date - example: '2018-11-17T16:06:53Z' - positionTypeCode: - type: string - enum: - - TARGET - - SOURCE - description: position type code - example: SOURCE - - title: GRAMMAR_CHECK - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - GRAMMAR_CHECK - description: check type code - example: GRAMMAR_CHECK - details: - nullable: true - type: object - properties: - text: - type: string - description: text - example: play - message: - type: string - description: message - example: >- - Possible agreement error -- use past - participle here: - played. - description: - type: string - description: description - example: Had + verb present tense - mistakeTypeCode: - type: string - description: mistake type code - example: Grammar - suggestions: - type: array - items: + description: term uid + example: cdd443b9-814f-442c-9ba6-4d97e0afce74 + translation: + type: object + properties: + localeId: + type: string + description: locale identifier + example: ru-RU + translatedTerm: + type: string + description: translated term + example: изменить размер + notes: + type: string + description: notes + example: '' + translatorUserUid: + type: string + description: translator user identifier + example: 23ddd32e + lockTranslation: + type: boolean + description: lock translation + example: false + submittedForTranslation: + type: boolean + description: submitted for translation + example: false + createdDate: + type: string + description: created date + example: '2018-11-16T16:06:53Z' + modifiedDate: + type: string + description: modified date + example: '2018-11-17T16:06:53Z' + termText: type: string - example: played - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: INSERTABLE_CONSISTENCY - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - INSERTABLE_CONSISTENCY - description: check type code - example: INSERTABLE_CONSISTENCY - details: - type: object - nullable: true - properties: - insertable: - type: string - description: insertable - example:
- insertableType: - type: string - description: insertable type - example: BR_TAG - type: - type: string - enum: - - INSERTABLE_ADDED - - INSERTABLE_DELETED - description: insertable - example: INSERTABLE_DELETED - positionTypeCode: - type: string - enum: - - TARGET - - SOURCE - description: position type code - example: SOURCE - - title: LEADING_TRAILING_SPACES - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - description: check type code - example: LEADING_TRAILING_SPACES - details: - type: object - nullable: true - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: NON_TRANSLATABLE_TEXT - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - NON_TRANSLATABLE_TEXT - description: check type code - example: NON_TRANSLATABLE_TEXT - details: - type: object - nullable: true - properties: - placeable: - type: string - description: placeable - example: '{0}' - type: + description: term text + example: resize + caseSensitive: + type: boolean + description: case sensitive + example: false + exactMatch: + type: boolean + description: exact match + example: false + definition: + type: string + description: definition + example: '' + variations: + type: string + description: variations + example: '' + synonyms: + type: string + description: synonyms + example: '' + antonyms: + type: string + description: antonyms + example: '' + seo: + type: boolean + description: seo + example: false + doNotTranslate: + type: boolean + description: do not translate + example: false + notes: + type: string + description: notes + example: '' + partOfSpeechCode: + type: string + description: part of speech code + example: UNSPECIFIED + createdByUserUid: + type: string + description: created by user identifier + example: xas344dsd3 + createdDate: + type: string + description: created date + example: '2018-11-16T16:06:53Z' + modifiedDate: + type: string + description: modified date + example: '2018-11-17T16:06:53Z' + positionTypeCode: + type: string + enum: + - TARGET + - SOURCE + description: position type code + example: SOURCE + - title: GRAMMAR_CHECK + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - GRAMMAR_CHECK + description: check type code + example: GRAMMAR_CHECK + details: + nullable: true + type: object + properties: + text: + type: string + description: text + example: play + message: + type: string + description: message + example: >- + Possible agreement error -- use past + participle here: + played. + description: + type: string + description: description + example: Had + verb present tense + mistakeTypeCode: + type: string + description: mistake type code + example: Grammar + suggestions: + type: array + items: type: string - enum: - - PLACEABLE_ADDED - - PLACEABLE_DELETED - - SPACES_AROUND_PLACEABLE - - PLACEABLE_FORMAT - description: type - example: PLACEABLE_DELETED - positionTypeCode: - type: string - enum: - - TARGET - - SOURCE - description: position type code - example: SOURCE - - title: NUMBER_CONSISTENCY - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - NUMBER_CONSISTENCY - description: check type code - example: NUMBER_CONSISTENCY - details: - type: object - nullable: true - oneOf: - - type: object - title: NUMBER_ADDED - properties: - type: - type: string - enum: - - NUMBER_ADDED - example: NUMBER_ADDED - number: - type: string - description: number - example: '1000' - - type: object - title: NUMBER_DELETED - properties: - type: - type: string - enum: - - NUMBER_DELETED - example: NUMBER_DELETED - number: - type: string - description: number - example: '1000' - - type: object - title: NUMBER_INCORRECT_CONVERSION - properties: - type: - type: string - enum: - - NUMBER_INCORRECT_CONVERSION - example: NUMBER_INCORRECT_CONVERSION - number: - type: string - description: number - example: 1000,1 - expectedFormat: - type: string - description: number expected format - example: 1,000.10 - positionTypeCode: - type: string - enum: - - TARGET - - SOURCE - description: position type code - example: SOURCE - - title: ORIGINAL_EQUALS_TARGET - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - ORIGINAL_EQUALS_TARGET - description: check type code - example: ORIGINAL_EQUALS_TARGET - details: - nullable: true - type: object - properties: - types: - type: array - items: + example: played + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: INSERTABLE_CONSISTENCY + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - INSERTABLE_CONSISTENCY + description: check type code + example: INSERTABLE_CONSISTENCY + details: + type: object + nullable: true + properties: + insertable: + type: string + description: insertable + example:
+ insertableType: + type: string + description: insertable type + example: BR_TAG + type: + type: string + enum: + - INSERTABLE_ADDED + - INSERTABLE_DELETED + description: insertable + example: INSERTABLE_DELETED + positionTypeCode: + type: string + enum: + - TARGET + - SOURCE + description: position type code + example: SOURCE + - title: LEADING_TRAILING_SPACES + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + description: check type code + example: LEADING_TRAILING_SPACES + details: + type: object + nullable: true + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: NON_TRANSLATABLE_TEXT + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - NON_TRANSLATABLE_TEXT + description: check type code + example: NON_TRANSLATABLE_TEXT + details: + type: object + nullable: true + properties: + placeable: + type: string + description: placeable + example: '{0}' + type: + type: string + enum: + - PLACEABLE_ADDED + - PLACEABLE_DELETED + - SPACES_AROUND_PLACEABLE + - PLACEABLE_FORMAT + description: type + example: PLACEABLE_DELETED + positionTypeCode: + type: string + enum: + - TARGET + - SOURCE + description: position type code + example: SOURCE + - title: NUMBER_CONSISTENCY + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - NUMBER_CONSISTENCY + description: check type code + example: NUMBER_CONSISTENCY + details: + type: object + nullable: true + oneOf: + - type: object + title: NUMBER_ADDED + properties: + type: type: string enum: - - IDENTICAL_CAPITALIZATION - - IDENTICAL_TAGS - example: >- - ["IDENTICAL_CAPITALIZATION", - "IDENTICAL_TAGS"] - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: REPEATED_WORD - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - REPEATED_WORD - description: check type code - example: REPEATED_WORD - details: - nullable: true - type: object - properties: - word: - type: string - description: word - example: szia - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: SEGMENT_COMPLETENESS - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - SEGMENT_COMPLETENESS - description: check type code - example: SEGMENT_COMPLETENESS - details: - type: object - nullable: true - properties: - type: - type: string - enum: - - TARGET_IS_EMPTY - - TARGET_IS_MUCH_SHORTER_THAN_SOURCE - - TARGET_IS_MUCH_LONGER_THAN_SOURCE - description: word - example: TARGET_IS_MUCH_SHORTER_THAN_SOURCE - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: SOURCE_IN_WRONG_LANGUAGE - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - SOURCE_IN_WRONG_LANGUAGE - description: check type code - example: SOURCE_IN_WRONG_LANGUAGE - details: - nullable: true - type: object - positionTypeCode: - type: string - enum: - - SOURCE - description: position type code - example: SOURCE - - title: SPELLCHECK - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - SPELLCHECK - description: check type code - example: SPELLCHECK - details: - type: object - nullable: true - properties: - word: - type: string - description: word - example: Sziaa - suggestions: - type: array - items: + - NUMBER_ADDED + example: NUMBER_ADDED + number: type: string - description: suggestions - example: >- - ["Szia", "Szita", "Szila", "Szia a", - "Szilvia"] - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: TAG_CONSISTENCY - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - TAG_CONSISTENCY - description: check type code - example: TAG_CONSISTENCY - details: - type: object - nullable: true - properties: - tag: - type: string - description: tag - example:

- type: - type: string - enum: - - TAG_ADDED - - TAG_DELETED - - SPACES_AROUND_TAGS - - TAG_ORDER_IS_CHANGED - example: TAG_DELETED - positionTypeCode: - type: string - enum: - - TARGET - - SOURCE - description: position type code - example: SOURCE - - title: TARGET_IN_WRONG_LANGUAGE - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - TARGET_IN_WRONG_LANGUAGE - description: check type code - example: TARGET_IN_WRONG_LANGUAGE - details: - type: object - nullable: true - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: TARGET_LENGTH_LIMIT - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - TARGET_LENGTH_LIMIT - description: check type code - example: TARGET_LENGTH_LIMIT - details: - type: object - nullable: true - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: TARGET_SOURCE_CONSISTENCY - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - TARGET_SOURCE_CONSISTENCY - description: check type code - example: TARGET_SOURCE_CONSISTENCY - details: - type: object - nullable: true - properties: - type: + description: number + example: '1000' + - type: object + title: NUMBER_DELETED + properties: + type: + type: string + enum: + - NUMBER_DELETED + example: NUMBER_DELETED + number: + type: string + description: number + example: '1000' + - type: object + title: NUMBER_INCORRECT_CONVERSION + properties: + type: + type: string + enum: + - NUMBER_INCORRECT_CONVERSION + example: NUMBER_INCORRECT_CONVERSION + number: + type: string + description: number + example: 1000,1 + expectedFormat: + type: string + description: number expected format + example: 1,000.10 + positionTypeCode: + type: string + enum: + - TARGET + - SOURCE + description: position type code + example: SOURCE + - title: ORIGINAL_EQUALS_TARGET + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - ORIGINAL_EQUALS_TARGET + description: check type code + example: ORIGINAL_EQUALS_TARGET + details: + nullable: true + type: object + properties: + types: + type: array + items: type: string enum: - - SAME_SOURCE_DIFFERENT_TRANSLATIONS - - SAME_TRANSLATION_DIFFERENT_SOURCES - description: type - example: SAME_SOURCE_DIFFERENT_TRANSLATIONS - originalString: - type: string - description: original string - example: I like to go to the mountains very much. - translation: - type: string - description: translation - example: Ich möchte an den Strand gehen. - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: TRADEMARK_CONSISTENCY - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - TRADEMARK_CONSISTENCY - description: check type code - example: TRADEMARK_CONSISTENCY - details: - type: object - nullable: true - properties: - trademarkTypeCode: + - IDENTICAL_CAPITALIZATION + - IDENTICAL_TAGS + example: >- + ["IDENTICAL_CAPITALIZATION", + "IDENTICAL_TAGS"] + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: REPEATED_WORD + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - REPEATED_WORD + description: check type code + example: REPEATED_WORD + details: + nullable: true + type: object + properties: + word: + type: string + description: word + example: szia + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: SEGMENT_COMPLETENESS + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - SEGMENT_COMPLETENESS + description: check type code + example: SEGMENT_COMPLETENESS + details: + type: object + nullable: true + properties: + type: + type: string + enum: + - TARGET_IS_EMPTY + - TARGET_IS_MUCH_SHORTER_THAN_SOURCE + - TARGET_IS_MUCH_LONGER_THAN_SOURCE + description: word + example: TARGET_IS_MUCH_SHORTER_THAN_SOURCE + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: SOURCE_IN_WRONG_LANGUAGE + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - SOURCE_IN_WRONG_LANGUAGE + description: check type code + example: SOURCE_IN_WRONG_LANGUAGE + details: + nullable: true + type: object + positionTypeCode: + type: string + enum: + - SOURCE + description: position type code + example: SOURCE + - title: SPELLCHECK + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - SPELLCHECK + description: check type code + example: SPELLCHECK + details: + type: object + nullable: true + properties: + word: + type: string + description: word + example: Sziaa + suggestions: + type: array + items: type: string - enum: - - SERVICE_MARK - - COPYRIGHT - - REGISTERED - - TRADEMARK - description: trademark type code - example: COPYRIGHT - positionTypeCode: - type: string - enum: - - SOURCE - description: position type code - example: SOURCE - - title: WHITESPACES - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - WHITESPACES - description: check type code - example: WHITESPACES - details: - type: object - nullable: true - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: PUNCTUATION_CONSISTENCY - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - PUNCTUATION_CONSISTENCY - description: check type code - example: PUNCTUATION_CONSISTENCY - details: - nullable: true - type: object - positionTypeCode: - type: string - enum: - - SOURCE - description: position type code - example: SOURCE - - title: PLURALS_REPETITION - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - PLURALS_REPETITION - description: check type code - example: PLURALS_REPETITION - details: - nullable: true - type: object - properties: - pluralFormGroupUid: + description: suggestions + example: >- + ["Szia", "Szita", "Szila", "Szia a", + "Szilvia"] + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: TAG_CONSISTENCY + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - TAG_CONSISTENCY + description: check type code + example: TAG_CONSISTENCY + details: + type: object + nullable: true + properties: + tag: + type: string + description: tag + example:

+ type: + type: string + enum: + - TAG_ADDED + - TAG_DELETED + - SPACES_AROUND_TAGS + - TAG_ORDER_IS_CHANGED + example: TAG_DELETED + positionTypeCode: + type: string + enum: + - TARGET + - SOURCE + description: position type code + example: SOURCE + - title: TARGET_IN_WRONG_LANGUAGE + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - TARGET_IN_WRONG_LANGUAGE + description: check type code + example: TARGET_IN_WRONG_LANGUAGE + details: + type: object + nullable: true + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: TARGET_LENGTH_LIMIT + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - TARGET_LENGTH_LIMIT + description: check type code + example: TARGET_LENGTH_LIMIT + details: + type: object + nullable: true + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: TARGET_SOURCE_CONSISTENCY + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - TARGET_SOURCE_CONSISTENCY + description: check type code + example: TARGET_SOURCE_CONSISTENCY + details: + type: object + nullable: true + properties: + type: + type: string + enum: + - SAME_SOURCE_DIFFERENT_TRANSLATIONS + - SAME_TRANSLATION_DIFFERENT_SOURCES + description: type + example: SAME_SOURCE_DIFFERENT_TRANSLATIONS + originalString: + type: string + description: original string + example: I like to go to the mountains very much. + translation: + type: string + description: translation + example: Ich möchte an den Strand gehen. + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: TRADEMARK_CONSISTENCY + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - TRADEMARK_CONSISTENCY + description: check type code + example: TRADEMARK_CONSISTENCY + details: + type: object + nullable: true + properties: + trademarkTypeCode: + type: string + enum: + - SERVICE_MARK + - COPYRIGHT + - REGISTERED + - TRADEMARK + description: trademark type code + example: COPYRIGHT + positionTypeCode: + type: string + enum: + - SOURCE + description: position type code + example: SOURCE + - title: WHITESPACES + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - WHITESPACES + description: check type code + example: WHITESPACES + details: + type: object + nullable: true + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: PUNCTUATION_CONSISTENCY + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - PUNCTUATION_CONSISTENCY + description: check type code + example: PUNCTUATION_CONSISTENCY + details: + nullable: true + type: object + positionTypeCode: + type: string + enum: + - SOURCE + description: position type code + example: SOURCE + - title: PLURALS_REPETITION + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - PLURALS_REPETITION + description: check type code + example: PLURALS_REPETITION + details: + nullable: true + type: object + properties: + pluralFormGroupUid: + type: string + description: unique identifier of plural form + example: 7191152182c69d9b72069ac1290fe24b + repeatedPluralForms: + type: array + items: type: string - description: unique identifier of plural form - example: 7191152182c69d9b72069ac1290fe24b - repeatedPluralForms: - type: array - items: - type: string - example: ONE - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: REGEX_CHECK - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - REGEX_CHECK - description: check type code - example: REGEX_CHECK - details: - type: object - nullable: true - oneOf: - - allOf: - - type: object - properties: - ruleUid: - type: string - description: >- - Unique identifier of corresponding check - rule - example: ce6d6b5dbc12 - - type: object - properties: - ruleName: - type: string - description: Rule name - example: ruleName - severityLevelCode: - enum: - - DISABLED - - LOW - - MEDIUM - - HIGH - ruleTypeCode: - enum: - - FORBIDDEN - - MISSING - - COUNT_MISMATCH - flavorCode: - enum: - - JAVA - - DOT_NET - originalPattern: - type: string - description: >- - Regular expression to evaluate against - the source string. - example: '@mail' - translationPattern: - type: string - description: >- - Regular expression to evaluate against - the translation. - example: '@gmail' - caseInsensitive: - type: boolean - description: Enable case insensitive search - example: true - multiLine: - type: boolean - description: >- - Enables multine search. If true then - search will span newlines in a string. - Users can use ^ and $ characters with - special meaning for beginning of line - and end of line match. - example: true - description: - type: string - description: >- - Human readable description of the role; - shown in the the dashboard UI. - example: rule description - warningMessage: - type: string - description: >- - Human readable warning message appended - to the standard message that is shown in - the CAT tool when the check fails. - example: ' test warning message' - required: - - ruleName - - severityLevelCode - - ruleTypeCode - - flavorCode - - originalPattern - - translationPattern - - caseInsensitive - - multiLine - - type: object - properties: - groups: - type: array - items: - allOf: - - type: object - properties: - groupUid: - type: string - description: >- - Smartling rule group identifier of the - translation - example: ce6d6b5dbc12 - ruleUid: + example: ONE + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: REGEX_CHECK + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - REGEX_CHECK + description: check type code + example: REGEX_CHECK + details: + type: object + nullable: true + oneOf: + - allOf: + - type: object + properties: + ruleUid: + type: string + description: >- + Unique identifier of corresponding check + rule + example: ce6d6b5dbc12 + - type: object + properties: + ruleName: + type: string + description: Rule name + example: ruleName + severityLevelCode: + enum: + - DISABLED + - LOW + - MEDIUM + - HIGH + ruleTypeCode: + enum: + - FORBIDDEN + - MISSING + - COUNT_MISMATCH + flavorCode: + enum: + - JAVA + - DOT_NET + originalPattern: + type: string + description: >- + Regular expression to evaluate against + the source string. + example: '@mail' + translationPattern: + type: string + description: >- + Regular expression to evaluate against + the translation. + example: '@gmail' + caseInsensitive: + type: boolean + description: Enable case insensitive search + example: true + multiLine: + type: boolean + description: >- + Enables multine search. If true then + search will span newlines in a string. + Users can use ^ and $ characters with + special meaning for beginning of line + and end of line match. + example: true + description: + type: string + description: >- + Human readable description of the role; + shown in the the dashboard UI. + example: rule description + warningMessage: + type: string + description: >- + Human readable warning message appended + to the standard message that is shown in + the CAT tool when the check fails. + example: ' test warning message' + required: + - ruleName + - severityLevelCode + - ruleTypeCode + - flavorCode + - originalPattern + - translationPattern + - caseInsensitive + - multiLine + - type: object + properties: + groups: + type: array + items: + allOf: + - type: object + properties: + groupUid: + type: string + description: >- + Smartling rule group identifier of the + translation + example: ce6d6b5dbc12 + ruleUid: + type: string + description: >- + Smartling rule identifier of the + translation + example: ce6d6b5dbcs2 + targetLocaleIds: + description: The list of target locales. + example: + - ru-RU + items: type: string - description: >- - Smartling rule identifier of the - translation - example: ce6d6b5dbcs2 - targetLocaleIds: - description: The list of target locales. - example: - - ru-RU - items: - type: string - type: array - severityLevelCode: *ref_2 - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET - - title: OPEN_ISSUES - allOf: - - *ref_0 - - *ref_1 - - type: object - properties: - checkTypeCode: - type: string - enum: - - OPEN_ISSUES - description: check type code - example: OPEN_ISSUES - details: - nullable: true - type: object - properties: - sourceIssuesCount: - type: integer - description: text - example: 2 - translationIssuesCount: - type: integer - description: message - example: 3 - positionTypeCode: - type: string - enum: - - TARGET - description: position type code - example: TARGET + type: array + severityLevelCode: *ref_2 + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET + - title: OPEN_ISSUES + allOf: + - *ref_0 + - *ref_1 + - type: object + properties: + checkTypeCode: + type: string + enum: + - OPEN_ISSUES + description: check type code + example: OPEN_ISSUES + details: + nullable: true + type: object + properties: + sourceIssuesCount: + type: integer + description: text + example: 2 + translationIssuesCount: + type: integer + description: message + example: 3 + positionTypeCode: + type: string + enum: + - TARGET + description: position type code + example: TARGET examples: BLACKLISTED_TERMS: value: @@ -1413,7 +1410,7 @@ x-paths: to: 7 details: type: NUMBER_ADDED - number: '20' + number: 20 positionTypeCode: TARGET REPEATED_WORD: value: From 0403d457f75f61da45888abc376171bc9fa81f1b Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Wed, 23 Oct 2024 10:27:31 +0300 Subject: [PATCH 11/21] added changes --- spec/process-yaml.js | 1 - .../account_settings_result.yaml | 3 + spec/translation_quality/accounts_result.yaml | 605 +++++++++++------- .../check_type_severity_level_result.yaml | 3 + .../checks/blacklisted_terms.yaml | 15 +- .../checks/emoji_consistency.yaml | 32 +- .../global_capitalisation_consistency.yaml | 15 +- .../checks/glossary_compliance.yaml | 18 +- .../checks/grammar_check.yaml | 15 +- .../checks/insertable_consistency.yaml | 21 +- .../checks/leading_trailing_spaces.yaml | 15 +- .../checks/non_translatable_text.yaml | 35 +- .../checks/number_consistency.yaml | 43 +- .../checks/open_issues.yaml | 14 +- .../checks/original_equals_target.yaml | 33 +- .../checks/plurals_repetition.yaml | 15 +- .../checks/punctuation_consistency.yaml | 15 +- .../checks/regex_check.yaml | 59 +- .../checks/repeated_word.yaml | 15 +- .../checks/segment_completeness.yaml | 51 +- .../checks/source_in_wrong_language.yaml | 10 +- .../checks/spellcheck.yaml | 26 +- .../checks/tag_consistency.yaml | 35 +- .../checks/target_in_wrong_language.yaml | 27 +- .../checks/target_length_limit.yaml | 15 +- .../checks/target_source_consistency.yaml | 39 +- .../checks/trademark_consistency.yaml | 15 +- .../checks/whitespaces.yaml | 15 +- .../dictionaries_result.yaml | 5 + spec/translation_quality/examples.yaml | 1 + spec/translation_quality/tqc_check.yaml | 9 +- spec/translation_quality/tqc_common.yaml | 18 +- 32 files changed, 757 insertions(+), 481 deletions(-) diff --git a/spec/process-yaml.js b/spec/process-yaml.js index 5b767cd9..9d43f0df 100644 --- a/spec/process-yaml.js +++ b/spec/process-yaml.js @@ -45,7 +45,6 @@ try { await makeResultForCertainFileFunction("./spec/translation_quality/check_type_severity_level.yaml", "./spec/translation_quality/check_type_severity_level_result.yaml", "./spec/translation_quality"); await makeResultForCertainFileFunction("./spec/translation_quality/account_settings.yaml", "./spec/translation_quality/account_settings_result.yaml", "./spec/translation_quality"); await makeResultForCertainFileFunction("./spec/translation_quality/tqc_check.yaml", "./spec/translation_quality/tqc_check_result.yaml", "./spec/translation_quality"); - // await makeResultForCertainFileFunction("/Users/alubenskyi/Documents/repos/api-docs/spec/translation_quality/tqc_check.yaml", "./spec/translation_quality/tqc_check_result.yaml", "./spec/translation_quality"); await makeResultForCertainFileFunction("./spec/translation_quality/regex_check_settings.yaml", "./spec/translation_quality/regex_check_settings_result.yaml", "./spec/translation_quality"); } makeResultFunction(); diff --git a/spec/translation_quality/account_settings_result.yaml b/spec/translation_quality/account_settings_result.yaml index 437239f1..9f4dc369 100644 --- a/spec/translation_quality/account_settings_result.yaml +++ b/spec/translation_quality/account_settings_result.yaml @@ -22,6 +22,9 @@ x-paths: in: path required: true schema: &ref_0 + type: string + description: '[check type code](#operation/getTranslationQualityCheckTypes)' + example: LEADING_TRAILING_SPACES enum: - LEADING_TRAILING_SPACES - ORIGINAL_EQUALS_TARGET diff --git a/spec/translation_quality/accounts_result.yaml b/spec/translation_quality/accounts_result.yaml index 2e40a70a..72e0daef 100644 --- a/spec/translation_quality/accounts_result.yaml +++ b/spec/translation_quality/accounts_result.yaml @@ -90,6 +90,10 @@ x-paths: type: string description: check subtype code example: '' + severityLevelCode: + type: string + description: check subtype code + example: '' - &ref_3 type: object properties: @@ -140,6 +144,8 @@ x-paths: type: boolean description: No emoji is allowed in target example: false + required: + - noEmojisAllowedInTarget - type: object properties: checkTypeCode: @@ -255,6 +261,7 @@ x-paths: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - INSERTABLE_ADDED @@ -262,6 +269,7 @@ x-paths: description: check subtype code example: INSERTABLE_ADDED severityLevelCode: + nullable: true type: string enum: - LOW @@ -302,6 +310,7 @@ x-paths: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - PLACEABLE_ADDED @@ -311,6 +320,7 @@ x-paths: description: check subtype code example: PLACEABLE_ADDED severityLevelCode: + nullable: true type: string enum: - LOW @@ -345,6 +355,7 @@ x-paths: properties: checkSubTypeCode: type: string + nullable: true enum: - NUMBER_ADDED - NUMBER_DELETED @@ -352,6 +363,7 @@ x-paths: description: check subtype code example: NUMBER_ADDED severityLevelCode: + nullable: true type: string enum: - LOW @@ -430,6 +442,7 @@ x-paths: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - TARGET_IS_EMPTY @@ -438,6 +451,7 @@ x-paths: description: check subtype code example: TARGET_IS_EMPTY severityLevelCode: + nullable: true type: string enum: - LOW @@ -450,7 +464,7 @@ x-paths: allOf: - *ref_1 - *ref_5 - - &ref_19 + - &ref_18 type: object properties: minTextLengthLimit: @@ -521,6 +535,7 @@ x-paths: properties: checkSubTypeCode: type: string + nullable: true enum: - TAG_ADDED - TAG_DELETED @@ -529,6 +544,7 @@ x-paths: description: check subtype code example: TAG_ADDED severityLevelCode: + nullable: true type: string enum: - LOW @@ -812,26 +828,35 @@ x-paths: data: totalCount: 25 items: - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: LEADING_TRAILING_SPACES - subTypes: [] - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: ORIGINAL_EQUALS_TARGET - subTypes: [] - localeSeverityLevels: [] - groups: [] - mustHaveIdenticalTags: true - mustHaveIdenticalCapitalization: true - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: WHITESPACES - subTypes: [] - localeSeverityLevels: [] - groups: [] + - response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: LEADING_TRAILING_SPACES + subTypes: [] + localeSeverityLevels: [] + groups: [] + - response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: ORIGINAL_EQUALS_TARGET + subTypes: [] + localeSeverityLevels: [] + groups: [] + mustHaveIdenticalTags: true + mustHaveIdenticalCapitalization: true + - response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: WHITESPACES + subTypes: [] + localeSeverityLevels: [] + groups: [] - profileUid: ce6d6b5dbc12 severityLevelCode: LOW checkTypeCode: SPELLCHECK @@ -843,26 +868,32 @@ x-paths: skipIfWordAppearsInSourceString: true skipIfWordValidInSourceLocale: false runSpellcheckForSubWords: false - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: TAG_CONSISTENCY - subTypes: - - checkSubTypeCode: TAG_ADDED - severityLevelCode: LOW - - checkSubTypeCode: TAG_DELETED - severityLevelCode: LOW - - checkSubTypeCode: TAG_ORDER_IS_CHANGED - severityLevelCode: LOW - - checkSubTypeCode: SPACES_AROUND_TAGS + - response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: HIGH - checkTypeCode: TARGET_LENGTH_LIMIT - subTypes: [] - localeSeverityLevels: [] - groups: [] + checkTypeCode: TAG_CONSISTENCY + subTypes: + - checkSubTypeCode: TAG_ADDED + severityLevelCode: LOW + - checkSubTypeCode: TAG_DELETED + severityLevelCode: LOW + - checkSubTypeCode: TAG_ORDER_IS_CHANGED + severityLevelCode: LOW + - checkSubTypeCode: SPACES_AROUND_TAGS + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] + - response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: HIGH + checkTypeCode: TARGET_LENGTH_LIMIT + subTypes: [] + localeSeverityLevels: [] + groups: [] - profileUid: ce6d6b5dbc12 severityLevelCode: LOW checkTypeCode: NUMBER_CONSISTENCY @@ -878,19 +909,25 @@ x-paths: - groupUid: b0dd258b05ee - groupUid: a853df2cf8ac ignoreSign: true - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: REPEATED_WORD - subTypes: [] - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: TARGET_IN_WRONG_LANGUAGE - subTypes: [] - localeSeverityLevels: [] - groups: [] - minTextLengthLimit: 40 + - response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: REPEATED_WORD + subTypes: [] + localeSeverityLevels: [] + groups: [] + - response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: TARGET_IN_WRONG_LANGUAGE + subTypes: [] + localeSeverityLevels: [] + groups: [] + minTextLengthLimit: 40 - profileUid: ce6d6b5dbc12 severityLevelCode: LOW checkTypeCode: SOURCE_IN_WRONG_LANGUAGE @@ -898,35 +935,41 @@ x-paths: localeSeverityLevels: [] groups: [] minTextLengthLimit: 40 - - profileUid: ce6d6b5dbc12 - severityLevelCode: MEDIUM - checkTypeCode: SEGMENT_COMPLETENESS - subTypes: - - checkSubTypeCode: TARGET_IS_MUCH_SHORTER_THAN_SOURCE - severityLevelCode: MEDIUM - - checkSubTypeCode: TARGET_IS_MUCH_LONGER_THAN_SOURCE - severityLevelCode: MEDIUM - - checkSubTypeCode: TARGET_IS_EMPTY - severityLevelCode: DISABLED - localeSeverityLevels: [] - groups: [] - lowerLengthThreshold: 50 - upperLengthThreshold: 250 - minLengthThreshold: 10 - - profileUid: ce6d6b5dbc12 - severityLevelCode: MEDIUM - checkTypeCode: NON_TRANSLATABLE_TEXT - subTypes: - - checkSubTypeCode: PLACEABLE_DELETED - severityLevelCode: MEDIUM - - checkSubTypeCode: SPACES_AROUND_PLACEABLE - severityLevelCode: MEDIUM - - checkSubTypeCode: PLACEABLE_ADDED + - response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: MEDIUM - - checkSubTypeCode: PLACEABLE_FORMAT + checkTypeCode: SEGMENT_COMPLETENESS + subTypes: + - checkSubTypeCode: TARGET_IS_MUCH_SHORTER_THAN_SOURCE + severityLevelCode: MEDIUM + - checkSubTypeCode: TARGET_IS_MUCH_LONGER_THAN_SOURCE + severityLevelCode: MEDIUM + - checkSubTypeCode: TARGET_IS_EMPTY + severityLevelCode: DISABLED + localeSeverityLevels: [] + groups: [] + lowerLengthThreshold: 50 + upperLengthThreshold: 250 + minLengthThreshold: 10 + - response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: MEDIUM - localeSeverityLevels: [] - groups: [] + checkTypeCode: NON_TRANSLATABLE_TEXT + subTypes: + - checkSubTypeCode: PLACEABLE_DELETED + severityLevelCode: MEDIUM + - checkSubTypeCode: SPACES_AROUND_PLACEABLE + severityLevelCode: MEDIUM + - checkSubTypeCode: PLACEABLE_ADDED + severityLevelCode: MEDIUM + - checkSubTypeCode: PLACEABLE_FORMAT + severityLevelCode: MEDIUM + localeSeverityLevels: [] + groups: [] - profileUid: ce6d6b5dbc12 severityLevelCode: LOW checkTypeCode: EMOJI_CONSISTENCY @@ -950,24 +993,30 @@ x-paths: severityLevelCode: LOW localeSeverityLevels: [] groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: TARGET_SOURCE_CONSISTENCY - subTypes: - - checkSubTypeCode: SAME_TRANSLATION_DIFFERENT_SOURCES - severityLevelCode: LOW - - checkSubTypeCode: SAME_SOURCE_DIFFERENT_TRANSLATIONS + - response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] - ignoreTagsAndPlaceholders: true - ignoreCase: true - - profileUid: ce6d6b5dbc12 - severityLevelCode: MEDIUM - checkTypeCode: BLACKLISTED_TERMS - subTypes: [] - localeSeverityLevels: [] - groups: [] + checkTypeCode: TARGET_SOURCE_CONSISTENCY + subTypes: + - checkSubTypeCode: SAME_TRANSLATION_DIFFERENT_SOURCES + severityLevelCode: LOW + - checkSubTypeCode: SAME_SOURCE_DIFFERENT_TRANSLATIONS + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] + ignoreTagsAndPlaceholders: true + ignoreCase: true + - response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: MEDIUM + checkTypeCode: BLACKLISTED_TERMS + subTypes: [] + localeSeverityLevels: [] + groups: [] - profileUid: ce6d6b5dbc12 severityLevelCode: MEDIUM checkTypeCode: GLOSSARY_COMPLIANCE @@ -977,66 +1026,81 @@ x-paths: matchMethod: MATCH_BY_PERCENTAGE matchThreshold: 50 sameTermCount: true - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: TRADEMARK_CONSISTENCY - subTypes: [] - localeSeverityLevels: [] - groups: [] + - response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: TRADEMARK_CONSISTENCY + subTypes: [] + localeSeverityLevels: [] + groups: [] - profileUid: ce6d6b5dbc12 severityLevelCode: LOW checkTypeCode: GRAMMAR_CHECK subTypes: [] localeSeverityLevels: [] groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: GLOBAL_CAPITALISATION_CONSISTENCY - subTypes: [] - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: PUNCTUATION_CONSISTENCY - subTypes: [] - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: MEDIUM - checkTypeCode: PLURALS_REPETITION - subTypes: [] - localeSeverityLevels: [] - groups: [] - - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: REGEX_CHECK - subTypes: [] - groups: [] - rules: - - ruleUid: 2d83ea74c848 + - response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: LOW - ruleName: ruleName1 - ruleTypeCode: FORBIDDEN - flavorCode: JAVA - originalPattern: '@mail' - translationPattern: '@gmail' - description: ruleName1 description - caseInsensitive: true - multiLine: false - warningMessage: test warning + checkTypeCode: GLOBAL_CAPITALISATION_CONSISTENCY + subTypes: [] + localeSeverityLevels: [] groups: [] - - ruleUid: ac3069e2fd30 + - response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: PUNCTUATION_CONSISTENCY + subTypes: [] + localeSeverityLevels: [] + groups: [] + - response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: MEDIUM - ruleName: ruleName2 - ruleTypeCode: MISSING - flavorCode: JAVA - originalPattern: '@/d' - translationPattern: '@/d' - description: ruleName2 description - caseInsensitive: true - multiLine: false - warningMessage: test warning + checkTypeCode: PLURALS_REPETITION + subTypes: [] + localeSeverityLevels: [] groups: [] + - response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: REGEX_CHECK + subTypes: [] + groups: [] + rules: + - ruleUid: 2d83ea74c848 + severityLevelCode: LOW + ruleName: ruleName1 + ruleTypeCode: FORBIDDEN + flavorCode: JAVA + originalPattern: '@mail' + translationPattern: '@gmail' + description: ruleName1 description + caseInsensitive: true + multiLine: false + warningMessage: test warning + groups: [] + - ruleUid: ac3069e2fd30 + severityLevelCode: MEDIUM + ruleName: ruleName2 + ruleTypeCode: MISSING + flavorCode: JAVA + originalPattern: '@/d' + translationPattern: '@/d' + description: ruleName2 description + caseInsensitive: true + multiLine: false + warningMessage: test warning + groups: [] - profileUid: ce6d6b5dbc12 severityLevelCode: LOW checkTypeCode: OPEN_ISSUES @@ -1212,6 +1276,9 @@ x-paths: in: path required: true schema: + type: string + description: '[check type code](#operation/getTranslationQualityCheckTypes)' + example: LEADING_TRAILING_SPACES enum: - LEADING_TRAILING_SPACES - ORIGINAL_EQUALS_TARGET @@ -1358,6 +1425,7 @@ x-paths: properties: checkSubTypeCode: type: string + nullable: true enum: - TAG_ADDED - TAG_DELETED @@ -1366,6 +1434,7 @@ x-paths: description: check subtype code example: TAG_ADDED severityLevelCode: + nullable: true type: string enum: - LOW @@ -1411,6 +1480,7 @@ x-paths: properties: checkSubTypeCode: type: string + nullable: true enum: - NUMBER_ADDED - NUMBER_DELETED @@ -1418,6 +1488,7 @@ x-paths: description: check subtype code example: NUMBER_ADDED severityLevelCode: + nullable: true type: string enum: - LOW @@ -1508,6 +1579,7 @@ x-paths: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - TARGET_IS_EMPTY @@ -1516,6 +1588,7 @@ x-paths: description: check subtype code example: TARGET_IS_EMPTY severityLevelCode: + nullable: true type: string enum: - LOW @@ -1542,6 +1615,7 @@ x-paths: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - PLACEABLE_ADDED @@ -1551,6 +1625,7 @@ x-paths: description: check subtype code example: PLACEABLE_ADDED severityLevelCode: + nullable: true type: string enum: - LOW @@ -1569,6 +1644,8 @@ x-paths: type: boolean description: No emoji is allowed in target example: false + required: + - noEmojisAllowedInTarget - type: object properties: checkTypeCode: @@ -1617,6 +1694,7 @@ x-paths: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - INSERTABLE_ADDED @@ -1624,6 +1702,7 @@ x-paths: description: check subtype code example: INSERTABLE_ADDED severityLevelCode: + nullable: true type: string enum: - LOW @@ -2029,12 +2108,15 @@ x-paths: groups: [] GRAMMAR_CHECK: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: GRAMMAR_CHECK - subTypes: [] - localeSeverityLevels: [] - groups: [] + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: GRAMMAR_CHECK + subTypes: [] + localeSeverityLevels: [] + groups: [] GLOBAL_CAPITALISATION_CONSISTENCY: value: profileUid: ce6d6b5dbc12 @@ -2133,10 +2215,14 @@ x-paths: application/json: schema: oneOf: - - title: EMOJI_CONSISTENCY + - &ref_30 + title: EMOJI_CONSISTENCY allOf: - *ref_16 - - &ref_18 + - title: SPELLCHECK + allOf: + - *ref_17 + - &ref_19 type: object properties: targetLocaleId: @@ -2147,14 +2233,6 @@ x-paths: example: it-IT required: - targetLocaleId - - &ref_30 - type: object - required: - - noEmojisAllowedInTarget - - title: SPELLCHECK - allOf: - - *ref_17 - - *ref_18 - &ref_31 type: object required: @@ -2165,8 +2243,8 @@ x-paths: - runSpellcheckForSubWords - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - *ref_19 - *ref_18 + - *ref_19 - &ref_32 type: object required: @@ -2177,7 +2255,7 @@ x-paths: type: object required: - minTextLengthLimit - - *ref_18 + - *ref_19 - *ref_20 - &ref_34 title: NUMBER_CONSISTENCY @@ -2186,7 +2264,7 @@ x-paths: - title: TARGET_SOURCE_CONSISTENCY allOf: - *ref_22 - - *ref_18 + - *ref_19 - &ref_35 type: object required: @@ -2206,7 +2284,7 @@ x-paths: - title: ORIGINAL_EQUALS_TARGET allOf: - *ref_25 - - *ref_18 + - *ref_19 - &ref_37 type: object required: @@ -2215,7 +2293,7 @@ x-paths: - title: SEGMENT_COMPLETENESS allOf: - *ref_26 - - *ref_18 + - *ref_19 - &ref_38 title: OPEN_ISSUES allOf: @@ -2238,7 +2316,7 @@ x-paths: - type: object properties: data: &ref_39 - oneOf: + anyOf: - title: EMOJI_CONSISTENCY allOf: - *ref_16 @@ -2247,7 +2325,7 @@ x-paths: - *ref_17 - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - *ref_19 + - *ref_18 - title: TARGET_IN_WRONG_LANGUAGE allOf: - *ref_20 @@ -2272,45 +2350,75 @@ x-paths: examples: EMOJI_CONSISTENCY: value: - noEmojisAllowedInTarget: true + response: + code: SUCCESS + data: + noEmojisAllowedInTarget: true SPELLCHECK: value: - skipIfWordInUserDictionary: false - skipIfWordStartsWithCapitalLetter: true - skipIfWordAppearsInSourceString: false - skipIfWordValidInSourceLocale: true - runSpellcheckForSubWords: true + response: + code: SUCCESS + data: + skipIfWordInUserDictionary: false + skipIfWordStartsWithCapitalLetter: true + skipIfWordAppearsInSourceString: false + skipIfWordValidInSourceLocale: true + runSpellcheckForSubWords: true SOURCE_IN_WRONG_LANGUAGE: value: - minTextLengthLimit: 10 + response: + code: SUCCESS + data: + minTextLengthLimit: 10 TARGET_IN_WRONG_LANGUAGE: value: - minTextLengthLimit: 15 + response: + code: SUCCESS + data: + minTextLengthLimit: 15 NUMBER_CONSISTENCY: value: - ignoreSign: true + response: + code: SUCCESS + data: + ignoreSign: true TARGET_SOURCE_CONSISTENCY: value: - ignoreTagsAndPlaceholders: true - ignoreCase: true + response: + code: SUCCESS + data: + ignoreTagsAndPlaceholders: true + ignoreCase: true GLOSSARY_COMPLIANCE: value: - matchMethod: MATCH_BY_PERCENTAGE - matchThreshold: 10 - sameTermCount: true + response: + code: SUCCESS + data: + matchMethod: MATCH_BY_PERCENTAGE + matchThreshold: 10 + sameTermCount: true ORIGINAL_EQUALS_TARGET: value: - mustHaveIdenticalTags: false - mustHaveIdenticalCapitalization: false + response: + code: SUCCESS + data: + mustHaveIdenticalTags: false + mustHaveIdenticalCapitalization: false SEGMENT_COMPLETENESS: value: - lowerLengthThreshold: 10 - upperLengthThreshold: 20 - minLengthThreshold: 15 + response: + code: SUCCESS + data: + lowerLengthThreshold: 10 + upperLengthThreshold: 20 + minLengthThreshold: 15 OPEN_ISSUES: value: - sourceIssuesMustBeResolved: true - translationIssuesMustBeResolved: true + response: + code: SUCCESS + data: + sourceIssuesMustBeResolved: true + translationIssuesMustBeResolved: true '400': *ref_12 '401': *ref_13 '429': *ref_14 @@ -2345,42 +2453,38 @@ x-paths: application/json: schema: oneOf: - - title: EMOJI_CONSISTENCY - allOf: - - *ref_16 - - *ref_18 - - *ref_30 + - *ref_30 - title: SPELLCHECK allOf: - *ref_17 - - *ref_18 + - *ref_19 - *ref_31 - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - *ref_19 - *ref_18 + - *ref_19 - *ref_32 - title: TARGET_IN_WRONG_LANGUAGE allOf: - *ref_33 - - *ref_18 + - *ref_19 - *ref_20 - *ref_34 - title: TARGET_SOURCE_CONSISTENCY allOf: - *ref_22 - - *ref_18 + - *ref_19 - *ref_35 - *ref_36 - title: ORIGINAL_EQUALS_TARGET allOf: - *ref_25 - - *ref_18 + - *ref_19 - *ref_37 - title: SEGMENT_COMPLETENESS allOf: - *ref_26 - - *ref_18 + - *ref_19 - *ref_38 responses: '200': @@ -2399,45 +2503,75 @@ x-paths: examples: EMOJI_CONSISTENCY: value: - noEmojisAllowedInTarget: true + response: + code: SUCCESS + data: + noEmojisAllowedInTarget: true SPELLCHECK: value: - skipIfWordInUserDictionary: false - skipIfWordStartsWithCapitalLetter: true - skipIfWordAppearsInSourceString: false - skipIfWordValidInSourceLocale: true - runSpellcheckForSubWords: true + response: + code: SUCCESS + data: + skipIfWordInUserDictionary: false + skipIfWordStartsWithCapitalLetter: true + skipIfWordAppearsInSourceString: false + skipIfWordValidInSourceLocale: true + runSpellcheckForSubWords: true SOURCE_IN_WRONG_LANGUAGE: value: - minTextLengthLimit: 10 + response: + code: SUCCESS + data: + minTextLengthLimit: 10 TARGET_IN_WRONG_LANGUAGE: value: - minTextLengthLimit: 15 + response: + code: SUCCESS + data: + minTextLengthLimit: 15 NUMBER_CONSISTENCY: value: - ignoreSign: true + response: + code: SUCCESS + data: + ignoreSign: true TARGET_SOURCE_CONSISTENCY: value: - ignoreTagsAndPlaceholders: true - ignoreCase: true + response: + code: SUCCESS + data: + ignoreTagsAndPlaceholders: true + ignoreCase: true GLOSSARY_COMPLIANCE: value: - matchMethod: MATCH_BY_PERCENTAGE - matchThreshold: 10 - sameTermCount: true + response: + code: SUCCESS + data: + matchMethod: MATCH_BY_PERCENTAGE + matchThreshold: 10 + sameTermCount: true ORIGINAL_EQUALS_TARGET: value: - mustHaveIdenticalTags: false - mustHaveIdenticalCapitalization: false + response: + code: SUCCESS + data: + mustHaveIdenticalTags: false + mustHaveIdenticalCapitalization: false SEGMENT_COMPLETENESS: value: - lowerLengthThreshold: 10 - upperLengthThreshold: 20 - minLengthThreshold: 15 + response: + code: SUCCESS + data: + lowerLengthThreshold: 10 + upperLengthThreshold: 20 + minLengthThreshold: 15 OPEN_ISSUES: value: - sourceIssuesMustBeResolved: true - translationIssuesMustBeResolved: true + response: + code: SUCCESS + data: + sourceIssuesMustBeResolved: true + translationIssuesMustBeResolved: true '400': *ref_12 '401': *ref_13 '429': *ref_14 @@ -2645,6 +2779,7 @@ x-paths: properties: checkSubTypeCode: type: string + nullable: true enum: - PLACEABLE_ADDED - PLACEABLE_DELETED @@ -2653,6 +2788,7 @@ x-paths: description: check subtype code example: PLACEABLE_ADDED severityLevelCode: + nullable: true type: string enum: - LOW @@ -2757,7 +2893,7 @@ x-paths: - title: SOURCE_IN_WRONG_LANGUAGE allOf: - *ref_5 - - *ref_19 + - *ref_18 - type: object properties: checkTypeCode: @@ -2795,6 +2931,7 @@ x-paths: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - TAG_ADDED @@ -2804,6 +2941,7 @@ x-paths: description: check subtype code example: TAG_ADDED severityLevelCode: + nullable: true type: string enum: - LOW @@ -3061,15 +3199,18 @@ x-paths: localeSeverityLevels: [] groups: [] noEmojisAllowedInTarget: false - - severityLevelCode: LOW - checkTypeCode: INSERTABLE_CONSISTENCY - subTypes: - - checkSubTypeCode: INSERTABLE_DELETED - severityLevelCode: LOW - - checkSubTypeCode: INSERTABLE_ADDED + - response: + code: SUCCESS + data: severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] + checkTypeCode: INSERTABLE_CONSISTENCY + subTypes: + - checkSubTypeCode: INSERTABLE_DELETED + severityLevelCode: LOW + - checkSubTypeCode: INSERTABLE_ADDED + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] - severityLevelCode: LOW checkTypeCode: TARGET_SOURCE_CONSISTENCY subTypes: diff --git a/spec/translation_quality/check_type_severity_level_result.yaml b/spec/translation_quality/check_type_severity_level_result.yaml index a678a056..fca2e17c 100644 --- a/spec/translation_quality/check_type_severity_level_result.yaml +++ b/spec/translation_quality/check_type_severity_level_result.yaml @@ -28,6 +28,9 @@ x-paths: in: path required: true schema: + type: string + description: '[check type code](#operation/getTranslationQualityCheckTypes)' + example: LEADING_TRAILING_SPACES enum: - LEADING_TRAILING_SPACES - ORIGINAL_EQUALS_TARGET diff --git a/spec/translation_quality/checks/blacklisted_terms.yaml b/spec/translation_quality/checks/blacklisted_terms.yaml index 37497b05..847cf156 100644 --- a/spec/translation_quality/checks/blacklisted_terms.yaml +++ b/spec/translation_quality/checks/blacklisted_terms.yaml @@ -103,12 +103,15 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "MEDIUM" - "checkTypeCode": "BLACKLISTED_TERMS" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "MEDIUM" + "checkTypeCode": "BLACKLISTED_TERMS" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/emoji_consistency.yaml b/spec/translation_quality/checks/emoji_consistency.yaml index ca3ebb9c..9f899ae2 100644 --- a/spec/translation_quality/checks/emoji_consistency.yaml +++ b/spec/translation_quality/checks/emoji_consistency.yaml @@ -8,15 +8,13 @@ components: type: boolean description: No emoji is allowed in target example: false + required: + - noEmojisAllowedInTarget AccountCheckTypeApplySettingsRequest: title: EMOJI_CONSISTENCY allOf: - $ref: '#/components/schemas/EmojiConsistencySettingsDTO' - - $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' - - type: object - required: - - noEmojisAllowedInTarget AccountCheckTypeApplySettingsDTOResponse: title: EMOJI_CONSISTENCY @@ -136,14 +134,14 @@ components: description: emoji defect type example: "EMOJI_DELETED" severityLevelCode: - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: "LOW" + type: string + enum: + - LOW + - MEDIUM + - HIGH + - DISABLED + description: severity level code + example: "LOW" positionTypeCode: type: string enum: @@ -173,13 +171,19 @@ components: noEmojisAllowedInTarget: true profiles_accounts_check_types_checkType_settings_example: - noEmojisAllowedInTarget: true + "response": + "code": "SUCCESS" + "data": + "noEmojisAllowedInTarget": true accounts_check_types_checkType_group_settings_example: noEmojisAllowedInTarget: true profiles_accounts_check_types_checkType_group_settings_example: - noEmojisAllowedInTarget: true + "response": + "code": "SUCCESS" + "data": + noEmojisAllowedInTarget: true tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/global_capitalisation_consistency.yaml b/spec/translation_quality/checks/global_capitalisation_consistency.yaml index d0ef366e..9fa555a9 100644 --- a/spec/translation_quality/checks/global_capitalisation_consistency.yaml +++ b/spec/translation_quality/checks/global_capitalisation_consistency.yaml @@ -85,12 +85,15 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "GLOBAL_CAPITALISATION_CONSISTENCY" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "GLOBAL_CAPITALISATION_CONSISTENCY" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/glossary_compliance.yaml b/spec/translation_quality/checks/glossary_compliance.yaml index b251f4a9..372097e9 100644 --- a/spec/translation_quality/checks/glossary_compliance.yaml +++ b/spec/translation_quality/checks/glossary_compliance.yaml @@ -254,18 +254,24 @@ components: matchThreshold: 10 profiles_accounts_check_types_checkType_settings_example: - matchMethod: MATCH_BY_PERCENTAGE - matchThreshold: 10 - sameTermCount: true + "response": + "code": "SUCCESS" + "data": + matchMethod: MATCH_BY_PERCENTAGE + matchThreshold: 10 + sameTermCount: true accounts_check_types_checkType_group_settings_example: matchMethod: MATCH_BY_PERCENTAGE matchThreshold: 10 profiles_accounts_check_types_checkType_group_settings_example: - matchMethod: MATCH_BY_PERCENTAGE - matchThreshold: 10 - sameTermCount: true + "response": + "code": "SUCCESS" + "data": + matchMethod: MATCH_BY_PERCENTAGE + matchThreshold: 10 + sameTermCount: true tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/grammar_check.yaml b/spec/translation_quality/checks/grammar_check.yaml index 846299de..ed263c2f 100644 --- a/spec/translation_quality/checks/grammar_check.yaml +++ b/spec/translation_quality/checks/grammar_check.yaml @@ -85,12 +85,15 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "GRAMMAR_CHECK" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "GRAMMAR_CHECK" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] accounts_check_types_settings_example: "severityLevelCode": "LOW" diff --git a/spec/translation_quality/checks/insertable_consistency.yaml b/spec/translation_quality/checks/insertable_consistency.yaml index 0fb37962..a13a1725 100644 --- a/spec/translation_quality/checks/insertable_consistency.yaml +++ b/spec/translation_quality/checks/insertable_consistency.yaml @@ -54,6 +54,7 @@ components: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - INSERTABLE_ADDED @@ -61,6 +62,7 @@ components: description: check subtype code example: "INSERTABLE_ADDED" severityLevelCode: + nullable: true type: string enum: - LOW @@ -145,15 +147,18 @@ components: "groups": [] projects_check_types_settings_example: - "severityLevelCode": "LOW" - "checkTypeCode": "INSERTABLE_CONSISTENCY" - "subTypes": - - "checkSubTypeCode": "INSERTABLE_DELETED" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "INSERTABLE_ADDED" + "response": + "code": "SUCCESS" + "data": "severityLevelCode": "LOW" - "localeSeverityLevels": [] - "groups": [] + "checkTypeCode": "INSERTABLE_CONSISTENCY" + "subTypes": + - "checkSubTypeCode": "INSERTABLE_DELETED" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "INSERTABLE_ADDED" + "severityLevelCode": "LOW" + "localeSeverityLevels": [] + "groups": [] profiles_accounts_check_types_settings_example: "profileUid": "ce6d6b5dbc12" diff --git a/spec/translation_quality/checks/leading_trailing_spaces.yaml b/spec/translation_quality/checks/leading_trailing_spaces.yaml index ce22ee1f..fca6ef91 100644 --- a/spec/translation_quality/checks/leading_trailing_spaces.yaml +++ b/spec/translation_quality/checks/leading_trailing_spaces.yaml @@ -76,12 +76,15 @@ components: examples: profiles_accounts_check_types_settings_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "LEADING_TRAILING_SPACES" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "LEADING_TRAILING_SPACES" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] accounts_check_types_settings_example: "severityLevelCode": "LOW" diff --git a/spec/translation_quality/checks/non_translatable_text.yaml b/spec/translation_quality/checks/non_translatable_text.yaml index ebc44e8a..ce4174a0 100644 --- a/spec/translation_quality/checks/non_translatable_text.yaml +++ b/spec/translation_quality/checks/non_translatable_text.yaml @@ -20,6 +20,7 @@ components: properties: checkSubTypeCode: type: string + nullable: true enum: - PLACEABLE_ADDED - PLACEABLE_DELETED @@ -28,6 +29,7 @@ components: description: check subtype code example: "PLACEABLE_ADDED" severityLevelCode: + nullable: true type: string enum: - LOW @@ -56,6 +58,7 @@ components: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - PLACEABLE_ADDED @@ -65,6 +68,7 @@ components: description: check subtype code example: "PLACEABLE_ADDED" severityLevelCode: + nullable: true type: string enum: - LOW @@ -170,20 +174,23 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "MEDIUM" - "checkTypeCode": "NON_TRANSLATABLE_TEXT" - "subTypes": - - "checkSubTypeCode": "PLACEABLE_DELETED" - "severityLevelCode": "MEDIUM" - - "checkSubTypeCode": "SPACES_AROUND_PLACEABLE" - "severityLevelCode": "MEDIUM" - - "checkSubTypeCode": "PLACEABLE_ADDED" - "severityLevelCode": "MEDIUM" - - "checkSubTypeCode": "PLACEABLE_FORMAT" - "severityLevelCode": "MEDIUM" - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "MEDIUM" + "checkTypeCode": "NON_TRANSLATABLE_TEXT" + "subTypes": + - "checkSubTypeCode": "PLACEABLE_DELETED" + "severityLevelCode": "MEDIUM" + - "checkSubTypeCode": "SPACES_AROUND_PLACEABLE" + "severityLevelCode": "MEDIUM" + - "checkSubTypeCode": "PLACEABLE_ADDED" + "severityLevelCode": "MEDIUM" + - "checkSubTypeCode": "PLACEABLE_FORMAT" + "severityLevelCode": "MEDIUM" + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/number_consistency.yaml b/spec/translation_quality/checks/number_consistency.yaml index a8b74f71..7199a65e 100644 --- a/spec/translation_quality/checks/number_consistency.yaml +++ b/spec/translation_quality/checks/number_consistency.yaml @@ -76,6 +76,7 @@ components: properties: checkSubTypeCode: type: string + nullable: true enum: - NUMBER_ADDED - NUMBER_DELETED @@ -83,6 +84,7 @@ components: description: check subtype code example: "NUMBER_ADDED" severityLevelCode: + nullable: true type: string enum: - LOW @@ -186,20 +188,23 @@ components: "ignoreSign": true accounts_check_types_settings_example: - "severityLevelCode": "LOW" - "checkTypeCode": "NUMBER_CONSISTENCY" - "subTypes": - - "checkSubTypeCode": "NUMBER_DELETED" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "NUMBER_ADDED" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "NUMBER_INCORRECT_CONVERSION" + "response": + "code": "SUCCESS" + "data": "severityLevelCode": "LOW" - "localeSeverityLevels": [] - "groups": - - "groupUid": "b0dd258b05ee" - - "groupUid": "a853df2cf8ac" - "ignoreSign": true + "checkTypeCode": "NUMBER_CONSISTENCY" + "subTypes": + - "checkSubTypeCode": "NUMBER_DELETED" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "NUMBER_ADDED" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "NUMBER_INCORRECT_CONVERSION" + "severityLevelCode": "LOW" + "localeSeverityLevels": [] + "groups": + - "groupUid": "b0dd258b05ee" + - "groupUid": "a853df2cf8ac" + "ignoreSign": true projects_check_types_settings_example: "severityLevelCode": "LOW" @@ -238,13 +243,19 @@ components: ignoreSign: true profiles_accounts_check_types_checkType_settings_example: - ignoreSign: true + "response": + "code": "SUCCESS" + "data": + ignoreSign: true accounts_check_types_checkType_group_settings_example: ignoreSign: true profiles_accounts_check_types_checkType_group_settings_example: - ignoreSign: true + "response": + "code": "SUCCESS" + "data": + ignoreSign: true tqc_check_response_example: "response": @@ -275,7 +286,7 @@ components: "to": 7 "details": "type": "NUMBER_ADDED" - "number": "20" + "number": 20 "positionTypeCode": "TARGET" dictionary_checkTypes_response_example: diff --git a/spec/translation_quality/checks/open_issues.yaml b/spec/translation_quality/checks/open_issues.yaml index 1829e1ef..bb8ea38d 100644 --- a/spec/translation_quality/checks/open_issues.yaml +++ b/spec/translation_quality/checks/open_issues.yaml @@ -146,16 +146,22 @@ components: translationIssuesMustBeResolved: true profiles_accounts_check_types_checkType_settings_example: - sourceIssuesMustBeResolved: true - translationIssuesMustBeResolved: true + "response": + "code": "SUCCESS" + "data": + sourceIssuesMustBeResolved: true + translationIssuesMustBeResolved: true accounts_check_types_checkType_group_settings_example: sourceIssuesMustBeResolved: true translationIssuesMustBeResolved: true profiles_accounts_check_types_checkType_group_settings_example: - sourceIssuesMustBeResolved: true - translationIssuesMustBeResolved: true + "response": + "code": "SUCCESS" + "data": + sourceIssuesMustBeResolved: true + translationIssuesMustBeResolved: true tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/original_equals_target.yaml b/spec/translation_quality/checks/original_equals_target.yaml index b62aa74a..37f7027a 100644 --- a/spec/translation_quality/checks/original_equals_target.yaml +++ b/spec/translation_quality/checks/original_equals_target.yaml @@ -123,14 +123,17 @@ components: "mustHaveIdenticalCapitalization": true profiles_accounts_check_types_settings_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "ORIGINAL_EQUALS_TARGET" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] - "mustHaveIdenticalTags": true - "mustHaveIdenticalCapitalization": true + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "ORIGINAL_EQUALS_TARGET" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] + "mustHaveIdenticalTags": true + "mustHaveIdenticalCapitalization": true profiles_account_check_types_settings_effective_example: "profileUid": "ce6d6b5dbc12" @@ -147,16 +150,22 @@ components: mustHaveIdenticalCapitalization: false profiles_accounts_check_types_checkType_settings_example: - mustHaveIdenticalTags: false - mustHaveIdenticalCapitalization: false + "response": + "code": "SUCCESS" + "data": + mustHaveIdenticalTags: false + mustHaveIdenticalCapitalization: false accounts_check_types_checkType_group_settings_example: mustHaveIdenticalTags: false mustHaveIdenticalCapitalization: false profiles_accounts_check_types_checkType_group_settings_example: - mustHaveIdenticalTags: false - mustHaveIdenticalCapitalization: false + "response": + "code": "SUCCESS" + "data": + mustHaveIdenticalTags: false + mustHaveIdenticalCapitalization: false tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/plurals_repetition.yaml b/spec/translation_quality/checks/plurals_repetition.yaml index d7e0fa08..3ee0b387 100644 --- a/spec/translation_quality/checks/plurals_repetition.yaml +++ b/spec/translation_quality/checks/plurals_repetition.yaml @@ -95,12 +95,15 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "MEDIUM" - "checkTypeCode": "PLURALS_REPETITION" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "MEDIUM" + "checkTypeCode": "PLURALS_REPETITION" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/punctuation_consistency.yaml b/spec/translation_quality/checks/punctuation_consistency.yaml index 5544ea66..486d84a7 100644 --- a/spec/translation_quality/checks/punctuation_consistency.yaml +++ b/spec/translation_quality/checks/punctuation_consistency.yaml @@ -85,12 +85,15 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "PUNCTUATION_CONSISTENCY" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "PUNCTUATION_CONSISTENCY" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/regex_check.yaml b/spec/translation_quality/checks/regex_check.yaml index 0d6b7a9b..918ec556 100644 --- a/spec/translation_quality/checks/regex_check.yaml +++ b/spec/translation_quality/checks/regex_check.yaml @@ -68,36 +68,39 @@ components: "checkSubTypes": [] profiles_accounts_check_types_settings_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "REGEX_CHECK" - "subTypes": [] - "groups": [] - "rules": - - "ruleUid": "2d83ea74c848" + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" "severityLevelCode": "LOW" - "ruleName": "ruleName1" - "ruleTypeCode": "FORBIDDEN" - "flavorCode": "JAVA" - "originalPattern": "@mail" - "translationPattern": "@gmail" - "description": "ruleName1 description" - "caseInsensitive": true - "multiLine": false - "warningMessage": "test warning" - "groups": [] - - "ruleUid": "ac3069e2fd30" - "severityLevelCode": "MEDIUM" - "ruleName": "ruleName2" - "ruleTypeCode": "MISSING" - "flavorCode": "JAVA" - "originalPattern": "@/d" - "translationPattern": "@/d" - "description": "ruleName2 description" - "caseInsensitive": true - "multiLine": false - "warningMessage": "test warning" + "checkTypeCode": "REGEX_CHECK" + "subTypes": [] "groups": [] + "rules": + - "ruleUid": "2d83ea74c848" + "severityLevelCode": "LOW" + "ruleName": "ruleName1" + "ruleTypeCode": "FORBIDDEN" + "flavorCode": "JAVA" + "originalPattern": "@mail" + "translationPattern": "@gmail" + "description": "ruleName1 description" + "caseInsensitive": true + "multiLine": false + "warningMessage": "test warning" + "groups": [] + - "ruleUid": "ac3069e2fd30" + "severityLevelCode": "MEDIUM" + "ruleName": "ruleName2" + "ruleTypeCode": "MISSING" + "flavorCode": "JAVA" + "originalPattern": "@/d" + "translationPattern": "@/d" + "description": "ruleName2 description" + "caseInsensitive": true + "multiLine": false + "warningMessage": "test warning" + "groups": [] projects_check_types_settings_example: "severityLevelCode": "LOW" diff --git a/spec/translation_quality/checks/repeated_word.yaml b/spec/translation_quality/checks/repeated_word.yaml index eb09143f..b113c225 100644 --- a/spec/translation_quality/checks/repeated_word.yaml +++ b/spec/translation_quality/checks/repeated_word.yaml @@ -90,12 +90,15 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "REPEATED_WORD" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "REPEATED_WORD" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: diff --git a/spec/translation_quality/checks/segment_completeness.yaml b/spec/translation_quality/checks/segment_completeness.yaml index 156a8e52..1a216eb8 100644 --- a/spec/translation_quality/checks/segment_completeness.yaml +++ b/spec/translation_quality/checks/segment_completeness.yaml @@ -84,6 +84,7 @@ components: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - TARGET_IS_EMPTY @@ -92,6 +93,7 @@ components: description: check subtype code example: "TARGET_IS_EMPTY" severityLevelCode: + nullable: true type: string enum: - LOW @@ -178,21 +180,24 @@ components: "minLengthThreshold": 10 profiles_accounts_check_types_settings_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "MEDIUM" - "checkTypeCode": "SEGMENT_COMPLETENESS" - "subTypes": - - "checkSubTypeCode": "TARGET_IS_MUCH_SHORTER_THAN_SOURCE" - "severityLevelCode": "MEDIUM" - - "checkSubTypeCode": "TARGET_IS_MUCH_LONGER_THAN_SOURCE" + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" "severityLevelCode": "MEDIUM" - - "checkSubTypeCode": "TARGET_IS_EMPTY" - "severityLevelCode": "DISABLED" - "localeSeverityLevels": [] - "groups": [] - "lowerLengthThreshold": 50 - "upperLengthThreshold": 250 - "minLengthThreshold": 10 + "checkTypeCode": "SEGMENT_COMPLETENESS" + "subTypes": + - "checkSubTypeCode": "TARGET_IS_MUCH_SHORTER_THAN_SOURCE" + "severityLevelCode": "MEDIUM" + - "checkSubTypeCode": "TARGET_IS_MUCH_LONGER_THAN_SOURCE" + "severityLevelCode": "MEDIUM" + - "checkSubTypeCode": "TARGET_IS_EMPTY" + "severityLevelCode": "DISABLED" + "localeSeverityLevels": [] + "groups": [] + "lowerLengthThreshold": 50 + "upperLengthThreshold": 250 + "minLengthThreshold": 10 accounts_check_types_checkType_settings_example: lowerLengthThreshold: 10 @@ -216,9 +221,12 @@ components: "minLengthThreshold": 10 profiles_accounts_check_types_checkType_settings_example: - lowerLengthThreshold: 10 - upperLengthThreshold: 20 - minLengthThreshold: 15 + "response": + "code": "SUCCESS" + "data": + lowerLengthThreshold: 10 + upperLengthThreshold: 20 + minLengthThreshold: 15 accounts_check_types_checkType_group_settings_example: lowerLengthThreshold: 10 @@ -226,9 +234,12 @@ components: minLengthThreshold: 15 profiles_accounts_check_types_checkType_group_settings_example: - lowerLengthThreshold: 10 - upperLengthThreshold: 20 - minLengthThreshold: 15 + "response": + "code": "SUCCESS" + "data": + lowerLengthThreshold: 10 + upperLengthThreshold: 20 + minLengthThreshold: 15 tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/source_in_wrong_language.yaml b/spec/translation_quality/checks/source_in_wrong_language.yaml index 37783c56..f5a7c306 100644 --- a/spec/translation_quality/checks/source_in_wrong_language.yaml +++ b/spec/translation_quality/checks/source_in_wrong_language.yaml @@ -125,13 +125,19 @@ components: minTextLengthLimit: 10 profiles_accounts_check_types_checkType_settings_example: - minTextLengthLimit: 10 + "response": + "code": "SUCCESS" + "data": + minTextLengthLimit: 10 accounts_check_types_checkType_group_settings_example: minTextLengthLimit: 10 profiles_accounts_check_types_checkType_group_settings_example: - minTextLengthLimit: 10 + "response": + "code": "SUCCESS" + "data": + minTextLengthLimit: 10 tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/spellcheck.yaml b/spec/translation_quality/checks/spellcheck.yaml index ba06d78d..36a6953a 100644 --- a/spec/translation_quality/checks/spellcheck.yaml +++ b/spec/translation_quality/checks/spellcheck.yaml @@ -185,11 +185,14 @@ components: runSpellcheckForSubWords: true profiles_accounts_check_types_checkType_settings_example: - skipIfWordInUserDictionary: false - skipIfWordStartsWithCapitalLetter: true - skipIfWordAppearsInSourceString: false - skipIfWordValidInSourceLocale: true - runSpellcheckForSubWords: true + response: + code: "SUCCESS" + data: + skipIfWordInUserDictionary: false + skipIfWordStartsWithCapitalLetter: true + skipIfWordAppearsInSourceString: false + skipIfWordValidInSourceLocale: true + runSpellcheckForSubWords: true accounts_check_types_checkType_group_settings_example: skipIfWordInUserDictionary: false @@ -199,11 +202,14 @@ components: runSpellcheckForSubWords: true profiles_accounts_check_types_checkType_group_settings_example: - skipIfWordInUserDictionary: false - skipIfWordStartsWithCapitalLetter: true - skipIfWordAppearsInSourceString: false - skipIfWordValidInSourceLocale: true - runSpellcheckForSubWords: true + "response": + "code": "SUCCESS" + "data": + skipIfWordInUserDictionary: false + skipIfWordStartsWithCapitalLetter: true + skipIfWordAppearsInSourceString: false + skipIfWordValidInSourceLocale: true + runSpellcheckForSubWords: true tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/tag_consistency.yaml b/spec/translation_quality/checks/tag_consistency.yaml index 69edf87b..e32b55f9 100644 --- a/spec/translation_quality/checks/tag_consistency.yaml +++ b/spec/translation_quality/checks/tag_consistency.yaml @@ -18,6 +18,7 @@ components: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - TAG_ADDED @@ -27,6 +28,7 @@ components: description: check subtype code example: "TAG_ADDED" severityLevelCode: + nullable: true type: string enum: - LOW @@ -57,6 +59,7 @@ components: properties: checkSubTypeCode: type: string + nullable: true enum: - TAG_ADDED - TAG_DELETED @@ -65,6 +68,7 @@ components: description: check subtype code example: "TAG_ADDED" severityLevelCode: + nullable: true type: string enum: - LOW @@ -169,20 +173,23 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "TAG_CONSISTENCY" - "subTypes": - - "checkSubTypeCode": "TAG_ADDED" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "TAG_DELETED" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "TAG_ORDER_IS_CHANGED" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "SPACES_AROUND_TAGS" - "severityLevelCode": "LOW" - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "TAG_CONSISTENCY" + "subTypes": + - "checkSubTypeCode": "TAG_ADDED" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "TAG_DELETED" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "TAG_ORDER_IS_CHANGED" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "SPACES_AROUND_TAGS" + "severityLevelCode": "LOW" + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/target_in_wrong_language.yaml b/spec/translation_quality/checks/target_in_wrong_language.yaml index c5e89469..a9c4b427 100644 --- a/spec/translation_quality/checks/target_in_wrong_language.yaml +++ b/spec/translation_quality/checks/target_in_wrong_language.yaml @@ -114,25 +114,34 @@ components: "minTextLengthLimit": 40 profiles_accounts_check_types_settings_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "TARGET_IN_WRONG_LANGUAGE" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] - "minTextLengthLimit": 40 + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "TARGET_IN_WRONG_LANGUAGE" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] + "minTextLengthLimit": 40 accounts_check_types_checkType_settings_example: minTextLengthLimit: 15 profiles_accounts_check_types_checkType_settings_example: - minTextLengthLimit: 15 + "response": + "code": "SUCCESS" + "data": + minTextLengthLimit: 15 accounts_check_types_checkType_group_settings_example: minTextLengthLimit: 15 profiles_accounts_check_types_checkType_group_settings_example: - minTextLengthLimit: 15 + "response": + "code": "SUCCESS" + "data": + minTextLengthLimit: 15 tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/target_length_limit.yaml b/spec/translation_quality/checks/target_length_limit.yaml index d8a0862e..ce723f41 100644 --- a/spec/translation_quality/checks/target_length_limit.yaml +++ b/spec/translation_quality/checks/target_length_limit.yaml @@ -85,12 +85,15 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "HIGH" - "checkTypeCode": "TARGET_LENGTH_LIMIT" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "HIGH" + "checkTypeCode": "TARGET_LENGTH_LIMIT" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/target_source_consistency.yaml b/spec/translation_quality/checks/target_source_consistency.yaml index 5813e8f9..9f3b1b92 100644 --- a/spec/translation_quality/checks/target_source_consistency.yaml +++ b/spec/translation_quality/checks/target_source_consistency.yaml @@ -189,34 +189,43 @@ components: "ignoreCase": true profiles_accounts_check_types_settings_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "TARGET_SOURCE_CONSISTENCY" - "subTypes": - - "checkSubTypeCode": "SAME_TRANSLATION_DIFFERENT_SOURCES" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "SAME_SOURCE_DIFFERENT_TRANSLATIONS" + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" "severityLevelCode": "LOW" - "localeSeverityLevels": [] - "groups": [] - "ignoreTagsAndPlaceholders": true - "ignoreCase": true + "checkTypeCode": "TARGET_SOURCE_CONSISTENCY" + "subTypes": + - "checkSubTypeCode": "SAME_TRANSLATION_DIFFERENT_SOURCES" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "SAME_SOURCE_DIFFERENT_TRANSLATIONS" + "severityLevelCode": "LOW" + "localeSeverityLevels": [] + "groups": [] + "ignoreTagsAndPlaceholders": true + "ignoreCase": true accounts_check_types_checkType_settings_example: ignoreTagsAndPlaceholders: true ignoreCase: true profiles_accounts_check_types_checkType_settings_example: - ignoreTagsAndPlaceholders: true - ignoreCase: true + "response": + "code": "SUCCESS" + "data": + ignoreTagsAndPlaceholders: true + ignoreCase: true accounts_check_types_checkType_group_settings_example: ignoreTagsAndPlaceholders: true ignoreCase: true profiles_accounts_check_types_checkType_group_settings_example: - ignoreTagsAndPlaceholders: true - ignoreCase: true + "response": + "code": "SUCCESS" + "data": + ignoreTagsAndPlaceholders: true + ignoreCase: true tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/trademark_consistency.yaml b/spec/translation_quality/checks/trademark_consistency.yaml index a7455867..167ac38c 100644 --- a/spec/translation_quality/checks/trademark_consistency.yaml +++ b/spec/translation_quality/checks/trademark_consistency.yaml @@ -95,12 +95,15 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "TRADEMARK_CONSISTENCY" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "TRADEMARK_CONSISTENCY" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/whitespaces.yaml b/spec/translation_quality/checks/whitespaces.yaml index 77a1107d..ea131bbb 100644 --- a/spec/translation_quality/checks/whitespaces.yaml +++ b/spec/translation_quality/checks/whitespaces.yaml @@ -85,12 +85,15 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "WHITESPACES" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "WHITESPACES" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: "response": diff --git a/spec/translation_quality/dictionaries_result.yaml b/spec/translation_quality/dictionaries_result.yaml index 79b9b606..c821eb7d 100644 --- a/spec/translation_quality/dictionaries_result.yaml +++ b/spec/translation_quality/dictionaries_result.yaml @@ -43,6 +43,11 @@ x-paths: - type: object properties: checkTypeCode: &ref_1 + type: string + description: >- + [check type + code](#operation/getTranslationQualityCheckTypes) + example: LEADING_TRAILING_SPACES enum: - LEADING_TRAILING_SPACES - ORIGINAL_EQUALS_TARGET diff --git a/spec/translation_quality/examples.yaml b/spec/translation_quality/examples.yaml index c1dcfdd3..f992a1a3 100644 --- a/spec/translation_quality/examples.yaml +++ b/spec/translation_quality/examples.yaml @@ -1,5 +1,6 @@ components: examples: + dictionary_checkTypes_response_example: response: code: SUCCESS diff --git a/spec/translation_quality/tqc_check.yaml b/spec/translation_quality/tqc_check.yaml index 8d707c16..dcafa399 100644 --- a/spec/translation_quality/tqc_check.yaml +++ b/spec/translation_quality/tqc_check.yaml @@ -16,8 +16,7 @@ x-paths: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/TqcCheckRequest' + $ref: '#/components/schemas/TqcCheckRequest' example: $ref: './examples.yaml#/components/examples/tqc_check_request_body_example' @@ -76,9 +75,7 @@ components: maxItems: 100 type: array items: - - type: string - allOf: - - $ref: './tqc_common.yaml#/components/requestBodies/checkTypeCode' + $ref: './tqc_common.yaml#/components/schemas/checkTypeCodeEnum' description: '[check type codes](#operation/getTranslationQualityCheckTypes)' TqcCheckResponse: @@ -130,4 +127,4 @@ components: mistakes: type: array items: - - $ref: './tqc_common.yaml#/components/schemas/TqcCheckMistakeDTOs' + $ref: './tqc_common.yaml#/components/schemas/TqcCheckMistakeDTOs' diff --git a/spec/translation_quality/tqc_common.yaml b/spec/translation_quality/tqc_common.yaml index 348b8b94..4478a0fd 100644 --- a/spec/translation_quality/tqc_common.yaml +++ b/spec/translation_quality/tqc_common.yaml @@ -162,15 +162,6 @@ components: required: - name - checkTypeCode: - type: object - properties: - checkTypeCode: - type: string - $ref: '#/components/schemas/checkTypeCodeEnum' - description: '[check type code](#operation/getTranslationQualityCheckTypes)' - example: "LEADING_TRAILING_SPACES" - schemas: groupUidResponse: @@ -420,6 +411,10 @@ components: type: string description: check subtype code example: "" + severityLevelCode: + type: string + description: check subtype code + example: "" localeSeverityLevelsAccountCheckTypeSettingsEffective: type: object @@ -683,7 +678,7 @@ components: - $ref: 'checks/open_issues.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' ProfilesAccountCheckTypeApplySettingsDTOResponseOneOfCommon: - oneOf: + anyOf: - $ref: 'checks/emoji_consistency.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' - $ref: 'checks/spellcheck.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' - $ref: 'checks/source_in_wrong_language.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' @@ -735,6 +730,9 @@ components: checkTypeCodeEnum: + type: string + description: '[check type code](#operation/getTranslationQualityCheckTypes)' + example: "LEADING_TRAILING_SPACES" enum: - LEADING_TRAILING_SPACES - ORIGINAL_EQUALS_TARGET From db8a9f8a0b3392f66aade2ca7f419c5c341a0d9d Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Wed, 23 Oct 2024 10:35:26 +0300 Subject: [PATCH 12/21] added changes --- spec/translation_quality/accounts_result.yaml | 340 ++++++++---------- .../checks/blacklisted_terms.yaml | 15 +- .../global_capitalisation_consistency.yaml | 15 +- .../checks/leading_trailing_spaces.yaml | 15 +- .../checks/non_translatable_text.yaml | 31 +- .../checks/original_equals_target.yaml | 19 +- .../checks/plurals_repetition.yaml | 15 +- .../checks/punctuation_consistency.yaml | 15 +- .../checks/regex_check.yaml | 59 ++- .../checks/repeated_word.yaml | 15 +- .../checks/segment_completeness.yaml | 31 +- .../checks/tag_consistency.yaml | 31 +- .../checks/target_in_wrong_language.yaml | 17 +- .../checks/target_length_limit.yaml | 15 +- .../checks/target_source_consistency.yaml | 25 +- .../checks/trademark_consistency.yaml | 15 +- .../checks/whitespaces.yaml | 15 +- 17 files changed, 296 insertions(+), 392 deletions(-) diff --git a/spec/translation_quality/accounts_result.yaml b/spec/translation_quality/accounts_result.yaml index 72e0daef..ef313848 100644 --- a/spec/translation_quality/accounts_result.yaml +++ b/spec/translation_quality/accounts_result.yaml @@ -828,35 +828,26 @@ x-paths: data: totalCount: 25 items: - - response: - code: SUCCESS - data: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: LEADING_TRAILING_SPACES - subTypes: [] - localeSeverityLevels: [] - groups: [] - - response: - code: SUCCESS - data: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: ORIGINAL_EQUALS_TARGET - subTypes: [] - localeSeverityLevels: [] - groups: [] - mustHaveIdenticalTags: true - mustHaveIdenticalCapitalization: true - - response: - code: SUCCESS - data: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: WHITESPACES - subTypes: [] - localeSeverityLevels: [] - groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: LEADING_TRAILING_SPACES + subTypes: [] + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: ORIGINAL_EQUALS_TARGET + subTypes: [] + localeSeverityLevels: [] + groups: [] + mustHaveIdenticalTags: true + mustHaveIdenticalCapitalization: true + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: WHITESPACES + subTypes: [] + localeSeverityLevels: [] + groups: [] - profileUid: ce6d6b5dbc12 severityLevelCode: LOW checkTypeCode: SPELLCHECK @@ -868,32 +859,26 @@ x-paths: skipIfWordAppearsInSourceString: true skipIfWordValidInSourceLocale: false runSpellcheckForSubWords: false - - response: - code: SUCCESS - data: - profileUid: ce6d6b5dbc12 + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: TAG_CONSISTENCY + subTypes: + - checkSubTypeCode: TAG_ADDED severityLevelCode: LOW - checkTypeCode: TAG_CONSISTENCY - subTypes: - - checkSubTypeCode: TAG_ADDED - severityLevelCode: LOW - - checkSubTypeCode: TAG_DELETED - severityLevelCode: LOW - - checkSubTypeCode: TAG_ORDER_IS_CHANGED - severityLevelCode: LOW - - checkSubTypeCode: SPACES_AROUND_TAGS - severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] - - response: - code: SUCCESS - data: - profileUid: ce6d6b5dbc12 - severityLevelCode: HIGH - checkTypeCode: TARGET_LENGTH_LIMIT - subTypes: [] - localeSeverityLevels: [] - groups: [] + - checkSubTypeCode: TAG_DELETED + severityLevelCode: LOW + - checkSubTypeCode: TAG_ORDER_IS_CHANGED + severityLevelCode: LOW + - checkSubTypeCode: SPACES_AROUND_TAGS + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: HIGH + checkTypeCode: TARGET_LENGTH_LIMIT + subTypes: [] + localeSeverityLevels: [] + groups: [] - profileUid: ce6d6b5dbc12 severityLevelCode: LOW checkTypeCode: NUMBER_CONSISTENCY @@ -909,25 +894,19 @@ x-paths: - groupUid: b0dd258b05ee - groupUid: a853df2cf8ac ignoreSign: true - - response: - code: SUCCESS - data: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: REPEATED_WORD - subTypes: [] - localeSeverityLevels: [] - groups: [] - - response: - code: SUCCESS - data: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: TARGET_IN_WRONG_LANGUAGE - subTypes: [] - localeSeverityLevels: [] - groups: [] - minTextLengthLimit: 40 + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: REPEATED_WORD + subTypes: [] + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: TARGET_IN_WRONG_LANGUAGE + subTypes: [] + localeSeverityLevels: [] + groups: [] + minTextLengthLimit: 40 - profileUid: ce6d6b5dbc12 severityLevelCode: LOW checkTypeCode: SOURCE_IN_WRONG_LANGUAGE @@ -935,41 +914,35 @@ x-paths: localeSeverityLevels: [] groups: [] minTextLengthLimit: 40 - - response: - code: SUCCESS - data: - profileUid: ce6d6b5dbc12 + - profileUid: ce6d6b5dbc12 + severityLevelCode: MEDIUM + checkTypeCode: SEGMENT_COMPLETENESS + subTypes: + - checkSubTypeCode: TARGET_IS_MUCH_SHORTER_THAN_SOURCE severityLevelCode: MEDIUM - checkTypeCode: SEGMENT_COMPLETENESS - subTypes: - - checkSubTypeCode: TARGET_IS_MUCH_SHORTER_THAN_SOURCE - severityLevelCode: MEDIUM - - checkSubTypeCode: TARGET_IS_MUCH_LONGER_THAN_SOURCE - severityLevelCode: MEDIUM - - checkSubTypeCode: TARGET_IS_EMPTY - severityLevelCode: DISABLED - localeSeverityLevels: [] - groups: [] - lowerLengthThreshold: 50 - upperLengthThreshold: 250 - minLengthThreshold: 10 - - response: - code: SUCCESS - data: - profileUid: ce6d6b5dbc12 + - checkSubTypeCode: TARGET_IS_MUCH_LONGER_THAN_SOURCE severityLevelCode: MEDIUM - checkTypeCode: NON_TRANSLATABLE_TEXT - subTypes: - - checkSubTypeCode: PLACEABLE_DELETED - severityLevelCode: MEDIUM - - checkSubTypeCode: SPACES_AROUND_PLACEABLE - severityLevelCode: MEDIUM - - checkSubTypeCode: PLACEABLE_ADDED - severityLevelCode: MEDIUM - - checkSubTypeCode: PLACEABLE_FORMAT - severityLevelCode: MEDIUM - localeSeverityLevels: [] - groups: [] + - checkSubTypeCode: TARGET_IS_EMPTY + severityLevelCode: DISABLED + localeSeverityLevels: [] + groups: [] + lowerLengthThreshold: 50 + upperLengthThreshold: 250 + minLengthThreshold: 10 + - profileUid: ce6d6b5dbc12 + severityLevelCode: MEDIUM + checkTypeCode: NON_TRANSLATABLE_TEXT + subTypes: + - checkSubTypeCode: PLACEABLE_DELETED + severityLevelCode: MEDIUM + - checkSubTypeCode: SPACES_AROUND_PLACEABLE + severityLevelCode: MEDIUM + - checkSubTypeCode: PLACEABLE_ADDED + severityLevelCode: MEDIUM + - checkSubTypeCode: PLACEABLE_FORMAT + severityLevelCode: MEDIUM + localeSeverityLevels: [] + groups: [] - profileUid: ce6d6b5dbc12 severityLevelCode: LOW checkTypeCode: EMOJI_CONSISTENCY @@ -993,30 +966,24 @@ x-paths: severityLevelCode: LOW localeSeverityLevels: [] groups: [] - - response: - code: SUCCESS - data: - profileUid: ce6d6b5dbc12 + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: TARGET_SOURCE_CONSISTENCY + subTypes: + - checkSubTypeCode: SAME_TRANSLATION_DIFFERENT_SOURCES severityLevelCode: LOW - checkTypeCode: TARGET_SOURCE_CONSISTENCY - subTypes: - - checkSubTypeCode: SAME_TRANSLATION_DIFFERENT_SOURCES - severityLevelCode: LOW - - checkSubTypeCode: SAME_SOURCE_DIFFERENT_TRANSLATIONS - severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] - ignoreTagsAndPlaceholders: true - ignoreCase: true - - response: - code: SUCCESS - data: - profileUid: ce6d6b5dbc12 - severityLevelCode: MEDIUM - checkTypeCode: BLACKLISTED_TERMS - subTypes: [] - localeSeverityLevels: [] - groups: [] + - checkSubTypeCode: SAME_SOURCE_DIFFERENT_TRANSLATIONS + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] + ignoreTagsAndPlaceholders: true + ignoreCase: true + - profileUid: ce6d6b5dbc12 + severityLevelCode: MEDIUM + checkTypeCode: BLACKLISTED_TERMS + subTypes: [] + localeSeverityLevels: [] + groups: [] - profileUid: ce6d6b5dbc12 severityLevelCode: MEDIUM checkTypeCode: GLOSSARY_COMPLIANCE @@ -1026,81 +993,66 @@ x-paths: matchMethod: MATCH_BY_PERCENTAGE matchThreshold: 50 sameTermCount: true - - response: - code: SUCCESS - data: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: TRADEMARK_CONSISTENCY - subTypes: [] - localeSeverityLevels: [] - groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: TRADEMARK_CONSISTENCY + subTypes: [] + localeSeverityLevels: [] + groups: [] - profileUid: ce6d6b5dbc12 severityLevelCode: LOW checkTypeCode: GRAMMAR_CHECK subTypes: [] localeSeverityLevels: [] groups: [] - - response: - code: SUCCESS - data: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: GLOBAL_CAPITALISATION_CONSISTENCY - subTypes: [] - localeSeverityLevels: [] - groups: [] - - response: - code: SUCCESS - data: - profileUid: ce6d6b5dbc12 + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: GLOBAL_CAPITALISATION_CONSISTENCY + subTypes: [] + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: PUNCTUATION_CONSISTENCY + subTypes: [] + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: MEDIUM + checkTypeCode: PLURALS_REPETITION + subTypes: [] + localeSeverityLevels: [] + groups: [] + - profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: REGEX_CHECK + subTypes: [] + groups: [] + rules: + - ruleUid: 2d83ea74c848 severityLevelCode: LOW - checkTypeCode: PUNCTUATION_CONSISTENCY - subTypes: [] - localeSeverityLevels: [] + ruleName: ruleName1 + ruleTypeCode: FORBIDDEN + flavorCode: JAVA + originalPattern: '@mail' + translationPattern: '@gmail' + description: ruleName1 description + caseInsensitive: true + multiLine: false + warningMessage: test warning groups: [] - - response: - code: SUCCESS - data: - profileUid: ce6d6b5dbc12 + - ruleUid: ac3069e2fd30 severityLevelCode: MEDIUM - checkTypeCode: PLURALS_REPETITION - subTypes: [] - localeSeverityLevels: [] - groups: [] - - response: - code: SUCCESS - data: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: REGEX_CHECK - subTypes: [] + ruleName: ruleName2 + ruleTypeCode: MISSING + flavorCode: JAVA + originalPattern: '@/d' + translationPattern: '@/d' + description: ruleName2 description + caseInsensitive: true + multiLine: false + warningMessage: test warning groups: [] - rules: - - ruleUid: 2d83ea74c848 - severityLevelCode: LOW - ruleName: ruleName1 - ruleTypeCode: FORBIDDEN - flavorCode: JAVA - originalPattern: '@mail' - translationPattern: '@gmail' - description: ruleName1 description - caseInsensitive: true - multiLine: false - warningMessage: test warning - groups: [] - - ruleUid: ac3069e2fd30 - severityLevelCode: MEDIUM - ruleName: ruleName2 - ruleTypeCode: MISSING - flavorCode: JAVA - originalPattern: '@/d' - translationPattern: '@/d' - description: ruleName2 description - caseInsensitive: true - multiLine: false - warningMessage: test warning - groups: [] - profileUid: ce6d6b5dbc12 severityLevelCode: LOW checkTypeCode: OPEN_ISSUES diff --git a/spec/translation_quality/checks/blacklisted_terms.yaml b/spec/translation_quality/checks/blacklisted_terms.yaml index 847cf156..37497b05 100644 --- a/spec/translation_quality/checks/blacklisted_terms.yaml +++ b/spec/translation_quality/checks/blacklisted_terms.yaml @@ -103,15 +103,12 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "response": - "code": "SUCCESS" - "data": - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "MEDIUM" - "checkTypeCode": "BLACKLISTED_TERMS" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "MEDIUM" + "checkTypeCode": "BLACKLISTED_TERMS" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/global_capitalisation_consistency.yaml b/spec/translation_quality/checks/global_capitalisation_consistency.yaml index 9fa555a9..d0ef366e 100644 --- a/spec/translation_quality/checks/global_capitalisation_consistency.yaml +++ b/spec/translation_quality/checks/global_capitalisation_consistency.yaml @@ -85,15 +85,12 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "response": - "code": "SUCCESS" - "data": - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "GLOBAL_CAPITALISATION_CONSISTENCY" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "GLOBAL_CAPITALISATION_CONSISTENCY" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/leading_trailing_spaces.yaml b/spec/translation_quality/checks/leading_trailing_spaces.yaml index fca6ef91..ce22ee1f 100644 --- a/spec/translation_quality/checks/leading_trailing_spaces.yaml +++ b/spec/translation_quality/checks/leading_trailing_spaces.yaml @@ -76,15 +76,12 @@ components: examples: profiles_accounts_check_types_settings_example: - "response": - "code": "SUCCESS" - "data": - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "LEADING_TRAILING_SPACES" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "LEADING_TRAILING_SPACES" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] accounts_check_types_settings_example: "severityLevelCode": "LOW" diff --git a/spec/translation_quality/checks/non_translatable_text.yaml b/spec/translation_quality/checks/non_translatable_text.yaml index ce4174a0..3635e4d1 100644 --- a/spec/translation_quality/checks/non_translatable_text.yaml +++ b/spec/translation_quality/checks/non_translatable_text.yaml @@ -174,23 +174,20 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "response": - "code": "SUCCESS" - "data": - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "MEDIUM" - "checkTypeCode": "NON_TRANSLATABLE_TEXT" - "subTypes": - - "checkSubTypeCode": "PLACEABLE_DELETED" - "severityLevelCode": "MEDIUM" - - "checkSubTypeCode": "SPACES_AROUND_PLACEABLE" - "severityLevelCode": "MEDIUM" - - "checkSubTypeCode": "PLACEABLE_ADDED" - "severityLevelCode": "MEDIUM" - - "checkSubTypeCode": "PLACEABLE_FORMAT" - "severityLevelCode": "MEDIUM" - "localeSeverityLevels": [] - "groups": [] + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "MEDIUM" + "checkTypeCode": "NON_TRANSLATABLE_TEXT" + "subTypes": + - "checkSubTypeCode": "PLACEABLE_DELETED" + "severityLevelCode": "MEDIUM" + - "checkSubTypeCode": "SPACES_AROUND_PLACEABLE" + "severityLevelCode": "MEDIUM" + - "checkSubTypeCode": "PLACEABLE_ADDED" + "severityLevelCode": "MEDIUM" + - "checkSubTypeCode": "PLACEABLE_FORMAT" + "severityLevelCode": "MEDIUM" + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/original_equals_target.yaml b/spec/translation_quality/checks/original_equals_target.yaml index 37f7027a..0004f70e 100644 --- a/spec/translation_quality/checks/original_equals_target.yaml +++ b/spec/translation_quality/checks/original_equals_target.yaml @@ -123,17 +123,14 @@ components: "mustHaveIdenticalCapitalization": true profiles_accounts_check_types_settings_example: - "response": - "code": "SUCCESS" - "data": - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "ORIGINAL_EQUALS_TARGET" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] - "mustHaveIdenticalTags": true - "mustHaveIdenticalCapitalization": true + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "ORIGINAL_EQUALS_TARGET" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] + "mustHaveIdenticalTags": true + "mustHaveIdenticalCapitalization": true profiles_account_check_types_settings_effective_example: "profileUid": "ce6d6b5dbc12" diff --git a/spec/translation_quality/checks/plurals_repetition.yaml b/spec/translation_quality/checks/plurals_repetition.yaml index 3ee0b387..d7e0fa08 100644 --- a/spec/translation_quality/checks/plurals_repetition.yaml +++ b/spec/translation_quality/checks/plurals_repetition.yaml @@ -95,15 +95,12 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "response": - "code": "SUCCESS" - "data": - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "MEDIUM" - "checkTypeCode": "PLURALS_REPETITION" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "MEDIUM" + "checkTypeCode": "PLURALS_REPETITION" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/punctuation_consistency.yaml b/spec/translation_quality/checks/punctuation_consistency.yaml index 486d84a7..5544ea66 100644 --- a/spec/translation_quality/checks/punctuation_consistency.yaml +++ b/spec/translation_quality/checks/punctuation_consistency.yaml @@ -85,15 +85,12 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "response": - "code": "SUCCESS" - "data": - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "PUNCTUATION_CONSISTENCY" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "PUNCTUATION_CONSISTENCY" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/regex_check.yaml b/spec/translation_quality/checks/regex_check.yaml index 918ec556..0d6b7a9b 100644 --- a/spec/translation_quality/checks/regex_check.yaml +++ b/spec/translation_quality/checks/regex_check.yaml @@ -68,39 +68,36 @@ components: "checkSubTypes": [] profiles_accounts_check_types_settings_example: - "response": - "code": "SUCCESS" - "data": - "profileUid": "ce6d6b5dbc12" + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "REGEX_CHECK" + "subTypes": [] + "groups": [] + "rules": + - "ruleUid": "2d83ea74c848" "severityLevelCode": "LOW" - "checkTypeCode": "REGEX_CHECK" - "subTypes": [] + "ruleName": "ruleName1" + "ruleTypeCode": "FORBIDDEN" + "flavorCode": "JAVA" + "originalPattern": "@mail" + "translationPattern": "@gmail" + "description": "ruleName1 description" + "caseInsensitive": true + "multiLine": false + "warningMessage": "test warning" + "groups": [] + - "ruleUid": "ac3069e2fd30" + "severityLevelCode": "MEDIUM" + "ruleName": "ruleName2" + "ruleTypeCode": "MISSING" + "flavorCode": "JAVA" + "originalPattern": "@/d" + "translationPattern": "@/d" + "description": "ruleName2 description" + "caseInsensitive": true + "multiLine": false + "warningMessage": "test warning" "groups": [] - "rules": - - "ruleUid": "2d83ea74c848" - "severityLevelCode": "LOW" - "ruleName": "ruleName1" - "ruleTypeCode": "FORBIDDEN" - "flavorCode": "JAVA" - "originalPattern": "@mail" - "translationPattern": "@gmail" - "description": "ruleName1 description" - "caseInsensitive": true - "multiLine": false - "warningMessage": "test warning" - "groups": [] - - "ruleUid": "ac3069e2fd30" - "severityLevelCode": "MEDIUM" - "ruleName": "ruleName2" - "ruleTypeCode": "MISSING" - "flavorCode": "JAVA" - "originalPattern": "@/d" - "translationPattern": "@/d" - "description": "ruleName2 description" - "caseInsensitive": true - "multiLine": false - "warningMessage": "test warning" - "groups": [] projects_check_types_settings_example: "severityLevelCode": "LOW" diff --git a/spec/translation_quality/checks/repeated_word.yaml b/spec/translation_quality/checks/repeated_word.yaml index b113c225..eb09143f 100644 --- a/spec/translation_quality/checks/repeated_word.yaml +++ b/spec/translation_quality/checks/repeated_word.yaml @@ -90,15 +90,12 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "response": - "code": "SUCCESS" - "data": - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "REPEATED_WORD" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "REPEATED_WORD" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: diff --git a/spec/translation_quality/checks/segment_completeness.yaml b/spec/translation_quality/checks/segment_completeness.yaml index 1a216eb8..34bbe706 100644 --- a/spec/translation_quality/checks/segment_completeness.yaml +++ b/spec/translation_quality/checks/segment_completeness.yaml @@ -180,24 +180,21 @@ components: "minLengthThreshold": 10 profiles_accounts_check_types_settings_example: - "response": - "code": "SUCCESS" - "data": - "profileUid": "ce6d6b5dbc12" + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "MEDIUM" + "checkTypeCode": "SEGMENT_COMPLETENESS" + "subTypes": + - "checkSubTypeCode": "TARGET_IS_MUCH_SHORTER_THAN_SOURCE" "severityLevelCode": "MEDIUM" - "checkTypeCode": "SEGMENT_COMPLETENESS" - "subTypes": - - "checkSubTypeCode": "TARGET_IS_MUCH_SHORTER_THAN_SOURCE" - "severityLevelCode": "MEDIUM" - - "checkSubTypeCode": "TARGET_IS_MUCH_LONGER_THAN_SOURCE" - "severityLevelCode": "MEDIUM" - - "checkSubTypeCode": "TARGET_IS_EMPTY" - "severityLevelCode": "DISABLED" - "localeSeverityLevels": [] - "groups": [] - "lowerLengthThreshold": 50 - "upperLengthThreshold": 250 - "minLengthThreshold": 10 + - "checkSubTypeCode": "TARGET_IS_MUCH_LONGER_THAN_SOURCE" + "severityLevelCode": "MEDIUM" + - "checkSubTypeCode": "TARGET_IS_EMPTY" + "severityLevelCode": "DISABLED" + "localeSeverityLevels": [] + "groups": [] + "lowerLengthThreshold": 50 + "upperLengthThreshold": 250 + "minLengthThreshold": 10 accounts_check_types_checkType_settings_example: lowerLengthThreshold: 10 diff --git a/spec/translation_quality/checks/tag_consistency.yaml b/spec/translation_quality/checks/tag_consistency.yaml index e32b55f9..b90d7c16 100644 --- a/spec/translation_quality/checks/tag_consistency.yaml +++ b/spec/translation_quality/checks/tag_consistency.yaml @@ -173,23 +173,20 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "response": - "code": "SUCCESS" - "data": - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "TAG_CONSISTENCY" - "subTypes": - - "checkSubTypeCode": "TAG_ADDED" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "TAG_DELETED" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "TAG_ORDER_IS_CHANGED" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "SPACES_AROUND_TAGS" - "severityLevelCode": "LOW" - "localeSeverityLevels": [] - "groups": [] + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "TAG_CONSISTENCY" + "subTypes": + - "checkSubTypeCode": "TAG_ADDED" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "TAG_DELETED" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "TAG_ORDER_IS_CHANGED" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "SPACES_AROUND_TAGS" + "severityLevelCode": "LOW" + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/target_in_wrong_language.yaml b/spec/translation_quality/checks/target_in_wrong_language.yaml index a9c4b427..3718fb25 100644 --- a/spec/translation_quality/checks/target_in_wrong_language.yaml +++ b/spec/translation_quality/checks/target_in_wrong_language.yaml @@ -114,16 +114,13 @@ components: "minTextLengthLimit": 40 profiles_accounts_check_types_settings_example: - "response": - "code": "SUCCESS" - "data": - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "TARGET_IN_WRONG_LANGUAGE" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] - "minTextLengthLimit": 40 + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "TARGET_IN_WRONG_LANGUAGE" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] + "minTextLengthLimit": 40 accounts_check_types_checkType_settings_example: minTextLengthLimit: 15 diff --git a/spec/translation_quality/checks/target_length_limit.yaml b/spec/translation_quality/checks/target_length_limit.yaml index ce723f41..d8a0862e 100644 --- a/spec/translation_quality/checks/target_length_limit.yaml +++ b/spec/translation_quality/checks/target_length_limit.yaml @@ -85,15 +85,12 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "response": - "code": "SUCCESS" - "data": - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "HIGH" - "checkTypeCode": "TARGET_LENGTH_LIMIT" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "HIGH" + "checkTypeCode": "TARGET_LENGTH_LIMIT" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/target_source_consistency.yaml b/spec/translation_quality/checks/target_source_consistency.yaml index 9f3b1b92..e4da6980 100644 --- a/spec/translation_quality/checks/target_source_consistency.yaml +++ b/spec/translation_quality/checks/target_source_consistency.yaml @@ -189,21 +189,18 @@ components: "ignoreCase": true profiles_accounts_check_types_settings_example: - "response": - "code": "SUCCESS" - "data": - "profileUid": "ce6d6b5dbc12" + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "TARGET_SOURCE_CONSISTENCY" + "subTypes": + - "checkSubTypeCode": "SAME_TRANSLATION_DIFFERENT_SOURCES" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "SAME_SOURCE_DIFFERENT_TRANSLATIONS" "severityLevelCode": "LOW" - "checkTypeCode": "TARGET_SOURCE_CONSISTENCY" - "subTypes": - - "checkSubTypeCode": "SAME_TRANSLATION_DIFFERENT_SOURCES" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "SAME_SOURCE_DIFFERENT_TRANSLATIONS" - "severityLevelCode": "LOW" - "localeSeverityLevels": [] - "groups": [] - "ignoreTagsAndPlaceholders": true - "ignoreCase": true + "localeSeverityLevels": [] + "groups": [] + "ignoreTagsAndPlaceholders": true + "ignoreCase": true accounts_check_types_checkType_settings_example: ignoreTagsAndPlaceholders: true diff --git a/spec/translation_quality/checks/trademark_consistency.yaml b/spec/translation_quality/checks/trademark_consistency.yaml index 167ac38c..a7455867 100644 --- a/spec/translation_quality/checks/trademark_consistency.yaml +++ b/spec/translation_quality/checks/trademark_consistency.yaml @@ -95,15 +95,12 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "response": - "code": "SUCCESS" - "data": - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "TRADEMARK_CONSISTENCY" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "TRADEMARK_CONSISTENCY" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/whitespaces.yaml b/spec/translation_quality/checks/whitespaces.yaml index ea131bbb..77a1107d 100644 --- a/spec/translation_quality/checks/whitespaces.yaml +++ b/spec/translation_quality/checks/whitespaces.yaml @@ -85,15 +85,12 @@ components: "groups": [] profiles_accounts_check_types_settings_example: - "response": - "code": "SUCCESS" - "data": - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "WHITESPACES" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "WHITESPACES" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] tqc_check_response_example: "response": From b983a7ef9e41bde2eb377a04d01c86c5802f0d5f Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Wed, 23 Oct 2024 11:17:43 +0300 Subject: [PATCH 13/21] added changes --- .../account_settings_result.yaml | 3 + spec/translation_quality/accounts_result.yaml | 79 +-- .../check_type_severity_level_result.yaml | 3 + .../checks/blacklisted_terms.yaml | 1 - .../checks/leading_trailing_spaces.yaml | 2 + .../checks/tag_consistency.yaml | 1 - .../dictionaries_result.yaml | 3 + spec/translation_quality/examples.yaml | 138 ++--- .../regex_check_settings_result.yaml | 3 + spec/translation_quality/tqc_check.yaml | 1 + .../translation_quality/tqc_check_result.yaml | 576 +----------------- spec/translation_quality/tqc_common.yaml | 27 +- 12 files changed, 130 insertions(+), 707 deletions(-) diff --git a/spec/translation_quality/account_settings_result.yaml b/spec/translation_quality/account_settings_result.yaml index 9f4dc369..26d73274 100644 --- a/spec/translation_quality/account_settings_result.yaml +++ b/spec/translation_quality/account_settings_result.yaml @@ -87,6 +87,9 @@ x-paths: type: object properties: severityLevelCode: &ref_1 + type: string + description: severity level code + example: MEDIUM enum: - DISABLED - LOW diff --git a/spec/translation_quality/accounts_result.yaml b/spec/translation_quality/accounts_result.yaml index ef313848..9b0e5231 100644 --- a/spec/translation_quality/accounts_result.yaml +++ b/spec/translation_quality/accounts_result.yaml @@ -74,6 +74,9 @@ x-paths: type: object properties: severityLevelCode: &ref_0 + type: string + description: severity level code + example: MEDIUM enum: - DISABLED - LOW @@ -2143,7 +2146,7 @@ x-paths: parameters: - *ref_8 - *ref_9 - - &ref_29 + - &ref_28 name: checkTypeCode in: path required: true @@ -2167,7 +2170,7 @@ x-paths: application/json: schema: oneOf: - - &ref_30 + - &ref_29 title: EMOJI_CONSISTENCY allOf: - *ref_16 @@ -2185,7 +2188,7 @@ x-paths: example: it-IT required: - targetLocaleId - - &ref_31 + - &ref_30 type: object required: - skipIfWordInUserDictionary @@ -2197,19 +2200,19 @@ x-paths: allOf: - *ref_18 - *ref_19 - - &ref_32 + - &ref_31 type: object required: - minTextLengthLimit - title: TARGET_IN_WRONG_LANGUAGE allOf: - - &ref_33 + - &ref_32 type: object required: - minTextLengthLimit - *ref_19 - *ref_20 - - &ref_34 + - &ref_33 title: NUMBER_CONSISTENCY allOf: - *ref_21 @@ -2217,16 +2220,15 @@ x-paths: allOf: - *ref_22 - *ref_19 - - &ref_35 + - &ref_34 type: object required: - ignoreTagsAndPlaceholders - ignoreCase - - &ref_36 + - &ref_35 title: GLOSSARY_COMPLIANCE allOf: - - &ref_28 - allOf: + - allOf: - *ref_23 - *ref_24 - type: object @@ -2237,7 +2239,7 @@ x-paths: allOf: - *ref_25 - *ref_19 - - &ref_37 + - &ref_36 type: object required: - mustHaveIdenticalTags @@ -2246,7 +2248,7 @@ x-paths: allOf: - *ref_26 - *ref_19 - - &ref_38 + - &ref_37 title: OPEN_ISSUES allOf: - *ref_27 @@ -2267,38 +2269,11 @@ x-paths: - *ref_10 - type: object properties: - data: &ref_39 - anyOf: + data: &ref_38 + oneOf: - title: EMOJI_CONSISTENCY allOf: - *ref_16 - - title: SPELLCHECK - allOf: - - *ref_17 - - title: SOURCE_IN_WRONG_LANGUAGE - allOf: - - *ref_18 - - title: TARGET_IN_WRONG_LANGUAGE - allOf: - - *ref_20 - - title: NUMBER_CONSISTENCY - allOf: - - *ref_21 - - title: TARGET_SOURCE_CONSISTENCY - allOf: - - *ref_22 - - title: GLOSSARY_COMPLIANCE - allOf: - - *ref_28 - - title: ORIGINAL_EQUALS_TARGET - allOf: - - *ref_25 - - title: SEGMENT_COMPLETENESS - allOf: - - *ref_26 - - title: OPEN_ISSUES - allOf: - - *ref_27 examples: EMOJI_CONSISTENCY: value: @@ -2391,7 +2366,7 @@ x-paths: parameters: - *ref_8 - *ref_9 - - *ref_29 + - *ref_28 - name: groupUid in: path schema: @@ -2405,39 +2380,39 @@ x-paths: application/json: schema: oneOf: - - *ref_30 + - *ref_29 - title: SPELLCHECK allOf: - *ref_17 - *ref_19 - - *ref_31 + - *ref_30 - title: SOURCE_IN_WRONG_LANGUAGE allOf: - *ref_18 - *ref_19 - - *ref_32 + - *ref_31 - title: TARGET_IN_WRONG_LANGUAGE allOf: - - *ref_33 + - *ref_32 - *ref_19 - *ref_20 - - *ref_34 + - *ref_33 - title: TARGET_SOURCE_CONSISTENCY allOf: - *ref_22 - *ref_19 - - *ref_35 - - *ref_36 + - *ref_34 + - *ref_35 - title: ORIGINAL_EQUALS_TARGET allOf: - *ref_25 - *ref_19 - - *ref_37 + - *ref_36 - title: SEGMENT_COMPLETENESS allOf: - *ref_26 - *ref_19 - - *ref_38 + - *ref_37 responses: '200': description: OK @@ -2451,7 +2426,7 @@ x-paths: - *ref_10 - type: object properties: - data: *ref_39 + data: *ref_38 examples: EMOJI_CONSISTENCY: value: diff --git a/spec/translation_quality/check_type_severity_level_result.yaml b/spec/translation_quality/check_type_severity_level_result.yaml index fca2e17c..a067669c 100644 --- a/spec/translation_quality/check_type_severity_level_result.yaml +++ b/spec/translation_quality/check_type_severity_level_result.yaml @@ -101,6 +101,9 @@ x-paths: type: object properties: severityLevelCode: + type: string + description: severity level code + example: MEDIUM enum: - DISABLED - LOW diff --git a/spec/translation_quality/checks/blacklisted_terms.yaml b/spec/translation_quality/checks/blacklisted_terms.yaml index 37497b05..23a24be7 100644 --- a/spec/translation_quality/checks/blacklisted_terms.yaml +++ b/spec/translation_quality/checks/blacklisted_terms.yaml @@ -52,7 +52,6 @@ components: example: "BLACKLISTED_TERMS" details: type: object - nullable: true properties: blacklistedTermUid: type: string diff --git a/spec/translation_quality/checks/leading_trailing_spaces.yaml b/spec/translation_quality/checks/leading_trailing_spaces.yaml index ce22ee1f..a8e179dc 100644 --- a/spec/translation_quality/checks/leading_trailing_spaces.yaml +++ b/spec/translation_quality/checks/leading_trailing_spaces.yaml @@ -61,6 +61,8 @@ components: properties: checkTypeCode: type: string + enum: + - LEADING_TRAILING_SPACES description: check type code example: "LEADING_TRAILING_SPACES" details: diff --git a/spec/translation_quality/checks/tag_consistency.yaml b/spec/translation_quality/checks/tag_consistency.yaml index b90d7c16..6555ab57 100644 --- a/spec/translation_quality/checks/tag_consistency.yaml +++ b/spec/translation_quality/checks/tag_consistency.yaml @@ -102,7 +102,6 @@ components: example: "TAG_CONSISTENCY" details: type: object - nullable: true properties: tag: type: string diff --git a/spec/translation_quality/dictionaries_result.yaml b/spec/translation_quality/dictionaries_result.yaml index c821eb7d..9be5373d 100644 --- a/spec/translation_quality/dictionaries_result.yaml +++ b/spec/translation_quality/dictionaries_result.yaml @@ -606,6 +606,9 @@ x-paths: - type: object properties: severityLevelCode: + type: string + description: severity level code + example: MEDIUM enum: - DISABLED - LOW diff --git a/spec/translation_quality/examples.yaml b/spec/translation_quality/examples.yaml index f992a1a3..ca080d5a 100644 --- a/spec/translation_quality/examples.yaml +++ b/spec/translation_quality/examples.yaml @@ -473,72 +473,72 @@ components: BLACKLISTED_TERMS: value: $ref: 'checks/blacklisted_terms.yaml#/components/examples/tqc_check_response_example' - EMOJI_CONSISTENCY: - value: - $ref: 'checks/emoji_consistency.yaml#/components/examples/tqc_check_response_example' - GLOBAL_CAPITALISATION_CONSISTENCY: - value: - $ref: 'checks/global_capitalisation_consistency.yaml#/components/examples/tqc_check_response_example' - GLOSSARY_COMPLIANCE: - value: - $ref: 'checks/glossary_compliance.yaml#/components/examples/tqc_check_response_example' - INSERTABLE_CONSISTENCY: - value: - $ref: 'checks/insertable_consistency.yaml#/components/examples/tqc_check_response_example' - LEADING_TRAILING_SPACES: - value: - $ref: 'checks/leading_trailing_spaces.yaml#/components/examples/tqc_check_response_example' - NON_TRANSLATABLE_TEXT: - value: - $ref: 'checks/non_translatable_text.yaml#/components/examples/tqc_check_response_example' - NUMBER_CONSISTENCY: - value: - $ref: 'checks/number_consistency.yaml#/components/examples/tqc_check_response_example' - REPEATED_WORD: - value: - $ref: 'checks/repeated_word.yaml#/components/examples/tqc_check_response_example' - SEGMENT_COMPLETENESS: - value: - $ref: 'checks/segment_completeness.yaml#/components/examples/tqc_check_response_example' - SOURCE_IN_WRONG_LANGUAGE: - value: - $ref: 'checks/source_in_wrong_language.yaml#/components/examples/tqc_check_response_example' - SPELLCHECK: - value: - $ref: 'checks/spellcheck.yaml#/components/examples/tqc_check_response_example' - TAG_CONSISTENCY: - value: - $ref: 'checks/tag_consistency.yaml#/components/examples/tqc_check_response_example' - TARGET_LENGTH_LIMIT: - value: - $ref: 'checks/target_length_limit.yaml#/components/examples/tqc_check_response_example' - TARGET_IN_WRONG_LANGUAGE: - value: - $ref: 'checks/target_in_wrong_language.yaml#/components/examples/tqc_check_response_example' - TARGET_SOURCE_CONSISTENCY: - value: - $ref: 'checks/target_source_consistency.yaml#/components/examples/tqc_check_response_example' - TRADEMARK_CONSISTENCY: - value: - $ref: 'checks/trademark_consistency.yaml#/components/examples/tqc_check_response_example' - WHITESPACES: - value: - $ref: 'checks/whitespaces.yaml#/components/examples/tqc_check_response_example' - GRAMMAR_CHECK: - value: - $ref: 'checks/grammar_check.yaml#/components/examples/tqc_check_response_example' - ORIGINAL_EQUALS_TARGET: - value: - $ref: 'checks/original_equals_target.yaml#/components/examples/tqc_check_response_example' - PUNCTUATION_CONSISTENCY: - value: - $ref: 'checks/punctuation_consistency.yaml#/components/examples/tqc_check_response_example' - PLURALS_REPETITION: - value: - $ref: 'checks/plurals_repetition.yaml#/components/examples/tqc_check_response_example' - REGEX_CHECK: - value: - $ref: 'checks/regex_check.yaml#/components/examples/tqc_check_response_example' - OPEN_ISSUES: - value: - $ref: 'checks/open_issues.yaml#/components/examples/tqc_check_response_example' +# EMOJI_CONSISTENCY: +# value: +# $ref: 'checks/emoji_consistency.yaml#/components/examples/tqc_check_response_example' +# GLOBAL_CAPITALISATION_CONSISTENCY: +# value: +# $ref: 'checks/global_capitalisation_consistency.yaml#/components/examples/tqc_check_response_example' +# GLOSSARY_COMPLIANCE: +# value: +# $ref: 'checks/glossary_compliance.yaml#/components/examples/tqc_check_response_example' +# INSERTABLE_CONSISTENCY: +# value: +# $ref: 'checks/insertable_consistency.yaml#/components/examples/tqc_check_response_example' +# LEADING_TRAILING_SPACES: +# value: +# $ref: 'checks/leading_trailing_spaces.yaml#/components/examples/tqc_check_response_example' +# NON_TRANSLATABLE_TEXT: +# value: +# $ref: 'checks/non_translatable_text.yaml#/components/examples/tqc_check_response_example' +# NUMBER_CONSISTENCY: +# value: +# $ref: 'checks/number_consistency.yaml#/components/examples/tqc_check_response_example' +# REPEATED_WORD: +# value: +# $ref: 'checks/repeated_word.yaml#/components/examples/tqc_check_response_example' +# SEGMENT_COMPLETENESS: +# value: +# $ref: 'checks/segment_completeness.yaml#/components/examples/tqc_check_response_example' +# SOURCE_IN_WRONG_LANGUAGE: +# value: +# $ref: 'checks/source_in_wrong_language.yaml#/components/examples/tqc_check_response_example' +# SPELLCHECK: +# value: +# $ref: 'checks/spellcheck.yaml#/components/examples/tqc_check_response_example' +# TAG_CONSISTENCY: +# value: +# $ref: 'checks/tag_consistency.yaml#/components/examples/tqc_check_response_example' +# TARGET_LENGTH_LIMIT: +# value: +# $ref: 'checks/target_length_limit.yaml#/components/examples/tqc_check_response_example' +# TARGET_IN_WRONG_LANGUAGE: +# value: +# $ref: 'checks/target_in_wrong_language.yaml#/components/examples/tqc_check_response_example' +# TARGET_SOURCE_CONSISTENCY: +# value: +# $ref: 'checks/target_source_consistency.yaml#/components/examples/tqc_check_response_example' +# TRADEMARK_CONSISTENCY: +# value: +# $ref: 'checks/trademark_consistency.yaml#/components/examples/tqc_check_response_example' +# WHITESPACES: +# value: +# $ref: 'checks/whitespaces.yaml#/components/examples/tqc_check_response_example' +# GRAMMAR_CHECK: +# value: +# $ref: 'checks/grammar_check.yaml#/components/examples/tqc_check_response_example' +# ORIGINAL_EQUALS_TARGET: +# value: +# $ref: 'checks/original_equals_target.yaml#/components/examples/tqc_check_response_example' +# PUNCTUATION_CONSISTENCY: +# value: +# $ref: 'checks/punctuation_consistency.yaml#/components/examples/tqc_check_response_example' +# PLURALS_REPETITION: +# value: +# $ref: 'checks/plurals_repetition.yaml#/components/examples/tqc_check_response_example' +# REGEX_CHECK: +# value: +# $ref: 'checks/regex_check.yaml#/components/examples/tqc_check_response_example' +# OPEN_ISSUES: +# value: +# $ref: 'checks/open_issues.yaml#/components/examples/tqc_check_response_example' diff --git a/spec/translation_quality/regex_check_settings_result.yaml b/spec/translation_quality/regex_check_settings_result.yaml index c9e9cd01..09b170ec 100644 --- a/spec/translation_quality/regex_check_settings_result.yaml +++ b/spec/translation_quality/regex_check_settings_result.yaml @@ -160,6 +160,9 @@ x-paths: type: string type: array severityLevelCode: + type: string + description: severity level code + example: MEDIUM enum: - DISABLED - LOW diff --git a/spec/translation_quality/tqc_check.yaml b/spec/translation_quality/tqc_check.yaml index dcafa399..7082c715 100644 --- a/spec/translation_quality/tqc_check.yaml +++ b/spec/translation_quality/tqc_check.yaml @@ -127,4 +127,5 @@ components: mistakes: type: array items: + type: object $ref: './tqc_common.yaml#/components/schemas/TqcCheckMistakeDTOs' diff --git a/spec/translation_quality/tqc_check_result.yaml b/spec/translation_quality/tqc_check_result.yaml index 62f9d2fd..6ec49b85 100644 --- a/spec/translation_quality/tqc_check_result.yaml +++ b/spec/translation_quality/tqc_check_result.yaml @@ -234,6 +234,9 @@ x-paths: type: object properties: severityLevelCode: &ref_2 + type: string + description: severity level code + example: MEDIUM enum: - DISABLED - LOW @@ -263,7 +266,6 @@ x-paths: example: BLACKLISTED_TERMS details: type: object - nullable: true properties: blacklistedTermUid: type: string @@ -566,6 +568,8 @@ x-paths: properties: checkTypeCode: type: string + enum: + - LEADING_TRAILING_SPACES description: check type code example: LEADING_TRAILING_SPACES details: @@ -833,7 +837,6 @@ x-paths: example: TAG_CONSISTENCY details: type: object - nullable: true properties: tag: type: string @@ -1220,575 +1223,6 @@ x-paths: alternatives: [] notes: '' positionTypeCode: TARGET - EMOJI_CONSISTENCY: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Bonjour 😀 - translation: Hello - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: EMOJI_CONSISTENCY - severityLevelCode: LOW - positions: - - from: 14 - to: 16 - details: - emoji: 😀 - type: EMOJI_DELETED - positionTypeCode: SOURCE - GLOBAL_CAPITALISATION_CONSISTENCY: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: ATTENTION - translation: WARNINg - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: GLOBAL_CAPITALISATION_CONSISTENCY - severityLevelCode: LOW - positions: - - from: 0 - to: 7 - details: null - positionTypeCode: TARGET - GLOSSARY_COMPLIANCE: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: resize - translation: поменять - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: GLOSSARY_COMPLIANCE - severityLevelCode: MEDIUM - positions: - - from: 0 - to: 6 - details: - glossaryTerm: - termUid: cdd443b9-814f-442c-9ba6-4d97e0afce74 - translation: - localeId: ru-RU - translatedTerm: изменить размер - notes: '' - translatorUserUid: null - lockTranslation: false - submittedForTranslation: false - createdDate: '2018-11-16T16:06:53Z' - modifiedDate: '2018-11-16T16:06:53Z' - termText: resize - caseSensitive: false - exactMatch: false - definition: '' - variations: '' - synonyms: '' - antonyms: '' - seo: false - doNotTranslate: false - notes: '' - partOfSpeechCode: UNSPECIFIED - createdByUserUid: f64d50d91867 - createdDate: '2018-11-16T16:06:05Z' - modifiedDate: '2018-11-16T16:06:05Z' - positionTypeCode: SOURCE - INSERTABLE_CONSISTENCY: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Bonjour
- translation: Hello - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: INSERTABLE_CONSISTENCY - severityLevelCode: LOW - positions: - - from: 13 - to: 17 - details: - insertable:
- insertableType: BR_TAG - type: INSERTABLE_DELETED - positionTypeCode: SOURCE - LEADING_TRAILING_SPACES: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Bonjour - translation: ' Hello ' - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: LEADING_TRAILING_SPACES - severityLevelCode: LOW - positions: - - from: 0 - to: 1 - - from: 6 - to: 7 - details: null - positionTypeCode: TARGET - NON_TRANSLATABLE_TEXT: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Bonjour {0} - translation: Hello - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: NON_TRANSLATABLE_TEXT - severityLevelCode: MEDIUM - positions: - - from: 6 - to: 9 - details: - placeable: '{0}' - type: PLACEABLE_DELETED - positionTypeCode: SOURCE - NUMBER_CONSISTENCY: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Bonjour 1000 - translation: Hello 20 - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: NUMBER_CONSISTENCY - severityLevelCode: LOW - positions: - - from: 6 - to: 10 - details: - type: NUMBER_DELETED - number: '1000' - positionTypeCode: SOURCE - - checkTypeCode: NUMBER_CONSISTENCY - severityLevelCode: LOW - positions: - from: 5 - to: 7 - details: - type: NUMBER_ADDED - number: 20 - positionTypeCode: TARGET - REPEATED_WORD: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Bonjour - translation: Hello Hello - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: REPEATED_WORD - severityLevelCode: LOW - positions: - from: 5 - to: 9 - details: - word: Hello - positionTypeCode: TARGET - SEGMENT_COMPLETENESS: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Le chien a mangé mes devoirs. - translation: The dog ate - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: SEGMENT_COMPLETENESS - severityLevelCode: MEDIUM - positions: - from: 0 - to: 10 - details: - type: TARGET_IS_MUCH_SHORTER_THAN_SOURCE - positionTypeCode: TARGET - SOURCE_IN_WRONG_LANGUAGE: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Der Hund hat meine Hausaufgaben gegessen. - translation: The dog ate my homework. - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: SOURCE_IN_WRONG_LANGUAGE - severityLevelCode: LOW - positions: - from: 0 - to: 63 - details: null - positionTypeCode: SOURCE - SPELLCHECK: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Le chien a mangé mes devoirs. - translation: The dog ate my homewrk. - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: SPELLCHECK - severityLevelCode: MEDIUM - positions: - from: 0 - to: 5 - details: - word: homewrk - suggestions: - - homework - positionTypeCode: TARGET - TAG_CONSISTENCY: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString:

Bonjour

- translation:

Hello - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: TAG_CONSISTENCY - severityLevelCode: MEDIUM - positions: - from: 8 - to: 12 - details: - tag:

- type: TAG_DELETED - positionTypeCode: SOURCE - TARGET_LENGTH_LIMIT: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Bonjour - translation: Hello - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: TARGET_LENGTH_LIMIT - severityLevelCode: HIGH - positions: - from: 0 - to: 4 - details: null - positionTypeCode: TARGET - TARGET_IN_WRONG_LANGUAGE: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Le chien a mangé mes devoirs. - translation: Der Hund hat meine Hausaufgaben gegessen. - hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: TARGET_IN_WRONG_LANGUAGE - severityLevelCode: LOW - positions: - from: 0 - to: 64 - details: null - positionTypeCode: TARGET - TARGET_SOURCE_CONSISTENCY: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Le chien a mangé mes devoirs. - translation: The dog have ate my homework. - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: TARGET_SOURCE_CONSISTENCY - severityLevelCode: LOW - positions: - from: 0 - to: 27 - details: - type: SAME_SOURCE_DIFFERENT_TRANSLATIONS - originalString: Le chien a mangé mes devoirs. - translation: The dog have ate my homework. - positionTypeCode: TARGET - TRADEMARK_CONSISTENCY: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Bonjour © - translation: Hello - hashcode: 9091152182c69d9b72069ac1290fe2345 - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: TRADEMARK_CONSISTENCY - severityLevelCode: LOW - positions: - from: 6 - to: 7 - details: - trademarkTypeCode: COPYRIGHT - positionTypeCode: SOURCE - WHITESPACES: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Bonjour 100 - translation: Hello 100 - hashcode: 1091152182c69d9b72069ac1290fe23999 - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: WHITESPACES - severityLevelCode: LOW - positions: - from: 4 - to: 6 - details: null - positionTypeCode: TARGET - GRAMMAR_CHECK: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Le chien a mangé mes devoirs. - translation: The dog have ate my homework. - hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: GRAMMAR_CHECK - severityLevelCode: LOW - positions: - from: 9 - to: 13 - details: - text: ate - message: Possible agreement error - description: 'Agreement: ''have'' + past/present tense' - mistakeTypeCode: Grammar - suggestions: - - eaten - positionTypeCode: TARGET - ORIGINAL_EQUALS_TARGET: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: hello - translation: hello - hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: ORIGINAL_EQUALS_TARGET - severityLevelCode: LOW - positions: - from: 0 - to: 5 - details: - types: - - IDENTICAL_CAPITALIZATION - - IDENTICAL_TAGS - positionTypeCode: TARGET - PUNCTUATION_CONSISTENCY: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: Hello! - translation: Привет. Как дела? - hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: PUNCTUATION_CONSISTENCY - severityLevelCode: LOW - positions: - from: 5 - to: 6 - details: - punctuationMark: '!' - type: PUNCTUATION_MARK_DELETED - punctuationMarkType: TERMINAL - positionTypeCode: SOURCE - PLURALS_REPETITION: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: 2 rows - translation: 2 rows - hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 - stringUid: null - pluralFormGroupUid: a0b1acda22fc97da9c2b9ae5f3b25888 - pluralForm: MANY - mistakes: - - checkTypeCode: PLURALS_REPETITION - severityLevelCode: MEDIUM - positions: - from: 0 - to: 5 - details: - pluralFormGroupUid: a0b1acda22fc97da9c2b9ae5f3b25888 - repeatedPluralForms: - - MANY - - FEW - positionTypeCode: TARGET - REGEX_CHECK: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: test@gmail - translation: test@mail - hashcode: 7191152182c69d9b72069ac1290fe24b - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: REGEX_CHECK - severityLevelCode: LOW - positions: - - from: 5 - to: 10 - details: - ruleUid: 30606c59ee92 - severityLevelCode: LOW - ruleName: name1 - ruleTypeCode: FORBIDDEN - flavorCode: JAVA - originalPattern: '@f1' - translationPattern: '@f1' - description: name1 description - caseInsensitive: true - multiLine: false - warningMessage: test warning - positionTypeCode: TARGET - ignored: false - OPEN_ISSUES: - value: - response: - code: SUCCESS - data: - results: - - string: - originalString: hello - translation: hello - hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 - stringUid: null - pluralFormGroupUid: null - pluralForm: null - mistakes: - - checkTypeCode: OPEN_ISSUES - severityLevelCode: LOW - positions: - from: 0 - to: 5 - details: - sourceIssuesCount: 5 - translationIssuesCount: 3 - positionTypeCode: TARGET '400': description: Provided request parameters are invalid. content: diff --git a/spec/translation_quality/tqc_common.yaml b/spec/translation_quality/tqc_common.yaml index 4478a0fd..2159c988 100644 --- a/spec/translation_quality/tqc_common.yaml +++ b/spec/translation_quality/tqc_common.yaml @@ -359,10 +359,8 @@ components: type: object properties: severityLevelCode: - type: string $ref: '#/components/schemas/severityLevelCodeEnum' - description: severity level code - example: "MEDIUM" + severityLevelCodeResponse1: type: object @@ -678,17 +676,17 @@ components: - $ref: 'checks/open_issues.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' ProfilesAccountCheckTypeApplySettingsDTOResponseOneOfCommon: - anyOf: + oneOf: - $ref: 'checks/emoji_consistency.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' - - $ref: 'checks/spellcheck.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' - - $ref: 'checks/source_in_wrong_language.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' - - $ref: 'checks/target_in_wrong_language.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' - - $ref: 'checks/number_consistency.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' - - $ref: 'checks/target_source_consistency.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' - - $ref: 'checks/glossary_compliance.yaml#/components/schemas/ProfilesAccountCheckTypeApplySettingsDTOResponse' - - $ref: 'checks/original_equals_target.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' - - $ref: 'checks/segment_completeness.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' - - $ref: 'checks/open_issues.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' +# - $ref: 'checks/spellcheck.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' +# - $ref: 'checks/source_in_wrong_language.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' +# - $ref: 'checks/target_in_wrong_language.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' +# - $ref: 'checks/number_consistency.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' +# - $ref: 'checks/target_source_consistency.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' +# - $ref: 'checks/glossary_compliance.yaml#/components/schemas/ProfilesAccountCheckTypeApplySettingsDTOResponse' +# - $ref: 'checks/original_equals_target.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' +# - $ref: 'checks/segment_completeness.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' +# - $ref: 'checks/open_issues.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' AccountCheckTypeApplySettingsRequestOneOf: $ref: '#/components/schemas/AccountCheckTypeApplySettingsRequestOneOfCommon' @@ -787,6 +785,9 @@ components: - SAME_TRANSLATION_DIFFERENT_SOURCES severityLevelCodeEnum: + type: string + description: severity level code + example: "MEDIUM" enum: - DISABLED - LOW From d29b1554430f80c6f5b526ea80a33bb38d34b9ec Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Wed, 23 Oct 2024 11:28:24 +0300 Subject: [PATCH 14/21] added changes --- spec/translation_quality/checks/emoji_consistency.yaml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/spec/translation_quality/checks/emoji_consistency.yaml b/spec/translation_quality/checks/emoji_consistency.yaml index 9f899ae2..1f8008dd 100644 --- a/spec/translation_quality/checks/emoji_consistency.yaml +++ b/spec/translation_quality/checks/emoji_consistency.yaml @@ -8,13 +8,14 @@ components: type: boolean description: No emoji is allowed in target example: false - required: - - noEmojisAllowedInTarget AccountCheckTypeApplySettingsRequest: title: EMOJI_CONSISTENCY allOf: - $ref: '#/components/schemas/EmojiConsistencySettingsDTO' + - type: object + required: + - noEmojisAllowedInTarget AccountCheckTypeApplySettingsDTOResponse: title: EMOJI_CONSISTENCY From 7fca8a517b55b82f05311fe8e148061540f597fb Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Wed, 23 Oct 2024 11:37:20 +0300 Subject: [PATCH 15/21] added changes --- spec/translation_quality/accounts_result.yaml | 81 ++++++++++++------- .../checks/number_consistency.yaml | 2 +- .../checks/open_issues.yaml | 4 +- .../checks/original_equals_target.yaml | 4 +- .../checks/segment_completeness.yaml | 6 +- .../checks/source_in_wrong_language.yaml | 2 +- .../checks/spellcheck.yaml | 10 +-- .../checks/target_in_wrong_language.yaml | 2 +- .../checks/target_source_consistency.yaml | 4 +- spec/translation_quality/tqc_common.yaml | 18 ++--- 10 files changed, 80 insertions(+), 53 deletions(-) diff --git a/spec/translation_quality/accounts_result.yaml b/spec/translation_quality/accounts_result.yaml index 9b0e5231..31a26ac2 100644 --- a/spec/translation_quality/accounts_result.yaml +++ b/spec/translation_quality/accounts_result.yaml @@ -147,8 +147,6 @@ x-paths: type: boolean description: No emoji is allowed in target example: false - required: - - noEmojisAllowedInTarget - type: object properties: checkTypeCode: @@ -1599,8 +1597,6 @@ x-paths: type: boolean description: No emoji is allowed in target example: false - required: - - noEmojisAllowedInTarget - type: object properties: checkTypeCode: @@ -2146,7 +2142,7 @@ x-paths: parameters: - *ref_8 - *ref_9 - - &ref_28 + - &ref_29 name: checkTypeCode in: path required: true @@ -2170,10 +2166,13 @@ x-paths: application/json: schema: oneOf: - - &ref_29 + - &ref_30 title: EMOJI_CONSISTENCY allOf: - *ref_16 + - type: object + required: + - noEmojisAllowedInTarget - title: SPELLCHECK allOf: - *ref_17 @@ -2188,7 +2187,7 @@ x-paths: example: it-IT required: - targetLocaleId - - &ref_30 + - &ref_31 type: object required: - skipIfWordInUserDictionary @@ -2200,19 +2199,19 @@ x-paths: allOf: - *ref_18 - *ref_19 - - &ref_31 + - &ref_32 type: object required: - minTextLengthLimit - title: TARGET_IN_WRONG_LANGUAGE allOf: - - &ref_32 + - &ref_33 type: object required: - minTextLengthLimit - *ref_19 - *ref_20 - - &ref_33 + - &ref_34 title: NUMBER_CONSISTENCY allOf: - *ref_21 @@ -2220,15 +2219,16 @@ x-paths: allOf: - *ref_22 - *ref_19 - - &ref_34 + - &ref_35 type: object required: - ignoreTagsAndPlaceholders - ignoreCase - - &ref_35 + - &ref_36 title: GLOSSARY_COMPLIANCE allOf: - - allOf: + - &ref_28 + allOf: - *ref_23 - *ref_24 - type: object @@ -2239,7 +2239,7 @@ x-paths: allOf: - *ref_25 - *ref_19 - - &ref_36 + - &ref_37 type: object required: - mustHaveIdenticalTags @@ -2248,7 +2248,7 @@ x-paths: allOf: - *ref_26 - *ref_19 - - &ref_37 + - &ref_38 title: OPEN_ISSUES allOf: - *ref_27 @@ -2269,11 +2269,38 @@ x-paths: - *ref_10 - type: object properties: - data: &ref_38 + data: &ref_39 oneOf: - title: EMOJI_CONSISTENCY allOf: - *ref_16 + - title: SPELLCHECK + allOf: + - *ref_17 + - title: SOURCE_IN_WRONG_LANGUAGE + allOf: + - *ref_18 + - title: TARGET_IN_WRONG_LANGUAGE + allOf: + - *ref_20 + - title: NUMBER_CONSISTENCY + allOf: + - *ref_21 + - title: TARGET_SOURCE_CONSISTENCY + allOf: + - *ref_22 + - title: GLOSSARY_COMPLIANCE + allOf: + - *ref_28 + - title: ORIGINAL_EQUALS_TARGET + allOf: + - *ref_25 + - title: SEGMENT_COMPLETENESS + allOf: + - *ref_26 + - title: OPEN_ISSUES + allOf: + - *ref_27 examples: EMOJI_CONSISTENCY: value: @@ -2366,7 +2393,7 @@ x-paths: parameters: - *ref_8 - *ref_9 - - *ref_28 + - *ref_29 - name: groupUid in: path schema: @@ -2380,39 +2407,39 @@ x-paths: application/json: schema: oneOf: - - *ref_29 + - *ref_30 - title: SPELLCHECK allOf: - *ref_17 - *ref_19 - - *ref_30 + - *ref_31 - title: SOURCE_IN_WRONG_LANGUAGE allOf: - *ref_18 - *ref_19 - - *ref_31 + - *ref_32 - title: TARGET_IN_WRONG_LANGUAGE allOf: - - *ref_32 + - *ref_33 - *ref_19 - *ref_20 - - *ref_33 + - *ref_34 - title: TARGET_SOURCE_CONSISTENCY allOf: - *ref_22 - *ref_19 - - *ref_34 - - *ref_35 + - *ref_35 + - *ref_36 - title: ORIGINAL_EQUALS_TARGET allOf: - *ref_25 - *ref_19 - - *ref_36 + - *ref_37 - title: SEGMENT_COMPLETENESS allOf: - *ref_26 - *ref_19 - - *ref_37 + - *ref_38 responses: '200': description: OK @@ -2426,7 +2453,7 @@ x-paths: - *ref_10 - type: object properties: - data: *ref_38 + data: *ref_39 examples: EMOJI_CONSISTENCY: value: diff --git a/spec/translation_quality/checks/number_consistency.yaml b/spec/translation_quality/checks/number_consistency.yaml index 7199a65e..022e253d 100644 --- a/spec/translation_quality/checks/number_consistency.yaml +++ b/spec/translation_quality/checks/number_consistency.yaml @@ -255,7 +255,7 @@ components: "response": "code": "SUCCESS" "data": - ignoreSign: true + "ignoreSign": true tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/open_issues.yaml b/spec/translation_quality/checks/open_issues.yaml index bb8ea38d..f1880d65 100644 --- a/spec/translation_quality/checks/open_issues.yaml +++ b/spec/translation_quality/checks/open_issues.yaml @@ -160,8 +160,8 @@ components: "response": "code": "SUCCESS" "data": - sourceIssuesMustBeResolved: true - translationIssuesMustBeResolved: true + "sourceIssuesMustBeResolved": true + "translationIssuesMustBeResolved": true tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/original_equals_target.yaml b/spec/translation_quality/checks/original_equals_target.yaml index 0004f70e..6b2e34d3 100644 --- a/spec/translation_quality/checks/original_equals_target.yaml +++ b/spec/translation_quality/checks/original_equals_target.yaml @@ -161,8 +161,8 @@ components: "response": "code": "SUCCESS" "data": - mustHaveIdenticalTags: false - mustHaveIdenticalCapitalization: false + "mustHaveIdenticalTags": false + "mustHaveIdenticalCapitalization": false tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/segment_completeness.yaml b/spec/translation_quality/checks/segment_completeness.yaml index 34bbe706..22b4ab8e 100644 --- a/spec/translation_quality/checks/segment_completeness.yaml +++ b/spec/translation_quality/checks/segment_completeness.yaml @@ -234,9 +234,9 @@ components: "response": "code": "SUCCESS" "data": - lowerLengthThreshold: 10 - upperLengthThreshold: 20 - minLengthThreshold: 15 + "lowerLengthThreshold": 10 + "upperLengthThreshold": 20 + "minLengthThreshold": 15 tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/source_in_wrong_language.yaml b/spec/translation_quality/checks/source_in_wrong_language.yaml index f5a7c306..5613f79e 100644 --- a/spec/translation_quality/checks/source_in_wrong_language.yaml +++ b/spec/translation_quality/checks/source_in_wrong_language.yaml @@ -137,7 +137,7 @@ components: "response": "code": "SUCCESS" "data": - minTextLengthLimit: 10 + "minTextLengthLimit": 10 tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/spellcheck.yaml b/spec/translation_quality/checks/spellcheck.yaml index 36a6953a..1be7391a 100644 --- a/spec/translation_quality/checks/spellcheck.yaml +++ b/spec/translation_quality/checks/spellcheck.yaml @@ -205,11 +205,11 @@ components: "response": "code": "SUCCESS" "data": - skipIfWordInUserDictionary: false - skipIfWordStartsWithCapitalLetter: true - skipIfWordAppearsInSourceString: false - skipIfWordValidInSourceLocale: true - runSpellcheckForSubWords: true + "skipIfWordInUserDictionary": false + "skipIfWordStartsWithCapitalLetter": true + "skipIfWordAppearsInSourceString": false + "skipIfWordValidInSourceLocale": true + "runSpellcheckForSubWords": true tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/target_in_wrong_language.yaml b/spec/translation_quality/checks/target_in_wrong_language.yaml index 3718fb25..5d7690e6 100644 --- a/spec/translation_quality/checks/target_in_wrong_language.yaml +++ b/spec/translation_quality/checks/target_in_wrong_language.yaml @@ -138,7 +138,7 @@ components: "response": "code": "SUCCESS" "data": - minTextLengthLimit: 15 + "minTextLengthLimit": 15 tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/target_source_consistency.yaml b/spec/translation_quality/checks/target_source_consistency.yaml index e4da6980..aee02fba 100644 --- a/spec/translation_quality/checks/target_source_consistency.yaml +++ b/spec/translation_quality/checks/target_source_consistency.yaml @@ -221,8 +221,8 @@ components: "response": "code": "SUCCESS" "data": - ignoreTagsAndPlaceholders: true - ignoreCase: true + "ignoreTagsAndPlaceholders": true + "ignoreCase": true tqc_check_response_example: "response": diff --git a/spec/translation_quality/tqc_common.yaml b/spec/translation_quality/tqc_common.yaml index 2159c988..6326a6b2 100644 --- a/spec/translation_quality/tqc_common.yaml +++ b/spec/translation_quality/tqc_common.yaml @@ -678,15 +678,15 @@ components: ProfilesAccountCheckTypeApplySettingsDTOResponseOneOfCommon: oneOf: - $ref: 'checks/emoji_consistency.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' -# - $ref: 'checks/spellcheck.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' -# - $ref: 'checks/source_in_wrong_language.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' -# - $ref: 'checks/target_in_wrong_language.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' -# - $ref: 'checks/number_consistency.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' -# - $ref: 'checks/target_source_consistency.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' -# - $ref: 'checks/glossary_compliance.yaml#/components/schemas/ProfilesAccountCheckTypeApplySettingsDTOResponse' -# - $ref: 'checks/original_equals_target.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' -# - $ref: 'checks/segment_completeness.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' -# - $ref: 'checks/open_issues.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' + - $ref: 'checks/spellcheck.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' + - $ref: 'checks/source_in_wrong_language.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' + - $ref: 'checks/target_in_wrong_language.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' + - $ref: 'checks/number_consistency.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' + - $ref: 'checks/target_source_consistency.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' + - $ref: 'checks/glossary_compliance.yaml#/components/schemas/ProfilesAccountCheckTypeApplySettingsDTOResponse' + - $ref: 'checks/original_equals_target.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' + - $ref: 'checks/segment_completeness.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' + - $ref: 'checks/open_issues.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' AccountCheckTypeApplySettingsRequestOneOf: $ref: '#/components/schemas/AccountCheckTypeApplySettingsRequestOneOfCommon' From 9f0d49be8c877bedc30d3689383adbad5ce44c17 Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Wed, 23 Oct 2024 11:50:16 +0300 Subject: [PATCH 16/21] added changes --- spec/translation_quality/examples.yaml | 138 ++--- spec/translation_quality/tqc_check.yaml | 1 - .../translation_quality/tqc_check_result.yaml | 569 ++++++++++++++++++ 3 files changed, 638 insertions(+), 70 deletions(-) diff --git a/spec/translation_quality/examples.yaml b/spec/translation_quality/examples.yaml index ca080d5a..f992a1a3 100644 --- a/spec/translation_quality/examples.yaml +++ b/spec/translation_quality/examples.yaml @@ -473,72 +473,72 @@ components: BLACKLISTED_TERMS: value: $ref: 'checks/blacklisted_terms.yaml#/components/examples/tqc_check_response_example' -# EMOJI_CONSISTENCY: -# value: -# $ref: 'checks/emoji_consistency.yaml#/components/examples/tqc_check_response_example' -# GLOBAL_CAPITALISATION_CONSISTENCY: -# value: -# $ref: 'checks/global_capitalisation_consistency.yaml#/components/examples/tqc_check_response_example' -# GLOSSARY_COMPLIANCE: -# value: -# $ref: 'checks/glossary_compliance.yaml#/components/examples/tqc_check_response_example' -# INSERTABLE_CONSISTENCY: -# value: -# $ref: 'checks/insertable_consistency.yaml#/components/examples/tqc_check_response_example' -# LEADING_TRAILING_SPACES: -# value: -# $ref: 'checks/leading_trailing_spaces.yaml#/components/examples/tqc_check_response_example' -# NON_TRANSLATABLE_TEXT: -# value: -# $ref: 'checks/non_translatable_text.yaml#/components/examples/tqc_check_response_example' -# NUMBER_CONSISTENCY: -# value: -# $ref: 'checks/number_consistency.yaml#/components/examples/tqc_check_response_example' -# REPEATED_WORD: -# value: -# $ref: 'checks/repeated_word.yaml#/components/examples/tqc_check_response_example' -# SEGMENT_COMPLETENESS: -# value: -# $ref: 'checks/segment_completeness.yaml#/components/examples/tqc_check_response_example' -# SOURCE_IN_WRONG_LANGUAGE: -# value: -# $ref: 'checks/source_in_wrong_language.yaml#/components/examples/tqc_check_response_example' -# SPELLCHECK: -# value: -# $ref: 'checks/spellcheck.yaml#/components/examples/tqc_check_response_example' -# TAG_CONSISTENCY: -# value: -# $ref: 'checks/tag_consistency.yaml#/components/examples/tqc_check_response_example' -# TARGET_LENGTH_LIMIT: -# value: -# $ref: 'checks/target_length_limit.yaml#/components/examples/tqc_check_response_example' -# TARGET_IN_WRONG_LANGUAGE: -# value: -# $ref: 'checks/target_in_wrong_language.yaml#/components/examples/tqc_check_response_example' -# TARGET_SOURCE_CONSISTENCY: -# value: -# $ref: 'checks/target_source_consistency.yaml#/components/examples/tqc_check_response_example' -# TRADEMARK_CONSISTENCY: -# value: -# $ref: 'checks/trademark_consistency.yaml#/components/examples/tqc_check_response_example' -# WHITESPACES: -# value: -# $ref: 'checks/whitespaces.yaml#/components/examples/tqc_check_response_example' -# GRAMMAR_CHECK: -# value: -# $ref: 'checks/grammar_check.yaml#/components/examples/tqc_check_response_example' -# ORIGINAL_EQUALS_TARGET: -# value: -# $ref: 'checks/original_equals_target.yaml#/components/examples/tqc_check_response_example' -# PUNCTUATION_CONSISTENCY: -# value: -# $ref: 'checks/punctuation_consistency.yaml#/components/examples/tqc_check_response_example' -# PLURALS_REPETITION: -# value: -# $ref: 'checks/plurals_repetition.yaml#/components/examples/tqc_check_response_example' -# REGEX_CHECK: -# value: -# $ref: 'checks/regex_check.yaml#/components/examples/tqc_check_response_example' -# OPEN_ISSUES: -# value: -# $ref: 'checks/open_issues.yaml#/components/examples/tqc_check_response_example' + EMOJI_CONSISTENCY: + value: + $ref: 'checks/emoji_consistency.yaml#/components/examples/tqc_check_response_example' + GLOBAL_CAPITALISATION_CONSISTENCY: + value: + $ref: 'checks/global_capitalisation_consistency.yaml#/components/examples/tqc_check_response_example' + GLOSSARY_COMPLIANCE: + value: + $ref: 'checks/glossary_compliance.yaml#/components/examples/tqc_check_response_example' + INSERTABLE_CONSISTENCY: + value: + $ref: 'checks/insertable_consistency.yaml#/components/examples/tqc_check_response_example' + LEADING_TRAILING_SPACES: + value: + $ref: 'checks/leading_trailing_spaces.yaml#/components/examples/tqc_check_response_example' + NON_TRANSLATABLE_TEXT: + value: + $ref: 'checks/non_translatable_text.yaml#/components/examples/tqc_check_response_example' + NUMBER_CONSISTENCY: + value: + $ref: 'checks/number_consistency.yaml#/components/examples/tqc_check_response_example' + REPEATED_WORD: + value: + $ref: 'checks/repeated_word.yaml#/components/examples/tqc_check_response_example' + SEGMENT_COMPLETENESS: + value: + $ref: 'checks/segment_completeness.yaml#/components/examples/tqc_check_response_example' + SOURCE_IN_WRONG_LANGUAGE: + value: + $ref: 'checks/source_in_wrong_language.yaml#/components/examples/tqc_check_response_example' + SPELLCHECK: + value: + $ref: 'checks/spellcheck.yaml#/components/examples/tqc_check_response_example' + TAG_CONSISTENCY: + value: + $ref: 'checks/tag_consistency.yaml#/components/examples/tqc_check_response_example' + TARGET_LENGTH_LIMIT: + value: + $ref: 'checks/target_length_limit.yaml#/components/examples/tqc_check_response_example' + TARGET_IN_WRONG_LANGUAGE: + value: + $ref: 'checks/target_in_wrong_language.yaml#/components/examples/tqc_check_response_example' + TARGET_SOURCE_CONSISTENCY: + value: + $ref: 'checks/target_source_consistency.yaml#/components/examples/tqc_check_response_example' + TRADEMARK_CONSISTENCY: + value: + $ref: 'checks/trademark_consistency.yaml#/components/examples/tqc_check_response_example' + WHITESPACES: + value: + $ref: 'checks/whitespaces.yaml#/components/examples/tqc_check_response_example' + GRAMMAR_CHECK: + value: + $ref: 'checks/grammar_check.yaml#/components/examples/tqc_check_response_example' + ORIGINAL_EQUALS_TARGET: + value: + $ref: 'checks/original_equals_target.yaml#/components/examples/tqc_check_response_example' + PUNCTUATION_CONSISTENCY: + value: + $ref: 'checks/punctuation_consistency.yaml#/components/examples/tqc_check_response_example' + PLURALS_REPETITION: + value: + $ref: 'checks/plurals_repetition.yaml#/components/examples/tqc_check_response_example' + REGEX_CHECK: + value: + $ref: 'checks/regex_check.yaml#/components/examples/tqc_check_response_example' + OPEN_ISSUES: + value: + $ref: 'checks/open_issues.yaml#/components/examples/tqc_check_response_example' diff --git a/spec/translation_quality/tqc_check.yaml b/spec/translation_quality/tqc_check.yaml index 7082c715..dcafa399 100644 --- a/spec/translation_quality/tqc_check.yaml +++ b/spec/translation_quality/tqc_check.yaml @@ -127,5 +127,4 @@ components: mistakes: type: array items: - type: object $ref: './tqc_common.yaml#/components/schemas/TqcCheckMistakeDTOs' diff --git a/spec/translation_quality/tqc_check_result.yaml b/spec/translation_quality/tqc_check_result.yaml index 6ec49b85..6d8fc901 100644 --- a/spec/translation_quality/tqc_check_result.yaml +++ b/spec/translation_quality/tqc_check_result.yaml @@ -1223,6 +1223,575 @@ x-paths: alternatives: [] notes: '' positionTypeCode: TARGET + EMOJI_CONSISTENCY: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Bonjour 😀 + translation: Hello + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: EMOJI_CONSISTENCY + severityLevelCode: LOW + positions: + - from: 14 + to: 16 + details: + emoji: 😀 + type: EMOJI_DELETED + positionTypeCode: SOURCE + GLOBAL_CAPITALISATION_CONSISTENCY: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: ATTENTION + translation: WARNINg + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: GLOBAL_CAPITALISATION_CONSISTENCY + severityLevelCode: LOW + positions: + - from: 0 + to: 7 + details: null + positionTypeCode: TARGET + GLOSSARY_COMPLIANCE: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: resize + translation: поменять + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: GLOSSARY_COMPLIANCE + severityLevelCode: MEDIUM + positions: + - from: 0 + to: 6 + details: + glossaryTerm: + termUid: cdd443b9-814f-442c-9ba6-4d97e0afce74 + translation: + localeId: ru-RU + translatedTerm: изменить размер + notes: '' + translatorUserUid: null + lockTranslation: false + submittedForTranslation: false + createdDate: '2018-11-16T16:06:53Z' + modifiedDate: '2018-11-16T16:06:53Z' + termText: resize + caseSensitive: false + exactMatch: false + definition: '' + variations: '' + synonyms: '' + antonyms: '' + seo: false + doNotTranslate: false + notes: '' + partOfSpeechCode: UNSPECIFIED + createdByUserUid: f64d50d91867 + createdDate: '2018-11-16T16:06:05Z' + modifiedDate: '2018-11-16T16:06:05Z' + positionTypeCode: SOURCE + INSERTABLE_CONSISTENCY: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Bonjour
+ translation: Hello + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: INSERTABLE_CONSISTENCY + severityLevelCode: LOW + positions: + - from: 13 + to: 17 + details: + insertable:
+ insertableType: BR_TAG + type: INSERTABLE_DELETED + positionTypeCode: SOURCE + LEADING_TRAILING_SPACES: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Bonjour + translation: ' Hello ' + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: LEADING_TRAILING_SPACES + severityLevelCode: LOW + positions: + - from: 0 + to: 1 + - from: 6 + to: 7 + details: null + positionTypeCode: TARGET + NON_TRANSLATABLE_TEXT: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Bonjour {0} + translation: Hello + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: NON_TRANSLATABLE_TEXT + severityLevelCode: MEDIUM + positions: + - from: 6 + to: 9 + details: + placeable: '{0}' + type: PLACEABLE_DELETED + positionTypeCode: SOURCE + NUMBER_CONSISTENCY: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Bonjour 1000 + translation: Hello 20 + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: NUMBER_CONSISTENCY + severityLevelCode: LOW + positions: + - from: 6 + to: 10 + details: + type: NUMBER_DELETED + number: '1000' + positionTypeCode: SOURCE + - checkTypeCode: NUMBER_CONSISTENCY + severityLevelCode: LOW + positions: + from: 5 + to: 7 + details: + type: NUMBER_ADDED + number: 20 + positionTypeCode: TARGET + REPEATED_WORD: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Bonjour + translation: Hello Hello + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: REPEATED_WORD + severityLevelCode: LOW + positions: + from: 5 + to: 9 + details: + word: Hello + positionTypeCode: TARGET + SEGMENT_COMPLETENESS: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Le chien a mangé mes devoirs. + translation: The dog ate + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: SEGMENT_COMPLETENESS + severityLevelCode: MEDIUM + positions: + from: 0 + to: 10 + details: + type: TARGET_IS_MUCH_SHORTER_THAN_SOURCE + positionTypeCode: TARGET + SOURCE_IN_WRONG_LANGUAGE: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Der Hund hat meine Hausaufgaben gegessen. + translation: The dog ate my homework. + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: SOURCE_IN_WRONG_LANGUAGE + severityLevelCode: LOW + positions: + from: 0 + to: 63 + details: null + positionTypeCode: SOURCE + SPELLCHECK: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Le chien a mangé mes devoirs. + translation: The dog ate my homewrk. + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: SPELLCHECK + severityLevelCode: MEDIUM + positions: + from: 0 + to: 5 + details: + word: homewrk + suggestions: + - homework + positionTypeCode: TARGET + TAG_CONSISTENCY: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString:

Bonjour

+ translation:

Hello + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: TAG_CONSISTENCY + severityLevelCode: MEDIUM + positions: + from: 8 + to: 12 + details: + tag:

+ type: TAG_DELETED + positionTypeCode: SOURCE + TARGET_LENGTH_LIMIT: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Bonjour + translation: Hello + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: TARGET_LENGTH_LIMIT + severityLevelCode: HIGH + positions: + from: 0 + to: 4 + details: null + positionTypeCode: TARGET + TARGET_IN_WRONG_LANGUAGE: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Le chien a mangé mes devoirs. + translation: Der Hund hat meine Hausaufgaben gegessen. + hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: TARGET_IN_WRONG_LANGUAGE + severityLevelCode: LOW + positions: + from: 0 + to: 64 + details: null + positionTypeCode: TARGET + TARGET_SOURCE_CONSISTENCY: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Le chien a mangé mes devoirs. + translation: The dog have ate my homework. + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: TARGET_SOURCE_CONSISTENCY + severityLevelCode: LOW + positions: + from: 0 + to: 27 + details: + type: SAME_SOURCE_DIFFERENT_TRANSLATIONS + originalString: Le chien a mangé mes devoirs. + translation: The dog have ate my homework. + positionTypeCode: TARGET + TRADEMARK_CONSISTENCY: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Bonjour © + translation: Hello + hashcode: 9091152182c69d9b72069ac1290fe2345 + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: TRADEMARK_CONSISTENCY + severityLevelCode: LOW + positions: + from: 6 + to: 7 + details: + trademarkTypeCode: COPYRIGHT + positionTypeCode: SOURCE + WHITESPACES: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Bonjour 100 + translation: Hello 100 + hashcode: 1091152182c69d9b72069ac1290fe23999 + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: WHITESPACES + severityLevelCode: LOW + positions: + from: 4 + to: 6 + details: null + positionTypeCode: TARGET + GRAMMAR_CHECK: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Le chien a mangé mes devoirs. + translation: The dog have ate my homework. + hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: GRAMMAR_CHECK + severityLevelCode: LOW + positions: + from: 9 + to: 13 + details: + text: ate + message: Possible agreement error + description: 'Agreement: ''have'' + past/present tense' + mistakeTypeCode: Grammar + suggestions: + - eaten + positionTypeCode: TARGET + ORIGINAL_EQUALS_TARGET: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: hello + translation: hello + hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: ORIGINAL_EQUALS_TARGET + severityLevelCode: LOW + positions: + from: 0 + to: 5 + details: + types: + - IDENTICAL_CAPITALIZATION + - IDENTICAL_TAGS + positionTypeCode: TARGET + PUNCTUATION_CONSISTENCY: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: Hello! + translation: Привет. Как дела? + hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: PUNCTUATION_CONSISTENCY + severityLevelCode: LOW + positions: + from: 5 + to: 6 + details: + punctuationMark: '!' + type: PUNCTUATION_MARK_DELETED + punctuationMarkType: TERMINAL + positionTypeCode: SOURCE + PLURALS_REPETITION: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: 2 rows + translation: 2 rows + hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 + stringUid: null + pluralFormGroupUid: a0b1acda22fc97da9c2b9ae5f3b25888 + pluralForm: MANY + mistakes: + - checkTypeCode: PLURALS_REPETITION + severityLevelCode: MEDIUM + positions: + from: 0 + to: 5 + details: + pluralFormGroupUid: a0b1acda22fc97da9c2b9ae5f3b25888 + repeatedPluralForms: + - MANY + - FEW + positionTypeCode: TARGET + REGEX_CHECK: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: test@gmail + translation: test@mail + hashcode: 7191152182c69d9b72069ac1290fe24b + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: REGEX_CHECK + severityLevelCode: LOW + positions: + - from: 5 + to: 10 + details: + ruleUid: 30606c59ee92 + severityLevelCode: LOW + ruleName: name1 + ruleTypeCode: FORBIDDEN + flavorCode: JAVA + originalPattern: '@f1' + translationPattern: '@f1' + description: name1 description + caseInsensitive: true + multiLine: false + warningMessage: test warning + positionTypeCode: TARGET + ignored: false + OPEN_ISSUES: + value: + response: + code: SUCCESS + data: + results: + - string: + originalString: hello + translation: hello + hashcode: a0b1acda22fc97da9c2b9ae5f3b25888 + stringUid: null + pluralFormGroupUid: null + pluralForm: null + mistakes: + - checkTypeCode: OPEN_ISSUES + severityLevelCode: LOW + positions: + from: 0 + to: 5 + details: + sourceIssuesCount: 5 + translationIssuesCount: 3 + positionTypeCode: TARGET '400': description: Provided request parameters are invalid. content: From 8e6d051212b42668227cc75c45054796d67081b4 Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Wed, 23 Oct 2024 12:28:54 +0300 Subject: [PATCH 17/21] added changes --- .../checks/glossary_compliance.yaml | 1 + .../checks/grammar_check.yaml | 4 +- .../checks/number_consistency.yaml | 6 +- .../checks/open_issues.yaml | 4 +- .../checks/original_equals_target.yaml | 4 +- .../checks/plurals_repetition.yaml | 4 +- .../checks/punctuation_consistency.yaml | 4 +- .../checks/repeated_word.yaml | 4 +- .../checks/segment_completeness.yaml | 4 +- .../checks/source_in_wrong_language.yaml | 4 +- .../checks/spellcheck.yaml | 4 +- .../checks/tag_consistency.yaml | 4 +- .../checks/target_in_wrong_language.yaml | 4 +- .../checks/target_length_limit.yaml | 4 +- .../checks/target_source_consistency.yaml | 4 +- .../checks/trademark_consistency.yaml | 4 +- .../checks/whitespaces.yaml | 4 +- .../translation_quality/tqc_check_result.yaml | 67 ++++++++++--------- 18 files changed, 68 insertions(+), 66 deletions(-) diff --git a/spec/translation_quality/checks/glossary_compliance.yaml b/spec/translation_quality/checks/glossary_compliance.yaml index 372097e9..b217fcf1 100644 --- a/spec/translation_quality/checks/glossary_compliance.yaml +++ b/spec/translation_quality/checks/glossary_compliance.yaml @@ -156,6 +156,7 @@ components: type: string description: translator user identifier example: "23ddd32e" + nullable: true lockTranslation: type: boolean description: lock translation diff --git a/spec/translation_quality/checks/grammar_check.yaml b/spec/translation_quality/checks/grammar_check.yaml index ed263c2f..04100fd3 100644 --- a/spec/translation_quality/checks/grammar_check.yaml +++ b/spec/translation_quality/checks/grammar_check.yaml @@ -133,8 +133,8 @@ components: - "checkTypeCode": "GRAMMAR_CHECK" "severityLevelCode": "LOW" "positions": - "from": 9 - "to": 13 + - "from": 9 + "to": 13 "details": "text": "ate" "message": "Possible agreement error" diff --git a/spec/translation_quality/checks/number_consistency.yaml b/spec/translation_quality/checks/number_consistency.yaml index 022e253d..34c58516 100644 --- a/spec/translation_quality/checks/number_consistency.yaml +++ b/spec/translation_quality/checks/number_consistency.yaml @@ -282,11 +282,11 @@ components: - "checkTypeCode": "NUMBER_CONSISTENCY" "severityLevelCode": "LOW" "positions": - "from": 5 - "to": 7 + - "from": 5 + "to": 7 "details": "type": "NUMBER_ADDED" - "number": 20 + "number": "20" "positionTypeCode": "TARGET" dictionary_checkTypes_response_example: diff --git a/spec/translation_quality/checks/open_issues.yaml b/spec/translation_quality/checks/open_issues.yaml index f1880d65..f39c4e00 100644 --- a/spec/translation_quality/checks/open_issues.yaml +++ b/spec/translation_quality/checks/open_issues.yaml @@ -179,8 +179,8 @@ components: - "checkTypeCode": "OPEN_ISSUES" "severityLevelCode": "LOW" "positions": - "from": 0 - "to": 5 + - "from": 0 + "to": 5 "details": "sourceIssuesCount": 5 "translationIssuesCount": 3 diff --git a/spec/translation_quality/checks/original_equals_target.yaml b/spec/translation_quality/checks/original_equals_target.yaml index 6b2e34d3..817ac385 100644 --- a/spec/translation_quality/checks/original_equals_target.yaml +++ b/spec/translation_quality/checks/original_equals_target.yaml @@ -180,8 +180,8 @@ components: - "checkTypeCode": "ORIGINAL_EQUALS_TARGET" "severityLevelCode": "LOW" "positions": - "from": 0 - "to": 5 + - "from": 0 + "to": 5 "details": "types": - "IDENTICAL_CAPITALIZATION" diff --git a/spec/translation_quality/checks/plurals_repetition.yaml b/spec/translation_quality/checks/plurals_repetition.yaml index d7e0fa08..a4006d72 100644 --- a/spec/translation_quality/checks/plurals_repetition.yaml +++ b/spec/translation_quality/checks/plurals_repetition.yaml @@ -118,8 +118,8 @@ components: - "checkTypeCode": "PLURALS_REPETITION" "severityLevelCode": "MEDIUM" "positions": - "from": 0 - "to": 5 + - "from": 0 + "to": 5 "details": "pluralFormGroupUid": "a0b1acda22fc97da9c2b9ae5f3b25888" "repeatedPluralForms": diff --git a/spec/translation_quality/checks/punctuation_consistency.yaml b/spec/translation_quality/checks/punctuation_consistency.yaml index 5544ea66..5a334814 100644 --- a/spec/translation_quality/checks/punctuation_consistency.yaml +++ b/spec/translation_quality/checks/punctuation_consistency.yaml @@ -108,8 +108,8 @@ components: - "checkTypeCode": "PUNCTUATION_CONSISTENCY" "severityLevelCode": "LOW" "positions": - "from": 5 - "to": 6 + - "from": 5 + "to": 6 "details": "punctuationMark": "!" "type": "PUNCTUATION_MARK_DELETED" diff --git a/spec/translation_quality/checks/repeated_word.yaml b/spec/translation_quality/checks/repeated_word.yaml index eb09143f..bdc57a22 100644 --- a/spec/translation_quality/checks/repeated_word.yaml +++ b/spec/translation_quality/checks/repeated_word.yaml @@ -114,8 +114,8 @@ components: - "checkTypeCode": "REPEATED_WORD" "severityLevelCode": "LOW" "positions": - "from": 5 - "to": 9 + - "from": 5 + "to": 9 "details": "word": "Hello" "positionTypeCode": "TARGET" diff --git a/spec/translation_quality/checks/segment_completeness.yaml b/spec/translation_quality/checks/segment_completeness.yaml index 22b4ab8e..1d308dab 100644 --- a/spec/translation_quality/checks/segment_completeness.yaml +++ b/spec/translation_quality/checks/segment_completeness.yaml @@ -254,8 +254,8 @@ components: - "checkTypeCode": "SEGMENT_COMPLETENESS" "severityLevelCode": "MEDIUM" "positions": - "from": 0 - "to": 10 + - "from": 0 + "to": 10 "details": "type": "TARGET_IS_MUCH_SHORTER_THAN_SOURCE" "positionTypeCode": "TARGET" diff --git a/spec/translation_quality/checks/source_in_wrong_language.yaml b/spec/translation_quality/checks/source_in_wrong_language.yaml index 5613f79e..10a12176 100644 --- a/spec/translation_quality/checks/source_in_wrong_language.yaml +++ b/spec/translation_quality/checks/source_in_wrong_language.yaml @@ -155,8 +155,8 @@ components: - "checkTypeCode": "SOURCE_IN_WRONG_LANGUAGE" "severityLevelCode": "LOW" "positions": - "from": 0 - "to": 63 + - "from": 0 + "to": 63 "details": null "positionTypeCode": "SOURCE" diff --git a/spec/translation_quality/checks/spellcheck.yaml b/spec/translation_quality/checks/spellcheck.yaml index 1be7391a..3ac122c7 100644 --- a/spec/translation_quality/checks/spellcheck.yaml +++ b/spec/translation_quality/checks/spellcheck.yaml @@ -227,8 +227,8 @@ components: - "checkTypeCode": "SPELLCHECK" "severityLevelCode": "MEDIUM" "positions": - "from": 0 - "to": 5 + - "from": 0 + "to": 5 "details": "word": "homewrk" "suggestions": diff --git a/spec/translation_quality/checks/tag_consistency.yaml b/spec/translation_quality/checks/tag_consistency.yaml index 6555ab57..8a7d246a 100644 --- a/spec/translation_quality/checks/tag_consistency.yaml +++ b/spec/translation_quality/checks/tag_consistency.yaml @@ -203,8 +203,8 @@ components: - "checkTypeCode": "TAG_CONSISTENCY" "severityLevelCode": "MEDIUM" "positions": - "from": 8 - "to": 12 + - "from": 8 + "to": 12 "details": "tag": "

" "type": "TAG_DELETED" diff --git a/spec/translation_quality/checks/target_in_wrong_language.yaml b/spec/translation_quality/checks/target_in_wrong_language.yaml index 5d7690e6..562f1c5d 100644 --- a/spec/translation_quality/checks/target_in_wrong_language.yaml +++ b/spec/translation_quality/checks/target_in_wrong_language.yaml @@ -156,8 +156,8 @@ components: - "checkTypeCode": "TARGET_IN_WRONG_LANGUAGE" "severityLevelCode": "LOW" "positions": - "from": 0 - "to": 64 + - "from": 0 + "to": 64 "details": null "positionTypeCode": "TARGET" diff --git a/spec/translation_quality/checks/target_length_limit.yaml b/spec/translation_quality/checks/target_length_limit.yaml index d8a0862e..6f6baefe 100644 --- a/spec/translation_quality/checks/target_length_limit.yaml +++ b/spec/translation_quality/checks/target_length_limit.yaml @@ -108,8 +108,8 @@ components: - "checkTypeCode": "TARGET_LENGTH_LIMIT" "severityLevelCode": "HIGH" "positions": - "from": 0 - "to": 4 + - "from": 0 + "to": 4 "details": null "positionTypeCode": "TARGET" diff --git a/spec/translation_quality/checks/target_source_consistency.yaml b/spec/translation_quality/checks/target_source_consistency.yaml index aee02fba..612be8e7 100644 --- a/spec/translation_quality/checks/target_source_consistency.yaml +++ b/spec/translation_quality/checks/target_source_consistency.yaml @@ -240,8 +240,8 @@ components: - "checkTypeCode": "TARGET_SOURCE_CONSISTENCY" "severityLevelCode": "LOW" "positions": - "from": 0 - "to": 27 + - "from": 0 + "to": 27 "details": "type": "SAME_SOURCE_DIFFERENT_TRANSLATIONS" "originalString": "Le chien a mangé mes devoirs." diff --git a/spec/translation_quality/checks/trademark_consistency.yaml b/spec/translation_quality/checks/trademark_consistency.yaml index a7455867..ffcba590 100644 --- a/spec/translation_quality/checks/trademark_consistency.yaml +++ b/spec/translation_quality/checks/trademark_consistency.yaml @@ -118,8 +118,8 @@ components: - "checkTypeCode": "TRADEMARK_CONSISTENCY" "severityLevelCode": "LOW" "positions": - "from": 6 - "to": 7 + - "from": 6 + "to": 7 "details": "trademarkTypeCode": "COPYRIGHT" "positionTypeCode": "SOURCE" diff --git a/spec/translation_quality/checks/whitespaces.yaml b/spec/translation_quality/checks/whitespaces.yaml index 77a1107d..175008c3 100644 --- a/spec/translation_quality/checks/whitespaces.yaml +++ b/spec/translation_quality/checks/whitespaces.yaml @@ -108,8 +108,8 @@ components: - "checkTypeCode": "WHITESPACES" "severityLevelCode": "LOW" "positions": - "from": 4 - "to": 6 + - "from": 4 + "to": 6 "details": null "positionTypeCode": "TARGET" diff --git a/spec/translation_quality/tqc_check_result.yaml b/spec/translation_quality/tqc_check_result.yaml index 6d8fc901..99d90788 100644 --- a/spec/translation_quality/tqc_check_result.yaml +++ b/spec/translation_quality/tqc_check_result.yaml @@ -397,6 +397,7 @@ x-paths: type: string description: translator user identifier example: 23ddd32e + nullable: true lockTranslation: type: boolean description: lock translation @@ -1409,11 +1410,11 @@ x-paths: - checkTypeCode: NUMBER_CONSISTENCY severityLevelCode: LOW positions: - from: 5 - to: 7 + - from: 5 + to: 7 details: type: NUMBER_ADDED - number: 20 + number: '20' positionTypeCode: TARGET REPEATED_WORD: value: @@ -1432,8 +1433,8 @@ x-paths: - checkTypeCode: REPEATED_WORD severityLevelCode: LOW positions: - from: 5 - to: 9 + - from: 5 + to: 9 details: word: Hello positionTypeCode: TARGET @@ -1454,8 +1455,8 @@ x-paths: - checkTypeCode: SEGMENT_COMPLETENESS severityLevelCode: MEDIUM positions: - from: 0 - to: 10 + - from: 0 + to: 10 details: type: TARGET_IS_MUCH_SHORTER_THAN_SOURCE positionTypeCode: TARGET @@ -1476,8 +1477,8 @@ x-paths: - checkTypeCode: SOURCE_IN_WRONG_LANGUAGE severityLevelCode: LOW positions: - from: 0 - to: 63 + - from: 0 + to: 63 details: null positionTypeCode: SOURCE SPELLCHECK: @@ -1497,8 +1498,8 @@ x-paths: - checkTypeCode: SPELLCHECK severityLevelCode: MEDIUM positions: - from: 0 - to: 5 + - from: 0 + to: 5 details: word: homewrk suggestions: @@ -1521,8 +1522,8 @@ x-paths: - checkTypeCode: TAG_CONSISTENCY severityLevelCode: MEDIUM positions: - from: 8 - to: 12 + - from: 8 + to: 12 details: tag:

type: TAG_DELETED @@ -1544,8 +1545,8 @@ x-paths: - checkTypeCode: TARGET_LENGTH_LIMIT severityLevelCode: HIGH positions: - from: 0 - to: 4 + - from: 0 + to: 4 details: null positionTypeCode: TARGET TARGET_IN_WRONG_LANGUAGE: @@ -1565,8 +1566,8 @@ x-paths: - checkTypeCode: TARGET_IN_WRONG_LANGUAGE severityLevelCode: LOW positions: - from: 0 - to: 64 + - from: 0 + to: 64 details: null positionTypeCode: TARGET TARGET_SOURCE_CONSISTENCY: @@ -1586,8 +1587,8 @@ x-paths: - checkTypeCode: TARGET_SOURCE_CONSISTENCY severityLevelCode: LOW positions: - from: 0 - to: 27 + - from: 0 + to: 27 details: type: SAME_SOURCE_DIFFERENT_TRANSLATIONS originalString: Le chien a mangé mes devoirs. @@ -1610,8 +1611,8 @@ x-paths: - checkTypeCode: TRADEMARK_CONSISTENCY severityLevelCode: LOW positions: - from: 6 - to: 7 + - from: 6 + to: 7 details: trademarkTypeCode: COPYRIGHT positionTypeCode: SOURCE @@ -1632,8 +1633,8 @@ x-paths: - checkTypeCode: WHITESPACES severityLevelCode: LOW positions: - from: 4 - to: 6 + - from: 4 + to: 6 details: null positionTypeCode: TARGET GRAMMAR_CHECK: @@ -1653,8 +1654,8 @@ x-paths: - checkTypeCode: GRAMMAR_CHECK severityLevelCode: LOW positions: - from: 9 - to: 13 + - from: 9 + to: 13 details: text: ate message: Possible agreement error @@ -1680,8 +1681,8 @@ x-paths: - checkTypeCode: ORIGINAL_EQUALS_TARGET severityLevelCode: LOW positions: - from: 0 - to: 5 + - from: 0 + to: 5 details: types: - IDENTICAL_CAPITALIZATION @@ -1704,8 +1705,8 @@ x-paths: - checkTypeCode: PUNCTUATION_CONSISTENCY severityLevelCode: LOW positions: - from: 5 - to: 6 + - from: 5 + to: 6 details: punctuationMark: '!' type: PUNCTUATION_MARK_DELETED @@ -1728,8 +1729,8 @@ x-paths: - checkTypeCode: PLURALS_REPETITION severityLevelCode: MEDIUM positions: - from: 0 - to: 5 + - from: 0 + to: 5 details: pluralFormGroupUid: a0b1acda22fc97da9c2b9ae5f3b25888 repeatedPluralForms: @@ -1786,8 +1787,8 @@ x-paths: - checkTypeCode: OPEN_ISSUES severityLevelCode: LOW positions: - from: 0 - to: 5 + - from: 0 + to: 5 details: sourceIssuesCount: 5 translationIssuesCount: 3 From d471948cf32ee8706ddd940d78eb58a9f57eabf7 Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Wed, 23 Oct 2024 12:38:06 +0300 Subject: [PATCH 18/21] added changes --- spec/translation_quality/accounts_result.yaml | 466 ++++++++++-------- .../checks/blacklisted_terms.yaml | 15 +- .../checks/emoji_consistency.yaml | 27 +- .../global_capitalisation_consistency.yaml | 15 +- .../checks/glossary_compliance.yaml | 21 +- .../checks/insertable_consistency.yaml | 21 +- .../checks/non_translatable_text.yaml | 31 +- .../checks/number_consistency.yaml | 31 +- .../checks/open_issues.yaml | 19 +- .../checks/original_equals_target.yaml | 19 +- .../checks/plurals_repetition.yaml | 15 +- .../checks/punctuation_consistency.yaml | 15 +- .../checks/regex_check.yaml | 35 +- .../checks/repeated_word.yaml | 15 +- .../checks/segment_completeness.yaml | 31 +- .../checks/source_in_wrong_language.yaml | 17 +- .../checks/spellcheck.yaml | 25 +- .../checks/tag_consistency.yaml | 31 +- .../checks/target_in_wrong_language.yaml | 17 +- .../checks/target_length_limit.yaml | 15 +- .../checks/target_source_consistency.yaml | 25 +- .../checks/trademark_consistency.yaml | 15 +- .../checks/whitespaces.yaml | 15 +- 23 files changed, 534 insertions(+), 402 deletions(-) diff --git a/spec/translation_quality/accounts_result.yaml b/spec/translation_quality/accounts_result.yaml index 31a26ac2..affac9e7 100644 --- a/spec/translation_quality/accounts_result.yaml +++ b/spec/translation_quality/accounts_result.yaml @@ -1860,203 +1860,254 @@ x-paths: examples: ORIGINAL_EQUALS_TARGET: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: ORIGINAL_EQUALS_TARGET - subTypes: [] - localeSeverityLevels: [] - groups: [] - mustHaveIdenticalTags: true - mustHaveIdenticalCapitalization: true + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: ORIGINAL_EQUALS_TARGET + subTypes: [] + localeSeverityLevels: [] + groups: [] + mustHaveIdenticalTags: true + mustHaveIdenticalCapitalization: true WHITESPACES: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: WHITESPACES - subTypes: [] - localeSeverityLevels: [] - groups: [] + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: WHITESPACES + subTypes: [] + localeSeverityLevels: [] + groups: [] SPELLCHECK: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: SPELLCHECK - subTypes: [] - localeSeverityLevels: [] - groups: [] - skipIfWordInUserDictionary: true - skipIfWordStartsWithCapitalLetter: false - skipIfWordAppearsInSourceString: true - skipIfWordValidInSourceLocale: false - runSpellcheckForSubWords: false + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: SPELLCHECK + subTypes: [] + localeSeverityLevels: [] + groups: [] + skipIfWordInUserDictionary: true + skipIfWordStartsWithCapitalLetter: false + skipIfWordAppearsInSourceString: true + skipIfWordValidInSourceLocale: false + runSpellcheckForSubWords: false TAG_CONSISTENCY: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: TAG_CONSISTENCY - subTypes: - - checkSubTypeCode: TAG_ADDED - severityLevelCode: LOW - - checkSubTypeCode: TAG_DELETED - severityLevelCode: LOW - - checkSubTypeCode: TAG_ORDER_IS_CHANGED - severityLevelCode: LOW - - checkSubTypeCode: SPACES_AROUND_TAGS + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] + checkTypeCode: TAG_CONSISTENCY + subTypes: + - checkSubTypeCode: TAG_ADDED + severityLevelCode: LOW + - checkSubTypeCode: TAG_DELETED + severityLevelCode: LOW + - checkSubTypeCode: TAG_ORDER_IS_CHANGED + severityLevelCode: LOW + - checkSubTypeCode: SPACES_AROUND_TAGS + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] TARGET_LENGTH_LIMIT: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: HIGH - checkTypeCode: TARGET_LENGTH_LIMIT - subTypes: [] - localeSeverityLevels: [] - groups: [] + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: HIGH + checkTypeCode: TARGET_LENGTH_LIMIT + subTypes: [] + localeSeverityLevels: [] + groups: [] NUMBER_CONSISTENCY: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: NUMBER_CONSISTENCY - subTypes: - - checkSubTypeCode: NUMBER_DELETED - severityLevelCode: LOW - - checkSubTypeCode: NUMBER_ADDED - severityLevelCode: LOW - - checkSubTypeCode: NUMBER_INCORRECT_CONVERSION + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: LOW - localeSeverityLevels: [] - groups: - - groupUid: b0dd258b05ee - - groupUid: a853df2cf8ac - ignoreSign: true + checkTypeCode: NUMBER_CONSISTENCY + subTypes: + - checkSubTypeCode: NUMBER_DELETED + severityLevelCode: LOW + - checkSubTypeCode: NUMBER_ADDED + severityLevelCode: LOW + - checkSubTypeCode: NUMBER_INCORRECT_CONVERSION + severityLevelCode: LOW + localeSeverityLevels: [] + groups: + - groupUid: b0dd258b05ee + - groupUid: a853df2cf8ac + ignoreSign: true REPEATED_WORD: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: REPEATED_WORD - subTypes: [] - localeSeverityLevels: [] - groups: [] + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: REPEATED_WORD + subTypes: [] + localeSeverityLevels: [] + groups: [] TARGET_IN_WRONG_LANGUAGE: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: TARGET_IN_WRONG_LANGUAGE - subTypes: [] - localeSeverityLevels: [] - groups: [] - minTextLengthLimit: 40 + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: TARGET_IN_WRONG_LANGUAGE + subTypes: [] + localeSeverityLevels: [] + groups: [] + minTextLengthLimit: 40 SOURCE_IN_WRONG_LANGUAGE: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: SOURCE_IN_WRONG_LANGUAGE - subTypes: [] - localeSeverityLevels: [] - groups: [] - minTextLengthLimit: 40 + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: SOURCE_IN_WRONG_LANGUAGE + subTypes: [] + localeSeverityLevels: [] + groups: [] + minTextLengthLimit: 40 SEGMENT_COMPLETENESS: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: MEDIUM - checkTypeCode: SEGMENT_COMPLETENESS - subTypes: - - checkSubTypeCode: TARGET_IS_MUCH_SHORTER_THAN_SOURCE - severityLevelCode: MEDIUM - - checkSubTypeCode: TARGET_IS_MUCH_LONGER_THAN_SOURCE + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: MEDIUM - - checkSubTypeCode: TARGET_IS_EMPTY - severityLevelCode: DISABLED - localeSeverityLevels: [] - groups: [] - lowerLengthThreshold: 50 - upperLengthThreshold: 250 - minLengthThreshold: 10 + checkTypeCode: SEGMENT_COMPLETENESS + subTypes: + - checkSubTypeCode: TARGET_IS_MUCH_SHORTER_THAN_SOURCE + severityLevelCode: MEDIUM + - checkSubTypeCode: TARGET_IS_MUCH_LONGER_THAN_SOURCE + severityLevelCode: MEDIUM + - checkSubTypeCode: TARGET_IS_EMPTY + severityLevelCode: DISABLED + localeSeverityLevels: [] + groups: [] + lowerLengthThreshold: 50 + upperLengthThreshold: 250 + minLengthThreshold: 10 NON_TRANSLATABLE_TEXT: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: MEDIUM - checkTypeCode: NON_TRANSLATABLE_TEXT - subTypes: - - checkSubTypeCode: PLACEABLE_DELETED - severityLevelCode: MEDIUM - - checkSubTypeCode: SPACES_AROUND_PLACEABLE - severityLevelCode: MEDIUM - - checkSubTypeCode: PLACEABLE_ADDED - severityLevelCode: MEDIUM - - checkSubTypeCode: PLACEABLE_FORMAT + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: MEDIUM - localeSeverityLevels: [] - groups: [] + checkTypeCode: NON_TRANSLATABLE_TEXT + subTypes: + - checkSubTypeCode: PLACEABLE_DELETED + severityLevelCode: MEDIUM + - checkSubTypeCode: SPACES_AROUND_PLACEABLE + severityLevelCode: MEDIUM + - checkSubTypeCode: PLACEABLE_ADDED + severityLevelCode: MEDIUM + - checkSubTypeCode: PLACEABLE_FORMAT + severityLevelCode: MEDIUM + localeSeverityLevels: [] + groups: [] EMOJI_CONSISTENCY: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: EMOJI_CONSISTENCY - subTypes: - - checkSubTypeCode: EMOJI_PRESENT - severityLevelCode: LOW - - checkSubTypeCode: EMOJI_DELETED - severityLevelCode: DISABLED - - checkSubTypeCode: EMOJI_ADDED + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] - noEmojisAllowedInTarget: false + checkTypeCode: EMOJI_CONSISTENCY + subTypes: + - checkSubTypeCode: EMOJI_PRESENT + severityLevelCode: LOW + - checkSubTypeCode: EMOJI_DELETED + severityLevelCode: DISABLED + - checkSubTypeCode: EMOJI_ADDED + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] + noEmojisAllowedInTarget: false INSERTABLE_CONSISTENCY: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: INSERTABLE_CONSISTENCY - subTypes: - - checkSubTypeCode: INSERTABLE_DELETED - severityLevelCode: LOW - - checkSubTypeCode: INSERTABLE_ADDED + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] + checkTypeCode: INSERTABLE_CONSISTENCY + subTypes: + - checkSubTypeCode: INSERTABLE_DELETED + severityLevelCode: LOW + - checkSubTypeCode: INSERTABLE_ADDED + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] TARGET_SOURCE_CONSISTENCY: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: TARGET_SOURCE_CONSISTENCY - subTypes: - - checkSubTypeCode: SAME_TRANSLATION_DIFFERENT_SOURCES - severityLevelCode: LOW - - checkSubTypeCode: SAME_SOURCE_DIFFERENT_TRANSLATIONS + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: LOW - localeSeverityLevels: [] - groups: [] - ignoreTagsAndPlaceholders: true - ignoreCase: true + checkTypeCode: TARGET_SOURCE_CONSISTENCY + subTypes: + - checkSubTypeCode: SAME_TRANSLATION_DIFFERENT_SOURCES + severityLevelCode: LOW + - checkSubTypeCode: SAME_SOURCE_DIFFERENT_TRANSLATIONS + severityLevelCode: LOW + localeSeverityLevels: [] + groups: [] + ignoreTagsAndPlaceholders: true + ignoreCase: true BLACKLISTED_TERMS: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: MEDIUM - checkTypeCode: BLACKLISTED_TERMS - subTypes: [] - localeSeverityLevels: [] - groups: [] + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: MEDIUM + checkTypeCode: BLACKLISTED_TERMS + subTypes: [] + localeSeverityLevels: [] + groups: [] GLOSSARY_COMPLIANCE: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: DISABLED - checkTypeCode: GLOSSARY_COMPLIANCE - subTypes: [] - localeSeverityLevels: [] - groups: [] - matchMethod: MATCH_BY_PERCENTAGE - matchThreshold: 50 - sameTermCount: true + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: DISABLED + checkTypeCode: GLOSSARY_COMPLIANCE + subTypes: [] + localeSeverityLevels: [] + groups: [] + matchMethod: MATCH_BY_PERCENTAGE + matchThreshold: 50 + sameTermCount: true TRADEMARK_CONSISTENCY: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: TRADEMARK_CONSISTENCY - subTypes: [] - localeSeverityLevels: [] - groups: [] + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: TRADEMARK_CONSISTENCY + subTypes: [] + localeSeverityLevels: [] + groups: [] GRAMMAR_CHECK: value: response: @@ -2070,58 +2121,73 @@ x-paths: groups: [] GLOBAL_CAPITALISATION_CONSISTENCY: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: GLOBAL_CAPITALISATION_CONSISTENCY - subTypes: [] - localeSeverityLevels: [] - groups: [] + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: GLOBAL_CAPITALISATION_CONSISTENCY + subTypes: [] + localeSeverityLevels: [] + groups: [] PUNCTUATION_CONSISTENCY: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: PUNCTUATION_CONSISTENCY - subTypes: [] - localeSeverityLevels: [] - groups: [] + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: PUNCTUATION_CONSISTENCY + subTypes: [] + localeSeverityLevels: [] + groups: [] PLURALS_REPETITION: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: MEDIUM - checkTypeCode: PLURALS_REPETITION - subTypes: [] - localeSeverityLevels: [] - groups: [] + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: MEDIUM + checkTypeCode: PLURALS_REPETITION + subTypes: [] + localeSeverityLevels: [] + groups: [] REGEX_CHECK: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: REGEX_CHECK - subTypes: [] - groups: [] - rules: - - ruleUid: 2d83ea74c848 + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: LOW - ruleName: ruleName1 - ruleTypeCode: FORBIDDEN - flavorCode: JAVA - originalPattern: '@mail' - translationPattern: '@gmail' - description: ruleName1 description - caseInsensitive: true - multiLine: false - warningMessage: test warning + checkTypeCode: REGEX_CHECK + subTypes: [] groups: [] + rules: + - ruleUid: 2d83ea74c848 + severityLevelCode: LOW + ruleName: ruleName1 + ruleTypeCode: FORBIDDEN + flavorCode: JAVA + originalPattern: '@mail' + translationPattern: '@gmail' + description: ruleName1 description + caseInsensitive: true + multiLine: false + warningMessage: test warning + groups: [] OPEN_ISSUES: value: - profileUid: ce6d6b5dbc12 - severityLevelCode: LOW - checkTypeCode: OPEN_ISSUES - subTypes: [] - localeSeverityLevels: [] - groups: [] - sourceIssuesMustBeResolved: true - translationIssuesMustBeResolved: true + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 + severityLevelCode: LOW + checkTypeCode: OPEN_ISSUES + subTypes: [] + localeSeverityLevels: [] + groups: [] + sourceIssuesMustBeResolved: true + translationIssuesMustBeResolved: true '400': *ref_12 '401': *ref_13 '429': *ref_14 diff --git a/spec/translation_quality/checks/blacklisted_terms.yaml b/spec/translation_quality/checks/blacklisted_terms.yaml index 23a24be7..4bd8ab94 100644 --- a/spec/translation_quality/checks/blacklisted_terms.yaml +++ b/spec/translation_quality/checks/blacklisted_terms.yaml @@ -80,12 +80,15 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "MEDIUM" - "checkTypeCode": "BLACKLISTED_TERMS" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "MEDIUM" + "checkTypeCode": "BLACKLISTED_TERMS" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] accounts_check_types_settings_example: "severityLevelCode": "MEDIUM" diff --git a/spec/translation_quality/checks/emoji_consistency.yaml b/spec/translation_quality/checks/emoji_consistency.yaml index 1f8008dd..05e90331 100644 --- a/spec/translation_quality/checks/emoji_consistency.yaml +++ b/spec/translation_quality/checks/emoji_consistency.yaml @@ -154,19 +154,22 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "EMOJI_CONSISTENCY" - "subTypes": - - "checkSubTypeCode": "EMOJI_PRESENT" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "EMOJI_DELETED" - "severityLevelCode": "DISABLED" - - "checkSubTypeCode": "EMOJI_ADDED" + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" "severityLevelCode": "LOW" - "localeSeverityLevels": [] - "groups": [] - "noEmojisAllowedInTarget": false + "checkTypeCode": "EMOJI_CONSISTENCY" + "subTypes": + - "checkSubTypeCode": "EMOJI_PRESENT" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "EMOJI_DELETED" + "severityLevelCode": "DISABLED" + - "checkSubTypeCode": "EMOJI_ADDED" + "severityLevelCode": "LOW" + "localeSeverityLevels": [] + "groups": [] + "noEmojisAllowedInTarget": false accounts_check_types_checkType_settings_example: noEmojisAllowedInTarget: true diff --git a/spec/translation_quality/checks/global_capitalisation_consistency.yaml b/spec/translation_quality/checks/global_capitalisation_consistency.yaml index d0ef366e..1da571b4 100644 --- a/spec/translation_quality/checks/global_capitalisation_consistency.yaml +++ b/spec/translation_quality/checks/global_capitalisation_consistency.yaml @@ -63,12 +63,15 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "GLOBAL_CAPITALISATION_CONSISTENCY" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "GLOBAL_CAPITALISATION_CONSISTENCY" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] accounts_check_types_settings_example: "severityLevelCode": "LOW" diff --git a/spec/translation_quality/checks/glossary_compliance.yaml b/spec/translation_quality/checks/glossary_compliance.yaml index b217fcf1..cea63655 100644 --- a/spec/translation_quality/checks/glossary_compliance.yaml +++ b/spec/translation_quality/checks/glossary_compliance.yaml @@ -240,15 +240,18 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "DISABLED" - "checkTypeCode": "GLOSSARY_COMPLIANCE" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] - "matchMethod": "MATCH_BY_PERCENTAGE" - "matchThreshold": 50 - "sameTermCount": true + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "DISABLED" + "checkTypeCode": "GLOSSARY_COMPLIANCE" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] + "matchMethod": "MATCH_BY_PERCENTAGE" + "matchThreshold": 50 + "sameTermCount": true accounts_check_types_checkType_settings_example: matchMethod: MATCH_BY_PERCENTAGE diff --git a/spec/translation_quality/checks/insertable_consistency.yaml b/spec/translation_quality/checks/insertable_consistency.yaml index a13a1725..b2a82c39 100644 --- a/spec/translation_quality/checks/insertable_consistency.yaml +++ b/spec/translation_quality/checks/insertable_consistency.yaml @@ -124,16 +124,19 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "INSERTABLE_CONSISTENCY" - "subTypes": - - "checkSubTypeCode": "INSERTABLE_DELETED" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "INSERTABLE_ADDED" + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" "severityLevelCode": "LOW" - "localeSeverityLevels": [] - "groups": [] + "checkTypeCode": "INSERTABLE_CONSISTENCY" + "subTypes": + - "checkSubTypeCode": "INSERTABLE_DELETED" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "INSERTABLE_ADDED" + "severityLevelCode": "LOW" + "localeSeverityLevels": [] + "groups": [] accounts_check_types_settings_example: "severityLevelCode": "LOW" diff --git a/spec/translation_quality/checks/non_translatable_text.yaml b/spec/translation_quality/checks/non_translatable_text.yaml index 3635e4d1..174c5fe5 100644 --- a/spec/translation_quality/checks/non_translatable_text.yaml +++ b/spec/translation_quality/checks/non_translatable_text.yaml @@ -128,20 +128,23 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "MEDIUM" - "checkTypeCode": "NON_TRANSLATABLE_TEXT" - "subTypes": - - "checkSubTypeCode": "PLACEABLE_DELETED" - "severityLevelCode": "MEDIUM" - - "checkSubTypeCode": "SPACES_AROUND_PLACEABLE" - "severityLevelCode": "MEDIUM" - - "checkSubTypeCode": "PLACEABLE_ADDED" - "severityLevelCode": "MEDIUM" - - "checkSubTypeCode": "PLACEABLE_FORMAT" - "severityLevelCode": "MEDIUM" - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "MEDIUM" + "checkTypeCode": "NON_TRANSLATABLE_TEXT" + "subTypes": + - "checkSubTypeCode": "PLACEABLE_DELETED" + "severityLevelCode": "MEDIUM" + - "checkSubTypeCode": "SPACES_AROUND_PLACEABLE" + "severityLevelCode": "MEDIUM" + - "checkSubTypeCode": "PLACEABLE_ADDED" + "severityLevelCode": "MEDIUM" + - "checkSubTypeCode": "PLACEABLE_FORMAT" + "severityLevelCode": "MEDIUM" + "localeSeverityLevels": [] + "groups": [] accounts_check_types_settings_example: "severityLevelCode": "MEDIUM" diff --git a/spec/translation_quality/checks/number_consistency.yaml b/spec/translation_quality/checks/number_consistency.yaml index 34c58516..083e3028 100644 --- a/spec/translation_quality/checks/number_consistency.yaml +++ b/spec/translation_quality/checks/number_consistency.yaml @@ -171,21 +171,24 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "NUMBER_CONSISTENCY" - "subTypes": - - "checkSubTypeCode": "NUMBER_DELETED" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "NUMBER_ADDED" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "NUMBER_INCORRECT_CONVERSION" + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" "severityLevelCode": "LOW" - "localeSeverityLevels": [] - "groups": - - "groupUid": "b0dd258b05ee" - - "groupUid": "a853df2cf8ac" - "ignoreSign": true + "checkTypeCode": "NUMBER_CONSISTENCY" + "subTypes": + - "checkSubTypeCode": "NUMBER_DELETED" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "NUMBER_ADDED" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "NUMBER_INCORRECT_CONVERSION" + "severityLevelCode": "LOW" + "localeSeverityLevels": [] + "groups": + - "groupUid": "b0dd258b05ee" + - "groupUid": "a853df2cf8ac" + "ignoreSign": true accounts_check_types_settings_example: "response": diff --git a/spec/translation_quality/checks/open_issues.yaml b/spec/translation_quality/checks/open_issues.yaml index f39c4e00..cdc54d7f 100644 --- a/spec/translation_quality/checks/open_issues.yaml +++ b/spec/translation_quality/checks/open_issues.yaml @@ -132,14 +132,17 @@ components: "translationIssuesMustBeResolved": true profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "OPEN_ISSUES" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] - "sourceIssuesMustBeResolved": true - "translationIssuesMustBeResolved": true + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "OPEN_ISSUES" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] + "sourceIssuesMustBeResolved": true + "translationIssuesMustBeResolved": true accounts_check_types_checkType_settings_example: sourceIssuesMustBeResolved: true diff --git a/spec/translation_quality/checks/original_equals_target.yaml b/spec/translation_quality/checks/original_equals_target.yaml index 817ac385..1f1cf5a4 100644 --- a/spec/translation_quality/checks/original_equals_target.yaml +++ b/spec/translation_quality/checks/original_equals_target.yaml @@ -133,14 +133,17 @@ components: "mustHaveIdenticalCapitalization": true profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "ORIGINAL_EQUALS_TARGET" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] - "mustHaveIdenticalTags": true - "mustHaveIdenticalCapitalization": true + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "ORIGINAL_EQUALS_TARGET" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] + "mustHaveIdenticalTags": true + "mustHaveIdenticalCapitalization": true accounts_check_types_checkType_settings_example: mustHaveIdenticalTags: false diff --git a/spec/translation_quality/checks/plurals_repetition.yaml b/spec/translation_quality/checks/plurals_repetition.yaml index a4006d72..0f41854f 100644 --- a/spec/translation_quality/checks/plurals_repetition.yaml +++ b/spec/translation_quality/checks/plurals_repetition.yaml @@ -73,12 +73,15 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "MEDIUM" - "checkTypeCode": "PLURALS_REPETITION" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "MEDIUM" + "checkTypeCode": "PLURALS_REPETITION" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] accounts_check_types_settings_example: "severityLevelCode": "MEDIUM" diff --git a/spec/translation_quality/checks/punctuation_consistency.yaml b/spec/translation_quality/checks/punctuation_consistency.yaml index 5a334814..6f6e34d4 100644 --- a/spec/translation_quality/checks/punctuation_consistency.yaml +++ b/spec/translation_quality/checks/punctuation_consistency.yaml @@ -63,12 +63,15 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "PUNCTUATION_CONSISTENCY" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "PUNCTUATION_CONSISTENCY" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] accounts_check_types_settings_example: "severityLevelCode": "LOW" diff --git a/spec/translation_quality/checks/regex_check.yaml b/spec/translation_quality/checks/regex_check.yaml index 0d6b7a9b..8384aeb1 100644 --- a/spec/translation_quality/checks/regex_check.yaml +++ b/spec/translation_quality/checks/regex_check.yaml @@ -138,24 +138,27 @@ components: "groups": [] profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "REGEX_CHECK" - "subTypes": [] - "groups": [] - "rules": - - "ruleUid": "2d83ea74c848" + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" "severityLevelCode": "LOW" - "ruleName": "ruleName1" - "ruleTypeCode": "FORBIDDEN" - "flavorCode": "JAVA" - "originalPattern": "@mail" - "translationPattern": "@gmail" - "description": "ruleName1 description" - "caseInsensitive": true - "multiLine": false - "warningMessage": "test warning" + "checkTypeCode": "REGEX_CHECK" + "subTypes": [] "groups": [] + "rules": + - "ruleUid": "2d83ea74c848" + "severityLevelCode": "LOW" + "ruleName": "ruleName1" + "ruleTypeCode": "FORBIDDEN" + "flavorCode": "JAVA" + "originalPattern": "@mail" + "translationPattern": "@gmail" + "description": "ruleName1 description" + "caseInsensitive": true + "multiLine": false + "warningMessage": "test warning" + "groups": [] tqc_check_response_example: "response": diff --git a/spec/translation_quality/checks/repeated_word.yaml b/spec/translation_quality/checks/repeated_word.yaml index bdc57a22..671327c2 100644 --- a/spec/translation_quality/checks/repeated_word.yaml +++ b/spec/translation_quality/checks/repeated_word.yaml @@ -68,12 +68,15 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "REPEATED_WORD" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "REPEATED_WORD" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] accounts_check_types_settings_example: "severityLevelCode": "LOW" diff --git a/spec/translation_quality/checks/segment_completeness.yaml b/spec/translation_quality/checks/segment_completeness.yaml index 1d308dab..2895a77b 100644 --- a/spec/translation_quality/checks/segment_completeness.yaml +++ b/spec/translation_quality/checks/segment_completeness.yaml @@ -147,21 +147,24 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "MEDIUM" - "checkTypeCode": "SEGMENT_COMPLETENESS" - "subTypes": - - "checkSubTypeCode": "TARGET_IS_MUCH_SHORTER_THAN_SOURCE" - "severityLevelCode": "MEDIUM" - - "checkSubTypeCode": "TARGET_IS_MUCH_LONGER_THAN_SOURCE" + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" "severityLevelCode": "MEDIUM" - - "checkSubTypeCode": "TARGET_IS_EMPTY" - "severityLevelCode": "DISABLED" - "localeSeverityLevels": [] - "groups": [] - "lowerLengthThreshold": 50 - "upperLengthThreshold": 250 - "minLengthThreshold": 10 + "checkTypeCode": "SEGMENT_COMPLETENESS" + "subTypes": + - "checkSubTypeCode": "TARGET_IS_MUCH_SHORTER_THAN_SOURCE" + "severityLevelCode": "MEDIUM" + - "checkSubTypeCode": "TARGET_IS_MUCH_LONGER_THAN_SOURCE" + "severityLevelCode": "MEDIUM" + - "checkSubTypeCode": "TARGET_IS_EMPTY" + "severityLevelCode": "DISABLED" + "localeSeverityLevels": [] + "groups": [] + "lowerLengthThreshold": 50 + "upperLengthThreshold": 250 + "minLengthThreshold": 10 accounts_check_types_settings_example: "severityLevelCode": "MEDIUM" diff --git a/spec/translation_quality/checks/source_in_wrong_language.yaml b/spec/translation_quality/checks/source_in_wrong_language.yaml index 10a12176..fc371cc4 100644 --- a/spec/translation_quality/checks/source_in_wrong_language.yaml +++ b/spec/translation_quality/checks/source_in_wrong_language.yaml @@ -88,13 +88,16 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "SOURCE_IN_WRONG_LANGUAGE" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] - "minTextLengthLimit": 40 + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "SOURCE_IN_WRONG_LANGUAGE" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] + "minTextLengthLimit": 40 accounts_check_types_settings_example: "severityLevelCode": "LOW" diff --git a/spec/translation_quality/checks/spellcheck.yaml b/spec/translation_quality/checks/spellcheck.yaml index 3ac122c7..920e26c9 100644 --- a/spec/translation_quality/checks/spellcheck.yaml +++ b/spec/translation_quality/checks/spellcheck.yaml @@ -128,17 +128,20 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "SPELLCHECK" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] - "skipIfWordInUserDictionary": true - "skipIfWordStartsWithCapitalLetter": false - "skipIfWordAppearsInSourceString": true - "skipIfWordValidInSourceLocale": false - "runSpellcheckForSubWords": false + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "SPELLCHECK" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] + "skipIfWordInUserDictionary": true + "skipIfWordStartsWithCapitalLetter": false + "skipIfWordAppearsInSourceString": true + "skipIfWordValidInSourceLocale": false + "runSpellcheckForSubWords": false accounts_check_types_settings_example: "severityLevelCode": "LOW" diff --git a/spec/translation_quality/checks/tag_consistency.yaml b/spec/translation_quality/checks/tag_consistency.yaml index 8a7d246a..d819c53d 100644 --- a/spec/translation_quality/checks/tag_consistency.yaml +++ b/spec/translation_quality/checks/tag_consistency.yaml @@ -126,20 +126,23 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "TAG_CONSISTENCY" - "subTypes": - - "checkSubTypeCode": "TAG_ADDED" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "TAG_DELETED" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "TAG_ORDER_IS_CHANGED" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "SPACES_AROUND_TAGS" - "severityLevelCode": "LOW" - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "TAG_CONSISTENCY" + "subTypes": + - "checkSubTypeCode": "TAG_ADDED" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "TAG_DELETED" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "TAG_ORDER_IS_CHANGED" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "SPACES_AROUND_TAGS" + "severityLevelCode": "LOW" + "localeSeverityLevels": [] + "groups": [] accounts_check_types_settings_example: "severityLevelCode": "LOW" diff --git a/spec/translation_quality/checks/target_in_wrong_language.yaml b/spec/translation_quality/checks/target_in_wrong_language.yaml index 562f1c5d..7fc76765 100644 --- a/spec/translation_quality/checks/target_in_wrong_language.yaml +++ b/spec/translation_quality/checks/target_in_wrong_language.yaml @@ -89,13 +89,16 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "TARGET_IN_WRONG_LANGUAGE" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] - "minTextLengthLimit": 40 + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "TARGET_IN_WRONG_LANGUAGE" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] + "minTextLengthLimit": 40 accounts_check_types_settings_example: "severityLevelCode": "LOW" diff --git a/spec/translation_quality/checks/target_length_limit.yaml b/spec/translation_quality/checks/target_length_limit.yaml index 6f6baefe..08b8c5b7 100644 --- a/spec/translation_quality/checks/target_length_limit.yaml +++ b/spec/translation_quality/checks/target_length_limit.yaml @@ -63,12 +63,15 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "HIGH" - "checkTypeCode": "TARGET_LENGTH_LIMIT" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "HIGH" + "checkTypeCode": "TARGET_LENGTH_LIMIT" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] accounts_check_types_settings_example: "severityLevelCode": "HIGH" diff --git a/spec/translation_quality/checks/target_source_consistency.yaml b/spec/translation_quality/checks/target_source_consistency.yaml index 612be8e7..20f8fd7c 100644 --- a/spec/translation_quality/checks/target_source_consistency.yaml +++ b/spec/translation_quality/checks/target_source_consistency.yaml @@ -149,18 +149,21 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "TARGET_SOURCE_CONSISTENCY" - "subTypes": - - "checkSubTypeCode": "SAME_TRANSLATION_DIFFERENT_SOURCES" - "severityLevelCode": "LOW" - - "checkSubTypeCode": "SAME_SOURCE_DIFFERENT_TRANSLATIONS" + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" "severityLevelCode": "LOW" - "localeSeverityLevels": [] - "groups": [] - "ignoreTagsAndPlaceholders": true - "ignoreCase": true + "checkTypeCode": "TARGET_SOURCE_CONSISTENCY" + "subTypes": + - "checkSubTypeCode": "SAME_TRANSLATION_DIFFERENT_SOURCES" + "severityLevelCode": "LOW" + - "checkSubTypeCode": "SAME_SOURCE_DIFFERENT_TRANSLATIONS" + "severityLevelCode": "LOW" + "localeSeverityLevels": [] + "groups": [] + "ignoreTagsAndPlaceholders": true + "ignoreCase": true accounts_check_types_settings_example: "severityLevelCode": "LOW" diff --git a/spec/translation_quality/checks/trademark_consistency.yaml b/spec/translation_quality/checks/trademark_consistency.yaml index ffcba590..452c8c58 100644 --- a/spec/translation_quality/checks/trademark_consistency.yaml +++ b/spec/translation_quality/checks/trademark_consistency.yaml @@ -73,12 +73,15 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "TRADEMARK_CONSISTENCY" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "TRADEMARK_CONSISTENCY" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] accounts_check_types_settings_example: "severityLevelCode": "LOW" diff --git a/spec/translation_quality/checks/whitespaces.yaml b/spec/translation_quality/checks/whitespaces.yaml index 175008c3..df6bc1e5 100644 --- a/spec/translation_quality/checks/whitespaces.yaml +++ b/spec/translation_quality/checks/whitespaces.yaml @@ -63,12 +63,15 @@ components: examples: profiles_account_check_types_settings_effective_example: - "profileUid": "ce6d6b5dbc12" - "severityLevelCode": "LOW" - "checkTypeCode": "WHITESPACES" - "subTypes": [] - "localeSeverityLevels": [] - "groups": [] + "response": + "code": "SUCCESS" + "data": + "profileUid": "ce6d6b5dbc12" + "severityLevelCode": "LOW" + "checkTypeCode": "WHITESPACES" + "subTypes": [] + "localeSeverityLevels": [] + "groups": [] accounts_check_types_settings_example: "severityLevelCode": "LOW" From f55911f58e07ab0fdb4c8d53a3a868f13e2f865a Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Wed, 23 Oct 2024 12:57:47 +0300 Subject: [PATCH 19/21] added change --- spec/translation_quality/accounts_result.yaml | 155 ++++++++---------- .../checks/original_equals_target.yaml | 1 - .../checks/source_in_wrong_language.yaml | 1 - .../checks/spellcheck.yaml | 1 - .../checks/target_in_wrong_language.yaml | 1 - .../checks/target_source_consistency.yaml | 1 - 6 files changed, 65 insertions(+), 95 deletions(-) diff --git a/spec/translation_quality/accounts_result.yaml b/spec/translation_quality/accounts_result.yaml index affac9e7..529e3069 100644 --- a/spec/translation_quality/accounts_result.yaml +++ b/spec/translation_quality/accounts_result.yaml @@ -194,7 +194,7 @@ x-paths: - *ref_1 - *ref_5 - allOf: - - &ref_23 + - &ref_22 type: object properties: matchMethod: @@ -213,7 +213,7 @@ x-paths: minimum: 0 maximum: 100 example: 10 - - &ref_24 + - &ref_23 type: object properties: sameTermCount: @@ -334,7 +334,7 @@ x-paths: allOf: - *ref_1 - *ref_6 - - &ref_21 + - &ref_20 type: object properties: ignoreSign: @@ -377,7 +377,7 @@ x-paths: allOf: - *ref_1 - *ref_5 - - &ref_25 + - &ref_24 type: object properties: mustHaveIdenticalTags: @@ -414,7 +414,7 @@ x-paths: allOf: - *ref_1 - *ref_6 - - &ref_26 + - &ref_25 type: object properties: lowerLengthThreshold: @@ -558,7 +558,7 @@ x-paths: allOf: - *ref_1 - *ref_5 - - &ref_20 + - &ref_19 type: object properties: minTextLengthLimit: @@ -590,7 +590,7 @@ x-paths: allOf: - *ref_1 - *ref_6 - - &ref_22 + - &ref_21 type: object properties: ignoreTagsAndPlaceholders: @@ -802,7 +802,7 @@ x-paths: allOf: - *ref_1 - *ref_5 - - &ref_27 + - &ref_26 type: object properties: sourceIssuesMustBeResolved: @@ -2208,7 +2208,7 @@ x-paths: parameters: - *ref_8 - *ref_9 - - &ref_29 + - &ref_28 name: checkTypeCode in: path required: true @@ -2232,92 +2232,87 @@ x-paths: application/json: schema: oneOf: - - &ref_30 + - &ref_29 title: EMOJI_CONSISTENCY allOf: - *ref_16 - type: object required: - noEmojisAllowedInTarget - - title: SPELLCHECK + - &ref_30 + title: SPELLCHECK allOf: - *ref_17 - - &ref_19 - type: object - properties: - targetLocaleId: - type: string - description: >- - Smartling ID for the language you want to translate - to. - example: it-IT - required: - - targetLocaleId - - &ref_31 - type: object + - type: object required: - skipIfWordInUserDictionary - skipIfWordStartsWithCapitalLetter - skipIfWordAppearsInSourceString - skipIfWordValidInSourceLocale - runSpellcheckForSubWords - - title: SOURCE_IN_WRONG_LANGUAGE + - &ref_31 + title: SOURCE_IN_WRONG_LANGUAGE allOf: - *ref_18 - - *ref_19 - - &ref_32 - type: object + - type: object required: - minTextLengthLimit - - title: TARGET_IN_WRONG_LANGUAGE + - &ref_32 + title: TARGET_IN_WRONG_LANGUAGE allOf: - - &ref_33 - type: object + - type: object required: - minTextLengthLimit - *ref_19 + - &ref_33 + title: NUMBER_CONSISTENCY + allOf: - *ref_20 - &ref_34 - title: NUMBER_CONSISTENCY + title: TARGET_SOURCE_CONSISTENCY allOf: - *ref_21 - - title: TARGET_SOURCE_CONSISTENCY - allOf: - - *ref_22 - - *ref_19 - - &ref_35 - type: object + - type: object required: - ignoreTagsAndPlaceholders - ignoreCase - - &ref_36 + - &ref_35 title: GLOSSARY_COMPLIANCE allOf: - - &ref_28 + - &ref_27 allOf: + - *ref_22 - *ref_23 - - *ref_24 - type: object required: - matchMethod - matchThreshold - - title: ORIGINAL_EQUALS_TARGET + - &ref_36 + title: ORIGINAL_EQUALS_TARGET allOf: - - *ref_25 - - *ref_19 - - &ref_37 - type: object + - *ref_24 + - type: object required: - mustHaveIdenticalTags - mustHaveIdenticalCapitalization - title: SEGMENT_COMPLETENESS allOf: - - *ref_26 - - *ref_19 + - *ref_25 + - &ref_37 + type: object + properties: + targetLocaleId: + type: string + description: >- + Smartling ID for the language you want to translate + to. + example: it-IT + required: + - targetLocaleId - &ref_38 title: OPEN_ISSUES allOf: - - *ref_27 + - *ref_26 - type: object required: - sourceIssuesMustBeResolved @@ -2348,25 +2343,25 @@ x-paths: - *ref_18 - title: TARGET_IN_WRONG_LANGUAGE allOf: - - *ref_20 + - *ref_19 - title: NUMBER_CONSISTENCY allOf: - - *ref_21 + - *ref_20 - title: TARGET_SOURCE_CONSISTENCY allOf: - - *ref_22 + - *ref_21 - title: GLOSSARY_COMPLIANCE allOf: - - *ref_28 + - *ref_27 - title: ORIGINAL_EQUALS_TARGET allOf: - - *ref_25 + - *ref_24 - title: SEGMENT_COMPLETENESS allOf: - - *ref_26 + - *ref_25 - title: OPEN_ISSUES allOf: - - *ref_27 + - *ref_26 examples: EMOJI_CONSISTENCY: value: @@ -2459,7 +2454,7 @@ x-paths: parameters: - *ref_8 - *ref_9 - - *ref_29 + - *ref_28 - name: groupUid in: path schema: @@ -2473,38 +2468,18 @@ x-paths: application/json: schema: oneOf: + - *ref_29 - *ref_30 - - title: SPELLCHECK - allOf: - - *ref_17 - - *ref_19 - - *ref_31 - - title: SOURCE_IN_WRONG_LANGUAGE - allOf: - - *ref_18 - - *ref_19 - - *ref_32 - - title: TARGET_IN_WRONG_LANGUAGE - allOf: - - *ref_33 - - *ref_19 - - *ref_20 + - *ref_31 + - *ref_32 + - *ref_33 - *ref_34 - - title: TARGET_SOURCE_CONSISTENCY - allOf: - - *ref_22 - - *ref_19 - - *ref_35 + - *ref_35 - *ref_36 - - title: ORIGINAL_EQUALS_TARGET + - title: SEGMENT_COMPLETENESS allOf: - *ref_25 - - *ref_19 - *ref_37 - - title: SEGMENT_COMPLETENESS - allOf: - - *ref_26 - - *ref_19 - *ref_38 responses: '200': @@ -2706,7 +2681,7 @@ x-paths: - title: GLOSSARY_COMPLIANCE allOf: - *ref_5 - - *ref_23 + - *ref_22 - type: object properties: sameTermCount: @@ -2820,7 +2795,7 @@ x-paths: - title: NUMBER_CONSISTENCY allOf: - *ref_6 - - *ref_21 + - *ref_20 - type: object properties: checkTypeCode: @@ -2854,7 +2829,7 @@ x-paths: - title: ORIGINAL_EQUALS_TARGET allOf: - *ref_5 - - *ref_25 + - *ref_24 - type: object required: - checkTypeCode @@ -2879,7 +2854,7 @@ x-paths: - title: SEGMENT_COMPLETENESS allOf: - *ref_6 - - *ref_26 + - *ref_25 - type: object properties: checkTypeCode: @@ -2973,7 +2948,7 @@ x-paths: - title: TARGET_IN_WRONG_LANGUAGE allOf: - *ref_5 - - *ref_20 + - *ref_19 - type: object properties: checkTypeCode: @@ -2996,7 +2971,7 @@ x-paths: - title: TARGET_SOURCE_CONSISTENCY allOf: - *ref_6 - - *ref_22 + - *ref_21 - type: object properties: checkTypeCode: @@ -3087,7 +3062,7 @@ x-paths: - title: OPEN_ISSUES allOf: - *ref_5 - - *ref_27 + - *ref_26 - type: object required: - checkTypeCode diff --git a/spec/translation_quality/checks/original_equals_target.yaml b/spec/translation_quality/checks/original_equals_target.yaml index 1f1cf5a4..a067a62e 100644 --- a/spec/translation_quality/checks/original_equals_target.yaml +++ b/spec/translation_quality/checks/original_equals_target.yaml @@ -17,7 +17,6 @@ components: title: ORIGINAL_EQUALS_TARGET allOf: - $ref: '#/components/schemas/OriginalEqualsTargetSettingsDTO' - - $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' - type: object required: - mustHaveIdenticalTags diff --git a/spec/translation_quality/checks/source_in_wrong_language.yaml b/spec/translation_quality/checks/source_in_wrong_language.yaml index fc371cc4..f8b49e66 100644 --- a/spec/translation_quality/checks/source_in_wrong_language.yaml +++ b/spec/translation_quality/checks/source_in_wrong_language.yaml @@ -14,7 +14,6 @@ components: title: SOURCE_IN_WRONG_LANGUAGE allOf: - $ref: '#/components/schemas/SourceInWrongLanguageSettingsDTO' - - $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' - type: object required: - minTextLengthLimit diff --git a/spec/translation_quality/checks/spellcheck.yaml b/spec/translation_quality/checks/spellcheck.yaml index 920e26c9..33b506ae 100644 --- a/spec/translation_quality/checks/spellcheck.yaml +++ b/spec/translation_quality/checks/spellcheck.yaml @@ -29,7 +29,6 @@ components: title: SPELLCHECK allOf: - $ref: '#/components/schemas/SpellcheckSettingsDTO' - - $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' - type: object required: - skipIfWordInUserDictionary diff --git a/spec/translation_quality/checks/target_in_wrong_language.yaml b/spec/translation_quality/checks/target_in_wrong_language.yaml index 7fc76765..ab9009a6 100644 --- a/spec/translation_quality/checks/target_in_wrong_language.yaml +++ b/spec/translation_quality/checks/target_in_wrong_language.yaml @@ -7,7 +7,6 @@ components: - type: object required: - minTextLengthLimit - - $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' - $ref: '#/components/schemas/responseFields/minTextLengthLimit' AccountCheckTypeApplySettingsDTOResponse: diff --git a/spec/translation_quality/checks/target_source_consistency.yaml b/spec/translation_quality/checks/target_source_consistency.yaml index 20f8fd7c..04d4083b 100644 --- a/spec/translation_quality/checks/target_source_consistency.yaml +++ b/spec/translation_quality/checks/target_source_consistency.yaml @@ -16,7 +16,6 @@ components: title: TARGET_SOURCE_CONSISTENCY allOf: - $ref: '#/components/schemas/SourceConsistencySettingsDTO' - - $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' - type: object required: - ignoreTagsAndPlaceholders From 47e7dc779b7a908a4ae4607fcc306c8ddf869e5b Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Wed, 23 Oct 2024 16:50:59 +0300 Subject: [PATCH 20/21] added change --- spec/translation_quality/accounts_result.yaml | 2 +- spec/translation_quality/tqc_common.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/translation_quality/accounts_result.yaml b/spec/translation_quality/accounts_result.yaml index 529e3069..faa40d34 100644 --- a/spec/translation_quality/accounts_result.yaml +++ b/spec/translation_quality/accounts_result.yaml @@ -2331,7 +2331,7 @@ x-paths: - type: object properties: data: &ref_39 - oneOf: + anyOf: - title: EMOJI_CONSISTENCY allOf: - *ref_16 diff --git a/spec/translation_quality/tqc_common.yaml b/spec/translation_quality/tqc_common.yaml index 6326a6b2..8305e5c7 100644 --- a/spec/translation_quality/tqc_common.yaml +++ b/spec/translation_quality/tqc_common.yaml @@ -676,7 +676,7 @@ components: - $ref: 'checks/open_issues.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' ProfilesAccountCheckTypeApplySettingsDTOResponseOneOfCommon: - oneOf: + anyOf: - $ref: 'checks/emoji_consistency.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' - $ref: 'checks/spellcheck.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' - $ref: 'checks/source_in_wrong_language.yaml#/components/schemas/AccountCheckTypeApplySettingsDTOResponse' From 84aad982ae4c55af495bbc0e940f05c12a9b61c0 Mon Sep 17 00:00:00 2001 From: alubenskyi Date: Wed, 23 Oct 2024 18:36:47 +0300 Subject: [PATCH 21/21] fix comments --- spec/translation_quality/accounts_result.yaml | 222 ++---------------- .../checks/emoji_consistency.yaml | 18 +- .../checks/insertable_consistency.yaml | 19 +- .../checks/non_translatable_text.yaml | 20 +- .../checks/number_consistency.yaml | 19 +- .../checks/regex_check.yaml | 3 +- .../checks/segment_completeness.yaml | 19 +- .../checks/tag_consistency.yaml | 20 +- .../checks/target_source_consistency.yaml | 18 +- .../translation_quality/tqc_check_result.yaml | 213 +++++++++-------- spec/translation_quality/tqc_common.yaml | 3 + 11 files changed, 144 insertions(+), 430 deletions(-) diff --git a/spec/translation_quality/accounts_result.yaml b/spec/translation_quality/accounts_result.yaml index faa40d34..d1f239b7 100644 --- a/spec/translation_quality/accounts_result.yaml +++ b/spec/translation_quality/accounts_result.yaml @@ -168,15 +168,7 @@ x-paths: - EMOJI_PRESENT description: check subtype code example: EMOJI_ADDED - severityLevelCode: - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: GLOBAL_CAPITALISATION_CONSISTENCY allOf: - *ref_1 @@ -269,16 +261,7 @@ x-paths: - INSERTABLE_DELETED description: check subtype code example: INSERTABLE_ADDED - severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: LEADING_TRAILING_SPACES allOf: - *ref_1 @@ -320,16 +303,7 @@ x-paths: - PLACEABLE_FORMAT description: check subtype code example: PLACEABLE_ADDED - severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: NUMBER_CONSISTENCY allOf: - *ref_1 @@ -363,16 +337,7 @@ x-paths: - NUMBER_INCORRECT_CONVERSION description: check subtype code example: NUMBER_ADDED - severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: ORIGINAL_EQUALS_TARGET allOf: - *ref_1 @@ -451,16 +416,7 @@ x-paths: - TARGET_IS_MUCH_LONGER_THAN_SOURCE description: check subtype code example: TARGET_IS_EMPTY - severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: SOURCE_IN_WRONG_LANGUAGE allOf: - *ref_1 @@ -544,16 +500,7 @@ x-paths: - TAG_ORDER_IS_CHANGED description: check subtype code example: TAG_ADDED - severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: TARGET_IN_WRONG_LANGUAGE allOf: - *ref_1 @@ -621,15 +568,7 @@ x-paths: - SAME_TRANSLATION_DIFFERENT_SOURCES description: check subtype code example: SAME_SOURCE_DIFFERENT_TRANSLATIONS - severityLevelCode: - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: TRADEMARK_CONSISTENCY allOf: - *ref_1 @@ -1386,16 +1325,7 @@ x-paths: - TAG_ORDER_IS_CHANGED description: check subtype code example: TAG_ADDED - severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: TARGET_LENGTH_LIMIT allOf: - *ref_1 @@ -1440,16 +1370,7 @@ x-paths: - NUMBER_INCORRECT_CONVERSION description: check subtype code example: NUMBER_ADDED - severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: REPEATED_WORD allOf: - *ref_1 @@ -1540,16 +1461,7 @@ x-paths: - TARGET_IS_MUCH_LONGER_THAN_SOURCE description: check subtype code example: TARGET_IS_EMPTY - severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: NON_TRANSLATABLE_TEXT allOf: - *ref_1 @@ -1577,16 +1489,7 @@ x-paths: - PLACEABLE_FORMAT description: check subtype code example: PLACEABLE_ADDED - severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: EMOJI_CONSISTENCY allOf: - *ref_1 @@ -1618,15 +1521,7 @@ x-paths: - EMOJI_PRESENT description: check subtype code example: EMOJI_ADDED - severityLevelCode: - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: INSERTABLE_CONSISTENCY allOf: - *ref_1 @@ -1652,16 +1547,7 @@ x-paths: - INSERTABLE_DELETED description: check subtype code example: INSERTABLE_ADDED - severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: TARGET_SOURCE_CONSISTENCY allOf: - *ref_1 @@ -1696,15 +1582,7 @@ x-paths: - SAME_TRANSLATION_DIFFERENT_SOURCES description: check subtype code example: SAME_SOURCE_DIFFERENT_TRANSLATIONS - severityLevelCode: - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: BLACKLISTED_TERMS allOf: - *ref_1 @@ -2658,15 +2536,7 @@ x-paths: - EMOJI_PRESENT description: check subtype code example: EMOJI_ADDED - severityLevelCode: - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: GLOBAL_CAPITALISATION_CONSISTENCY allOf: - *ref_5 @@ -2734,15 +2604,7 @@ x-paths: - INSERTABLE_DELETED description: check subtype code example: INSERTABLE_ADDED - severityLevelCode: - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: LEADING_TRAILING_SPACES allOf: - *ref_5 @@ -2782,16 +2644,7 @@ x-paths: - PLACEABLE_FORMAT description: check subtype code example: PLACEABLE_ADDED - severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: NUMBER_CONSISTENCY allOf: - *ref_6 @@ -2817,15 +2670,7 @@ x-paths: - NUMBER_INCORRECT_CONVERSION description: check subtype code example: NUMBER_ADDED - severityLevelCode: - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: ORIGINAL_EQUALS_TARGET allOf: - *ref_5 @@ -2876,15 +2721,7 @@ x-paths: - TARGET_IS_MUCH_LONGER_THAN_SOURCE description: check subtype code example: TARGET_IS_EMPTY - severityLevelCode: - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: SOURCE_IN_WRONG_LANGUAGE allOf: - *ref_5 @@ -2935,16 +2772,7 @@ x-paths: - TAG_ORDER_IS_CHANGED description: check subtype code example: TAG_ADDED - severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: TARGET_IN_WRONG_LANGUAGE allOf: - *ref_5 @@ -2992,15 +2820,7 @@ x-paths: - SAME_TRANSLATION_DIFFERENT_SOURCES description: check subtype code example: SAME_SOURCE_DIFFERENT_TRANSLATIONS - severityLevelCode: - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: LOW + severityLevelCode: *ref_0 - title: TRADEMARK_CONSISTENCY allOf: - *ref_5 diff --git a/spec/translation_quality/checks/emoji_consistency.yaml b/spec/translation_quality/checks/emoji_consistency.yaml index 05e90331..9173a0fb 100644 --- a/spec/translation_quality/checks/emoji_consistency.yaml +++ b/spec/translation_quality/checks/emoji_consistency.yaml @@ -49,14 +49,7 @@ components: description: check subtype code example: "EMOJI_ADDED" severityLevelCode: - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: "LOW" + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveDTO: title: EMOJI_CONSISTENCY @@ -86,14 +79,7 @@ components: description: check subtype code example: "EMOJI_ADDED" severityLevelCode: - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: "LOW" + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveResponse: allOf: diff --git a/spec/translation_quality/checks/insertable_consistency.yaml b/spec/translation_quality/checks/insertable_consistency.yaml index b2a82c39..86512e4c 100644 --- a/spec/translation_quality/checks/insertable_consistency.yaml +++ b/spec/translation_quality/checks/insertable_consistency.yaml @@ -26,14 +26,7 @@ components: description: check subtype code example: "INSERTABLE_ADDED" severityLevelCode: - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: "LOW" + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveDTO: title: INSERTABLE_CONSISTENCY @@ -62,15 +55,7 @@ components: description: check subtype code example: "INSERTABLE_ADDED" severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: "LOW" + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveResponse: allOf: diff --git a/spec/translation_quality/checks/non_translatable_text.yaml b/spec/translation_quality/checks/non_translatable_text.yaml index 174c5fe5..d49e6c1f 100644 --- a/spec/translation_quality/checks/non_translatable_text.yaml +++ b/spec/translation_quality/checks/non_translatable_text.yaml @@ -29,15 +29,7 @@ components: description: check subtype code example: "PLACEABLE_ADDED" severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: "LOW" + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveDTO: title: NON_TRANSLATABLE_TEXT @@ -68,15 +60,7 @@ components: description: check subtype code example: "PLACEABLE_ADDED" severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: "LOW" + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveResponse: allOf: diff --git a/spec/translation_quality/checks/number_consistency.yaml b/spec/translation_quality/checks/number_consistency.yaml index 083e3028..b1be8912 100644 --- a/spec/translation_quality/checks/number_consistency.yaml +++ b/spec/translation_quality/checks/number_consistency.yaml @@ -46,14 +46,7 @@ components: description: check subtype code example: "NUMBER_ADDED" severityLevelCode: - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: "LOW" + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveDTO: title: NUMBER_CONSISTENCY @@ -84,15 +77,7 @@ components: description: check subtype code example: "NUMBER_ADDED" severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: "LOW" + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveResponse: allOf: diff --git a/spec/translation_quality/checks/regex_check.yaml b/spec/translation_quality/checks/regex_check.yaml index 8384aeb1..5efeeb99 100644 --- a/spec/translation_quality/checks/regex_check.yaml +++ b/spec/translation_quality/checks/regex_check.yaml @@ -51,8 +51,7 @@ components: details: type: object nullable: true - oneOf: - - $ref: '../tqc_common.yaml#/components/schemas/regexRuleWithRuleUid' + $ref: '../tqc_common.yaml#/components/schemas/regexRuleWithRuleUid' positionTypeCode: type: string enum: diff --git a/spec/translation_quality/checks/segment_completeness.yaml b/spec/translation_quality/checks/segment_completeness.yaml index 2895a77b..88dbc587 100644 --- a/spec/translation_quality/checks/segment_completeness.yaml +++ b/spec/translation_quality/checks/segment_completeness.yaml @@ -55,14 +55,7 @@ components: description: check subtype code example: "TARGET_IS_EMPTY" severityLevelCode: - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: "LOW" + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveDTO: title: SEGMENT_COMPLETENESS @@ -93,15 +86,7 @@ components: description: check subtype code example: "TARGET_IS_EMPTY" severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: "LOW" + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveResponse: allOf: diff --git a/spec/translation_quality/checks/tag_consistency.yaml b/spec/translation_quality/checks/tag_consistency.yaml index d819c53d..c39bbbcc 100644 --- a/spec/translation_quality/checks/tag_consistency.yaml +++ b/spec/translation_quality/checks/tag_consistency.yaml @@ -28,15 +28,7 @@ components: description: check subtype code example: "TAG_ADDED" severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: "LOW" + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveDTO: title: TAG_CONSISTENCY @@ -68,15 +60,7 @@ components: description: check subtype code example: "TAG_ADDED" severityLevelCode: - nullable: true - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: "LOW" + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveResponse: allOf: diff --git a/spec/translation_quality/checks/target_source_consistency.yaml b/spec/translation_quality/checks/target_source_consistency.yaml index 04d4083b..0b1265a1 100644 --- a/spec/translation_quality/checks/target_source_consistency.yaml +++ b/spec/translation_quality/checks/target_source_consistency.yaml @@ -52,14 +52,7 @@ components: description: check subtype code example: "SAME_SOURCE_DIFFERENT_TRANSLATIONS" severityLevelCode: - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: "LOW" + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveDTO: title: TARGET_SOURCE_CONSISTENCY @@ -88,14 +81,7 @@ components: description: check subtype code example: "SAME_SOURCE_DIFFERENT_TRANSLATIONS" severityLevelCode: - type: string - enum: - - LOW - - MEDIUM - - HIGH - - DISABLED - description: severity level code - example: "LOW" + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveResponse: allOf: diff --git a/spec/translation_quality/tqc_check_result.yaml b/spec/translation_quality/tqc_check_result.yaml index 99d90788..fda8ecb2 100644 --- a/spec/translation_quality/tqc_check_result.yaml +++ b/spec/translation_quality/tqc_check_result.yaml @@ -1054,114 +1054,111 @@ x-paths: description: check type code example: REGEX_CHECK details: - type: object - nullable: true - oneOf: - - allOf: - - type: object - properties: - ruleUid: - type: string - description: >- - Unique identifier of corresponding check - rule - example: ce6d6b5dbc12 - - type: object - properties: - ruleName: - type: string - description: Rule name - example: ruleName - severityLevelCode: - enum: - - DISABLED - - LOW - - MEDIUM - - HIGH - ruleTypeCode: - enum: - - FORBIDDEN - - MISSING - - COUNT_MISMATCH - flavorCode: - enum: - - JAVA - - DOT_NET - originalPattern: - type: string - description: >- - Regular expression to evaluate against - the source string. - example: '@mail' - translationPattern: - type: string - description: >- - Regular expression to evaluate against - the translation. - example: '@gmail' - caseInsensitive: - type: boolean - description: Enable case insensitive search - example: true - multiLine: - type: boolean - description: >- - Enables multine search. If true then - search will span newlines in a string. - Users can use ^ and $ characters with - special meaning for beginning of line - and end of line match. - example: true - description: - type: string - description: >- - Human readable description of the role; - shown in the the dashboard UI. - example: rule description - warningMessage: - type: string - description: >- - Human readable warning message appended - to the standard message that is shown in - the CAT tool when the check fails. - example: ' test warning message' - required: - - ruleName - - severityLevelCode - - ruleTypeCode - - flavorCode - - originalPattern - - translationPattern - - caseInsensitive - - multiLine - - type: object - properties: - groups: - type: array - items: - allOf: - - type: object - properties: - groupUid: - type: string - description: >- - Smartling rule group identifier of the - translation - example: ce6d6b5dbc12 - ruleUid: - type: string - description: >- - Smartling rule identifier of the - translation - example: ce6d6b5dbcs2 - targetLocaleIds: - description: The list of target locales. - example: - - ru-RU - items: - type: string - type: array - severityLevelCode: *ref_2 + allOf: + - type: object + properties: + ruleUid: + type: string + description: >- + Unique identifier of corresponding check + rule + example: ce6d6b5dbc12 + - type: object + properties: + ruleName: + type: string + description: Rule name + example: ruleName + severityLevelCode: + enum: + - DISABLED + - LOW + - MEDIUM + - HIGH + ruleTypeCode: + enum: + - FORBIDDEN + - MISSING + - COUNT_MISMATCH + flavorCode: + enum: + - JAVA + - DOT_NET + originalPattern: + type: string + description: >- + Regular expression to evaluate against + the source string. + example: '@mail' + translationPattern: + type: string + description: >- + Regular expression to evaluate against + the translation. + example: '@gmail' + caseInsensitive: + type: boolean + description: Enable case insensitive search + example: true + multiLine: + type: boolean + description: >- + Enables multine search. If true then + search will span newlines in a string. + Users can use ^ and $ characters with + special meaning for beginning of line + and end of line match. + example: true + description: + type: string + description: >- + Human readable description of the role; + shown in the the dashboard UI. + example: rule description + warningMessage: + type: string + description: >- + Human readable warning message appended + to the standard message that is shown in + the CAT tool when the check fails. + example: ' test warning message' + required: + - ruleName + - severityLevelCode + - ruleTypeCode + - flavorCode + - originalPattern + - translationPattern + - caseInsensitive + - multiLine + - type: object + properties: + groups: + type: array + items: + allOf: + - type: object + properties: + groupUid: + type: string + description: >- + Smartling rule group identifier of the + translation + example: ce6d6b5dbc12 + ruleUid: + type: string + description: >- + Smartling rule identifier of the + translation + example: ce6d6b5dbcs2 + targetLocaleIds: + description: The list of target locales. + example: + - ru-RU + items: + type: string + type: array + severityLevelCode: *ref_2 positionTypeCode: type: string enum: diff --git a/spec/translation_quality/tqc_common.yaml b/spec/translation_quality/tqc_common.yaml index 8305e5c7..cb8ea981 100644 --- a/spec/translation_quality/tqc_common.yaml +++ b/spec/translation_quality/tqc_common.yaml @@ -359,7 +359,10 @@ components: type: object properties: severityLevelCode: + type: string $ref: '#/components/schemas/severityLevelCodeEnum' + description: severity level code + example: "MEDIUM" severityLevelCodeResponse1: