diff --git a/spec/api_common.yaml b/spec/api_common.yaml index 3d5fccc3..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: 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: {} 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/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 325fd719..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' @@ -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. @@ -13922,12 +13923,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: {} Error401ResponseDefinition: description: Provided credentials are not valid. @@ -13941,9 +13942,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 +13958,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/process-yaml.js b/spec/process-yaml.js index ee3ec928..9d43f0df 100644 --- a/spec/process-yaml.js +++ b/spec/process-yaml.js @@ -41,7 +41,7 @@ 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"); 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..26d73274 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,11 +17,14 @@ 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 schema: &ref_0 + type: string + description: '[check type code](#operation/getTranslationQualityCheckTypes)' + example: LEADING_TRAILING_SPACES enum: - LEADING_TRAILING_SPACES - ORIGINAL_EQUALS_TARGET @@ -58,7 +61,7 @@ x-paths: properties: response: allOf: - - &ref_4 + - &ref_5 type: object required: - code @@ -74,22 +77,25 @@ 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 + type: string + description: severity level code + example: MEDIUM enum: - DISABLED - LOW - MEDIUM - HIGH - - &ref_7 + - &ref_8 type: object properties: checkTypeCode: *ref_0 @@ -99,7 +105,7 @@ x-paths: type: array items: allOf: - - &ref_8 + - &ref_9 type: object properties: checkSubTypeCode: @@ -132,7 +138,7 @@ x-paths: type: string description: check subtype name example: Emoji added - - &ref_9 + - &ref_10 type: object properties: severityLevelCode: *ref_1 @@ -142,7 +148,7 @@ x-paths: type: array items: allOf: - - &ref_10 + - &ref_11 type: object properties: targetLocaleId: @@ -158,6 +164,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 +325,8 @@ x-paths: - Translation quality checks operationId: getTranslationQualityCheckTypeGroupDetails parameters: - - *ref_2 - *ref_3 + - *ref_4 responses: '200': description: OK @@ -184,7 +337,7 @@ x-paths: properties: response: allOf: - - *ref_4 + - *ref_5 - type: object properties: data: @@ -198,29 +351,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 +392,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 +411,7 @@ x-paths: properties: response: allOf: - - *ref_4 + - *ref_5 - type: object properties: data: @@ -268,8 +425,8 @@ x-paths: type: array items: allOf: - - *ref_5 - - &ref_12 + - *ref_6 + - &ref_17 type: object properties: profileUid: @@ -278,28 +435,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 +474,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 +501,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 +549,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 +568,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 +614,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 +627,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 +651,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 +665,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 +711,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 +744,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 +789,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 +824,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 +844,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 +868,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/checks/accounts.yaml b/spec/translation_quality/accounts.yaml similarity index 50% rename from spec/translation_quality/checks/accounts.yaml rename to spec/translation_quality/accounts.yaml index 86e764c9..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,8 +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' + 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: | @@ -36,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: @@ -49,8 +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' + 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: | @@ -65,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: @@ -84,8 +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' + 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: | @@ -100,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: @@ -120,8 +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' + 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: | @@ -136,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: @@ -147,8 +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' + 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: | @@ -162,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: @@ -218,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: @@ -237,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: @@ -256,7 +291,7 @@ components: items: type: array items: - $ref: '../tqc_common.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTOAnyOf' + $ref: './tqc_common.yaml#/components/schemas/ProfilesAccountCheckTypeEffectiveDTOAnyOf' AccountCheckTypeEffectiveAbstractDTO: allOf: @@ -274,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 73% rename from spec/translation_quality/checks/accounts_result.yaml rename to spec/translation_quality/accounts_result.yaml index 59cfbb62..d1f239b7 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_0 + - &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_1 + - &ref_9 name: profileUid in: path required: true @@ -33,7 +33,7 @@ x-paths: properties: response: allOf: - - &ref_2 + - &ref_10 type: object required: - code @@ -59,10 +59,71 @@ 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 + type: string + description: severity level code + example: MEDIUM + enum: + - DISABLED + - LOW + - MEDIUM + - HIGH + - type: object + properties: + subTypes: + type: array + items: + type: object + properties: + checkSubTypeCode: + type: string + description: check subtype code + example: '' + severityLevelCode: + 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 +134,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_10 + - *ref_1 + - &ref_6 + allOf: + - *ref_2 + - *ref_3 + - *ref_4 + - &ref_16 type: object properties: noEmojisAllowedInTarget: @@ -105,12 +168,11 @@ x-paths: - EMOJI_PRESENT description: check subtype code example: EMOJI_ADDED + severityLevelCode: *ref_0 - 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 +183,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_16 + - &ref_22 type: object properties: matchMethod: @@ -145,7 +205,7 @@ x-paths: minimum: 0 maximum: 100 example: 10 - - &ref_17 + - &ref_23 type: object properties: sameTermCount: @@ -166,10 +226,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 +238,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: @@ -198,18 +254,18 @@ x-paths: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - INSERTABLE_ADDED - INSERTABLE_DELETED description: check subtype code example: INSERTABLE_ADDED + severityLevelCode: *ref_0 - 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 +278,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: @@ -240,6 +294,7 @@ x-paths: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - PLACEABLE_ADDED @@ -248,13 +303,12 @@ x-paths: - PLACEABLE_FORMAT description: check subtype code example: PLACEABLE_ADDED + severityLevelCode: *ref_0 - title: NUMBER_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_14 + - *ref_1 + - *ref_6 + - &ref_20 type: object properties: ignoreSign: @@ -276,19 +330,19 @@ x-paths: properties: checkSubTypeCode: type: string + nullable: true enum: - NUMBER_ADDED - NUMBER_DELETED - NUMBER_INCORRECT_CONVERSION description: check subtype code example: NUMBER_ADDED + severityLevelCode: *ref_0 - title: ORIGINAL_EQUALS_TARGET allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_18 + - *ref_1 + - *ref_5 + - &ref_24 type: object properties: mustHaveIdenticalTags: @@ -311,10 +365,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 +377,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_19 + - *ref_1 + - *ref_6 + - &ref_25 type: object properties: lowerLengthThreshold: @@ -358,6 +408,7 @@ x-paths: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - TARGET_IS_EMPTY @@ -365,13 +416,12 @@ x-paths: - TARGET_IS_MUCH_LONGER_THAN_SOURCE description: check subtype code example: TARGET_IS_EMPTY + severityLevelCode: *ref_0 - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_12 + - *ref_1 + - *ref_5 + - &ref_18 type: object properties: minTextLengthLimit: @@ -389,11 +439,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_11 + - *ref_1 + - *ref_5 + - &ref_17 type: object properties: skipIfWordInUserDictionary: @@ -426,10 +474,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: @@ -439,12 +485,14 @@ x-paths: description: check type code example: TAG_CONSISTENCY subTypes: + nullable: true type: array items: type: object properties: checkSubTypeCode: type: string + nullable: true enum: - TAG_ADDED - TAG_DELETED @@ -452,13 +500,12 @@ x-paths: - TAG_ORDER_IS_CHANGED description: check subtype code example: TAG_ADDED + severityLevelCode: *ref_0 - title: TARGET_IN_WRONG_LANGUAGE allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/profileUidResponse - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - &ref_13 + - *ref_1 + - *ref_5 + - &ref_19 type: object properties: minTextLengthLimit: @@ -476,10 +523,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 +535,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_15 + - *ref_1 + - *ref_6 + - &ref_21 type: object properties: ignoreTagsAndPlaceholders: @@ -525,12 +568,11 @@ x-paths: - SAME_TRANSLATION_DIFFERENT_SOURCES description: check subtype code example: SAME_SOURCE_DIFFERENT_TRANSLATIONS + severityLevelCode: *ref_0 - 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 +583,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 +595,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 +607,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 +619,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 +631,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_20 + - *ref_1 + - *ref_5 + - &ref_26 type: object properties: sourceIssuesMustBeResolved: @@ -635,7 +770,7 @@ x-paths: items: - profileUid: ce6d6b5dbc12 severityLevelCode: LOW - checkTypeCode: LEADING_TRAILING_SPACES 1 + checkTypeCode: LEADING_TRAILING_SPACES subTypes: [] localeSeverityLevels: [] groups: [] @@ -866,6 +1001,153 @@ x-paths: groups: [] sourceIssuesMustBeResolved: true translationIssuesMustBeResolved: true + '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_7 + 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_7 + 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_7 + 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_7 + type: array + required: + - code + - errors + type: object + required: + - response + type: object x-code-samples: - lang: curl source: > @@ -880,12 +1162,15 @@ x-paths: - Translation quality checks operationId: getProfilesSingleCheckTypeSettings parameters: - - *ref_0 - - *ref_1 + - *ref_8 + - *ref_9 - name: checkTypeCode in: path required: true schema: + type: string + description: '[check type code](#operation/getTranslationQualityCheckTypes)' + example: LEADING_TRAILING_SPACES enum: - LEADING_TRAILING_SPACES - ORIGINAL_EQUALS_TARGET @@ -923,71 +1208,15 @@ x-paths: properties: response: allOf: - - *ref_2 + - *ref_10 - type: object properties: data: anyOf: - title: LEADING_TRAILING_SPACES allOf: - - &ref_4 - type: object - properties: - profileUid: - type: string - description: >- - Unique identifier of corresponding - profile. - example: ce6d6b5dbc12 - - &ref_5 - allOf: - - &ref_6 - type: object - properties: - severityLevelCode: &ref_3 - enum: - - DISABLED - - LOW - - MEDIUM - - HIGH - - type: object - properties: - subTypes: - type: array - items: - type: object - properties: - checkSubTypeCode: - type: string - description: check subtype code - example: '' - - &ref_7 - 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_3 - - &ref_8 - 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 @@ -1000,7 +1229,7 @@ x-paths: example: LEADING_TRAILING_SPACES - title: WHITESPACES allOf: - - *ref_4 + - *ref_1 - *ref_5 - type: object properties: @@ -1012,7 +1241,7 @@ x-paths: example: WHITESPACES - title: ORIGINAL_EQUALS_TARGET allOf: - - *ref_4 + - *ref_1 - *ref_5 - type: object properties: @@ -1036,7 +1265,7 @@ x-paths: example: ORIGINAL_EQUALS_TARGET - title: SPELLCHECK allOf: - - *ref_4 + - *ref_1 - *ref_5 - type: object properties: @@ -1070,12 +1299,8 @@ x-paths: example: SPELLCHECK - title: TAG_CONSISTENCY allOf: - - *ref_4 - - &ref_9 - allOf: - - *ref_6 - - *ref_7 - - *ref_8 + - *ref_1 + - *ref_6 - type: object properties: checkTypeCode: @@ -1085,12 +1310,14 @@ x-paths: description: check type code example: TAG_CONSISTENCY subTypes: + nullable: true type: array items: type: object properties: checkSubTypeCode: type: string + nullable: true enum: - TAG_ADDED - TAG_DELETED @@ -1098,9 +1325,10 @@ x-paths: - TAG_ORDER_IS_CHANGED description: check subtype code example: TAG_ADDED + severityLevelCode: *ref_0 - title: TARGET_LENGTH_LIMIT allOf: - - *ref_4 + - *ref_1 - *ref_5 - type: object properties: @@ -1112,8 +1340,8 @@ x-paths: example: TARGET_LENGTH_LIMIT - title: NUMBER_CONSISTENCY allOf: - - *ref_4 - - *ref_9 + - *ref_1 + - *ref_6 - type: object properties: ignoreSign: @@ -1135,15 +1363,17 @@ x-paths: properties: checkSubTypeCode: type: string + nullable: true enum: - NUMBER_ADDED - NUMBER_DELETED - NUMBER_INCORRECT_CONVERSION description: check subtype code example: NUMBER_ADDED + severityLevelCode: *ref_0 - title: REPEATED_WORD allOf: - - *ref_4 + - *ref_1 - *ref_5 - type: object properties: @@ -1155,7 +1385,7 @@ x-paths: example: REPEATED_WORD - title: TARGET_IN_WRONG_LANGUAGE allOf: - - *ref_4 + - *ref_1 - *ref_5 - type: object properties: @@ -1174,7 +1404,7 @@ x-paths: example: TARGET_IN_WRONG_LANGUAGE - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - *ref_4 + - *ref_1 - *ref_5 - type: object properties: @@ -1193,8 +1423,8 @@ x-paths: example: SOURCE_IN_WRONG_LANGUAGE - title: SEGMENT_COMPLETENESS allOf: - - *ref_4 - - *ref_9 + - *ref_1 + - *ref_6 - type: object properties: lowerLengthThreshold: @@ -1223,6 +1453,7 @@ x-paths: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - TARGET_IS_EMPTY @@ -1230,9 +1461,10 @@ x-paths: - TARGET_IS_MUCH_LONGER_THAN_SOURCE description: check subtype code example: TARGET_IS_EMPTY + severityLevelCode: *ref_0 - title: NON_TRANSLATABLE_TEXT allOf: - - *ref_4 + - *ref_1 - *ref_5 - type: object properties: @@ -1248,6 +1480,7 @@ x-paths: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - PLACEABLE_ADDED @@ -1256,10 +1489,11 @@ x-paths: - PLACEABLE_FORMAT description: check subtype code example: PLACEABLE_ADDED + severityLevelCode: *ref_0 - title: EMOJI_CONSISTENCY allOf: - - *ref_4 - - *ref_9 + - *ref_1 + - *ref_6 - type: object properties: noEmojisAllowedInTarget: @@ -1287,10 +1521,11 @@ x-paths: - EMOJI_PRESENT description: check subtype code example: EMOJI_ADDED + severityLevelCode: *ref_0 - title: INSERTABLE_CONSISTENCY allOf: - - *ref_4 - - *ref_9 + - *ref_1 + - *ref_6 - type: object properties: checkTypeCode: @@ -1305,16 +1540,18 @@ x-paths: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - INSERTABLE_ADDED - INSERTABLE_DELETED description: check subtype code example: INSERTABLE_ADDED + severityLevelCode: *ref_0 - title: TARGET_SOURCE_CONSISTENCY allOf: - - *ref_4 - - *ref_9 + - *ref_1 + - *ref_6 - type: object properties: ignoreTagsAndPlaceholders: @@ -1345,9 +1582,10 @@ x-paths: - SAME_TRANSLATION_DIFFERENT_SOURCES description: check subtype code example: SAME_SOURCE_DIFFERENT_TRANSLATIONS + severityLevelCode: *ref_0 - title: BLACKLISTED_TERMS allOf: - - *ref_4 + - *ref_1 - *ref_5 - type: object properties: @@ -1359,7 +1597,7 @@ x-paths: example: BLACKLISTED_TERMS - title: GLOSSARY_COMPLIANCE allOf: - - *ref_4 + - *ref_1 - *ref_5 - allOf: - type: object @@ -1400,7 +1638,7 @@ x-paths: example: GLOSSARY_COMPLIANCE - title: TRADEMARK_CONSISTENCY allOf: - - *ref_4 + - *ref_1 - *ref_5 - type: object properties: @@ -1412,7 +1650,7 @@ x-paths: example: TRADEMARK_CONSISTENCY - title: GRAMMAR_CHECK allOf: - - *ref_4 + - *ref_1 - *ref_5 - type: object properties: @@ -1424,7 +1662,7 @@ x-paths: example: GRAMMAR_CHECK - title: GLOBAL_CAPITALISATION_CONSISTENCY allOf: - - *ref_4 + - *ref_1 - *ref_5 - type: object properties: @@ -1436,7 +1674,7 @@ x-paths: example: GLOBAL_CAPITALISATION_CONSISTENCY - title: PUNCTUATION_CONSISTENCY allOf: - - *ref_4 + - *ref_1 - *ref_5 - type: object properties: @@ -1448,7 +1686,7 @@ x-paths: example: PUNCTUATION_CONSISTENCY - title: PLURALS_REPETITION allOf: - - *ref_4 + - *ref_1 - *ref_5 - type: object properties: @@ -1460,7 +1698,7 @@ x-paths: example: PLURALS_REPETITION - title: REGEX_CHECK allOf: - - *ref_4 + - *ref_1 - *ref_5 - type: object properties: @@ -1472,115 +1710,10 @@ 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_3 + items: *ref_11 - title: OPEN_ISSUES allOf: - - *ref_4 + - *ref_1 - *ref_5 - type: object properties: @@ -1605,265 +1738,338 @@ 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 + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: LOW - - checkSubTypeCode: TAG_ORDER_IS_CHANGED - severityLevelCode: LOW - - checkSubTypeCode: SPACES_AROUND_TAGS - 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 + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: LOW - - checkSubTypeCode: NUMBER_ADDED - severityLevelCode: LOW - - checkSubTypeCode: NUMBER_INCORRECT_CONVERSION - 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 + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: MEDIUM - - checkSubTypeCode: SPACES_AROUND_PLACEABLE - severityLevelCode: MEDIUM - - checkSubTypeCode: PLACEABLE_ADDED - severityLevelCode: MEDIUM - - checkSubTypeCode: PLACEABLE_FORMAT - 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 + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: LOW - - checkSubTypeCode: EMOJI_DELETED - severityLevelCode: DISABLED - - checkSubTypeCode: EMOJI_ADDED - 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 + response: + code: SUCCESS + data: + profileUid: ce6d6b5dbc12 severityLevelCode: LOW - - checkSubTypeCode: SAME_SOURCE_DIFFERENT_TRANSLATIONS - 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: - 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 - 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 + '500': *ref_15 x-code-samples: - lang: curl source: > @@ -1878,9 +2084,9 @@ x-paths: - Translation quality checks operationId: profilesUpdateAccountCheckTypesSettings parameters: - - *ref_0 - - *ref_1 - - &ref_22 + - *ref_8 + - *ref_9 + - &ref_28 name: checkTypeCode in: path required: true @@ -1904,97 +2110,87 @@ x-paths: application/json: schema: oneOf: - - title: EMOJI_CONSISTENCY + - &ref_29 + title: EMOJI_CONSISTENCY allOf: - - *ref_10 - - &ref_23 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId - - &ref_24 - type: object + - *ref_16 + - type: object required: - noEmojisAllowedInTarget - - title: SPELLCHECK + - &ref_30 + title: SPELLCHECK allOf: - - *ref_11 - - &ref_25 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId - - &ref_26 - type: object + - *ref_17 + - type: object required: - skipIfWordInUserDictionary - skipIfWordStartsWithCapitalLetter - skipIfWordAppearsInSourceString - skipIfWordValidInSourceLocale - runSpellcheckForSubWords - - title: SOURCE_IN_WRONG_LANGUAGE + - &ref_31 + title: SOURCE_IN_WRONG_LANGUAGE allOf: - - *ref_12 - - &ref_27 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId - - &ref_28 - type: object + - *ref_18 + - type: object required: - minTextLengthLimit - - title: TARGET_IN_WRONG_LANGUAGE + - &ref_32 + title: TARGET_IN_WRONG_LANGUAGE allOf: - - &ref_29 - type: object + - type: object required: - minTextLengthLimit - - &ref_30 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId - - *ref_13 - - &ref_31 + - *ref_19 + - &ref_33 title: NUMBER_CONSISTENCY allOf: - - *ref_14 - - title: TARGET_SOURCE_CONSISTENCY + - *ref_20 + - &ref_34 + title: TARGET_SOURCE_CONSISTENCY allOf: - - *ref_15 - - &ref_32 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId - - &ref_33 - type: object + - *ref_21 + - type: object required: - ignoreTagsAndPlaceholders - ignoreCase - - &ref_34 + - &ref_35 title: GLOSSARY_COMPLIANCE allOf: - - &ref_21 + - &ref_27 allOf: - - *ref_16 - - *ref_17 + - *ref_22 + - *ref_23 - type: object required: - matchMethod - matchThreshold - - title: ORIGINAL_EQUALS_TARGET + - &ref_36 + title: ORIGINAL_EQUALS_TARGET allOf: - - *ref_18 - - &ref_35 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId - - &ref_36 - type: object + - *ref_24 + - type: object required: - mustHaveIdenticalTags - mustHaveIdenticalCapitalization - title: SEGMENT_COMPLETENESS allOf: - - *ref_19 + - *ref_25 - &ref_37 - $ref: >- - ../tqc_common.yaml#/components/requestBodies/targetLocaleId + 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_20 + - *ref_26 - type: object required: - sourceIssuesMustBeResolved @@ -2009,83 +2205,117 @@ x-paths: properties: response: allOf: - - *ref_2 + - *ref_10 - type: object properties: data: &ref_39 - oneOf: + anyOf: - title: EMOJI_CONSISTENCY allOf: - - *ref_10 + - *ref_16 - title: SPELLCHECK allOf: - - *ref_11 + - *ref_17 - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - *ref_12 + - *ref_18 - title: TARGET_IN_WRONG_LANGUAGE allOf: - - *ref_13 + - *ref_19 - title: NUMBER_CONSISTENCY allOf: - - *ref_14 + - *ref_20 - title: TARGET_SOURCE_CONSISTENCY allOf: - - *ref_15 + - *ref_21 - title: GLOSSARY_COMPLIANCE allOf: - - *ref_21 + - *ref_27 - title: ORIGINAL_EQUALS_TARGET allOf: - - *ref_18 + - *ref_24 - title: SEGMENT_COMPLETENESS allOf: - - *ref_19 + - *ref_25 - title: OPEN_ISSUES allOf: - - *ref_20 + - *ref_26 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 + '500': *ref_15 x-code-samples: - lang: curl source: > @@ -2100,9 +2330,9 @@ x-paths: - Translation quality checks operationId: updateProfilesCheckTypeGroupSettings parameters: - - *ref_0 - - *ref_1 - - *ref_22 + - *ref_8 + - *ref_9 + - *ref_28 - name: groupUid in: path schema: @@ -2116,41 +2346,17 @@ x-paths: application/json: schema: oneOf: - - title: EMOJI_CONSISTENCY - allOf: - - *ref_10 - - *ref_23 - - *ref_24 - - title: SPELLCHECK - allOf: - - *ref_11 - - *ref_25 - - *ref_26 - - title: SOURCE_IN_WRONG_LANGUAGE - allOf: - - *ref_12 - - *ref_27 - - *ref_28 - - title: TARGET_IN_WRONG_LANGUAGE - allOf: - - *ref_29 - - *ref_30 - - *ref_13 + - *ref_29 + - *ref_30 - *ref_31 - - title: TARGET_SOURCE_CONSISTENCY - allOf: - - *ref_15 - - *ref_32 - - *ref_33 + - *ref_32 + - *ref_33 - *ref_34 - - title: ORIGINAL_EQUALS_TARGET - allOf: - - *ref_18 - - *ref_35 - - *ref_36 + - *ref_35 + - *ref_36 - title: SEGMENT_COMPLETENESS allOf: - - *ref_19 + - *ref_25 - *ref_37 - *ref_38 responses: @@ -2163,52 +2369,86 @@ x-paths: properties: response: allOf: - - *ref_2 + - *ref_10 - type: object properties: data: *ref_39 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 + '500': *ref_15 x-code-samples: - lang: curl source: > @@ -2247,7 +2487,7 @@ x-paths: properties: response: allOf: - - *ref_2 + - *ref_10 - type: object properties: data: @@ -2262,8 +2502,7 @@ x-paths: anyOf: - title: BLACKLISTED_TERMS allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -2274,9 +2513,8 @@ x-paths: example: BLACKLISTED_TERMS - title: EMOJI_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_10 + - *ref_6 + - *ref_16 - type: object properties: checkTypeCode: @@ -2298,10 +2536,10 @@ x-paths: - EMOJI_PRESENT description: check subtype code example: EMOJI_ADDED + severityLevelCode: *ref_0 - title: GLOBAL_CAPITALISATION_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -2312,9 +2550,8 @@ x-paths: example: GLOBAL_CAPITALISATION_CONSISTENCY - title: GLOSSARY_COMPLIANCE allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_16 + - *ref_5 + - *ref_22 - type: object properties: sameTermCount: @@ -2335,8 +2572,7 @@ x-paths: example: GLOSSARY_COMPLIANCE - title: GRAMMAR_CHECK allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -2347,8 +2583,7 @@ x-paths: example: GRAMMAR_CHECK - title: INSERTABLE_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_6 - type: object properties: checkTypeCode: @@ -2369,10 +2604,10 @@ x-paths: - INSERTABLE_DELETED description: check subtype code example: INSERTABLE_ADDED + severityLevelCode: *ref_0 - title: LEADING_TRAILING_SPACES allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object required: - checkTypeCode @@ -2385,8 +2620,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: @@ -2402,6 +2636,7 @@ x-paths: properties: checkSubTypeCode: type: string + nullable: true enum: - PLACEABLE_ADDED - PLACEABLE_DELETED @@ -2409,11 +2644,11 @@ x-paths: - PLACEABLE_FORMAT description: check subtype code example: PLACEABLE_ADDED + severityLevelCode: *ref_0 - title: NUMBER_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_14 + - *ref_6 + - *ref_20 - type: object properties: checkTypeCode: @@ -2435,11 +2670,11 @@ x-paths: - NUMBER_INCORRECT_CONVERSION description: check subtype code example: NUMBER_ADDED + severityLevelCode: *ref_0 - title: ORIGINAL_EQUALS_TARGET allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_18 + - *ref_5 + - *ref_24 - type: object required: - checkTypeCode @@ -2452,8 +2687,7 @@ x-paths: example: ORIGINAL_EQUALS_TARGET - title: REPEATED_WORD allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -2464,9 +2698,8 @@ x-paths: example: REPEATED_WORD - title: SEGMENT_COMPLETENESS allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_19 + - *ref_6 + - *ref_25 - type: object properties: checkTypeCode: @@ -2488,11 +2721,11 @@ x-paths: - TARGET_IS_MUCH_LONGER_THAN_SOURCE description: check subtype code example: TARGET_IS_EMPTY + severityLevelCode: *ref_0 - title: SOURCE_IN_WRONG_LANGUAGE allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_12 + - *ref_5 + - *ref_18 - type: object properties: checkTypeCode: @@ -2503,9 +2736,8 @@ x-paths: example: SOURCE_IN_WRONG_LANGUAGE - title: SPELLCHECK allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_11 + - *ref_5 + - *ref_17 - type: object properties: checkTypeCode: @@ -2516,8 +2748,7 @@ x-paths: example: SPELLCHECK - title: TAG_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_6 - type: object properties: checkTypeCode: @@ -2532,6 +2763,7 @@ x-paths: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - TAG_ADDED @@ -2540,11 +2772,11 @@ x-paths: - TAG_ORDER_IS_CHANGED description: check subtype code example: TAG_ADDED + severityLevelCode: *ref_0 - title: TARGET_IN_WRONG_LANGUAGE allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_13 + - *ref_5 + - *ref_19 - type: object properties: checkTypeCode: @@ -2555,8 +2787,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: @@ -2567,9 +2798,8 @@ x-paths: example: TARGET_LENGTH_LIMIT - title: TARGET_SOURCE_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithCustomSubTypesResponseAccountCheckTypeSettingsEffective - - *ref_15 + - *ref_6 + - *ref_21 - type: object properties: checkTypeCode: @@ -2590,10 +2820,10 @@ x-paths: - SAME_TRANSLATION_DIFFERENT_SOURCES description: check subtype code example: SAME_SOURCE_DIFFERENT_TRANSLATIONS + severityLevelCode: *ref_0 - title: TRADEMARK_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -2604,8 +2834,7 @@ x-paths: example: TRADEMARK_CONSISTENCY - title: WHITESPACES allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -2616,8 +2845,7 @@ x-paths: example: WHITESPACES - title: PUNCTUATION_CONSISTENCY allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -2628,8 +2856,7 @@ x-paths: example: PUNCTUATION_CONSISTENCY - title: PLURALS_REPETITION allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -2640,8 +2867,7 @@ x-paths: example: PLURALS_REPETITION - title: REGEX_CHECK allOf: - - $ref: >- - ../tqc_common.yaml#/components/schemas/commonWithoutSubTypesResponseAccountCheckTypeSettingsEffective + - *ref_5 - type: object properties: checkTypeCode: @@ -2652,14 +2878,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_20 + - *ref_5 + - *ref_26 - type: object required: - checkTypeCode @@ -2677,7 +2900,7 @@ x-paths: totalCount: 24 items: - severityLevelCode: LOW - checkTypeCode: LEADING_TRAILING_SPACES 1 + checkTypeCode: LEADING_TRAILING_SPACES subTypes: [] localeSeverityLevels: [] groups: [] @@ -2791,15 +3014,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: @@ -2873,6 +3099,10 @@ x-paths: 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/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..a067669c 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,18 +16,21 @@ 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 schema: + type: string + description: '[check type code](#operation/getTranslationQualityCheckTypes)' + example: LEADING_TRAILING_SPACES enum: - LEADING_TRAILING_SPACES - ORIGINAL_EQUALS_TARGET @@ -59,7 +62,7 @@ x-paths: required: true content: application/json: - schema: &ref_2 + schema: &ref_3 allOf: - type: object properties: @@ -76,7 +79,7 @@ x-paths: description: OK content: application/json: - schema: &ref_3 + schema: &ref_4 type: object properties: response: @@ -98,11 +101,161 @@ x-paths: type: object properties: severityLevelCode: + type: string + description: severity level code + example: MEDIUM enum: - DISABLED - 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 +270,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 +286,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 +322,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 +347,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 +362,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 +387,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/blacklisted_terms.yaml b/spec/translation_quality/checks/blacklisted_terms.yaml index 508bd6bb..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" @@ -128,10 +131,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..9173a0fb 100644 --- a/spec/translation_quality/checks/emoji_consistency.yaml +++ b/spec/translation_quality/checks/emoji_consistency.yaml @@ -13,7 +13,6 @@ components: title: EMOJI_CONSISTENCY allOf: - $ref: '#/components/schemas/EmojiConsistencySettingsDTO' - - $ref: '../tqc_common.yaml#/components/requestBodies/targetLocaleId' - type: object required: - noEmojisAllowedInTarget @@ -49,6 +48,8 @@ components: - EMOJI_PRESENT description: check subtype code example: "EMOJI_ADDED" + severityLevelCode: + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveDTO: title: EMOJI_CONSISTENCY @@ -77,6 +78,8 @@ components: - EMOJI_PRESENT description: check subtype code example: "EMOJI_ADDED" + severityLevelCode: + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveResponse: allOf: @@ -102,6 +105,7 @@ components: description: check type code example: "EMOJI_CONSISTENCY" details: + nullable: true type: object properties: emoji: @@ -116,6 +120,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: @@ -127,31 +140,40 @@ 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 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": @@ -172,8 +194,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..1da571b4 100644 --- a/spec/translation_quality/checks/global_capitalisation_consistency.yaml +++ b/spec/translation_quality/checks/global_capitalisation_consistency.yaml @@ -51,6 +51,7 @@ components: description: check type code example: "GLOBAL_CAPITALISATION_CONSISTENCY" details: + nullable: true type: object positionTypeCode: type: string @@ -62,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 c6394fb0..cea63655 100644 --- a/spec/translation_quality/checks/glossary_compliance.yaml +++ b/spec/translation_quality/checks/glossary_compliance.yaml @@ -128,6 +128,7 @@ components: example: "GLOSSARY_COMPLIANCE" details: type: object + nullable: true properties: glossaryTerm: type: object @@ -155,6 +156,7 @@ components: type: string description: translator user identifier example: "23ddd32e" + nullable: true lockTranslation: type: boolean description: lock translation @@ -238,33 +240,42 @@ 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 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 c6498b5b..04100fd3 100644 --- a/spec/translation_quality/checks/grammar_check.yaml +++ b/spec/translation_quality/checks/grammar_check.yaml @@ -51,6 +51,7 @@ components: description: check type code example: "GRAMMAR_CHECK" details: + nullable: true type: object properties: text: @@ -84,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" @@ -129,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/insertable_consistency.yaml b/spec/translation_quality/checks/insertable_consistency.yaml index 36ec57e6..86512e4c 100644 --- a/spec/translation_quality/checks/insertable_consistency.yaml +++ b/spec/translation_quality/checks/insertable_consistency.yaml @@ -25,6 +25,8 @@ components: - INSERTABLE_DELETED description: check subtype code example: "INSERTABLE_ADDED" + severityLevelCode: + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveDTO: title: INSERTABLE_CONSISTENCY @@ -45,12 +47,15 @@ components: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - INSERTABLE_ADDED - INSERTABLE_DELETED description: check subtype code example: "INSERTABLE_ADDED" + severityLevelCode: + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveResponse: allOf: @@ -76,6 +81,7 @@ components: example: "INSERTABLE_CONSISTENCY" details: type: object + nullable: true properties: insertable: type: string @@ -103,16 +109,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" @@ -126,15 +135,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 99ccfda7..a8e179dc 100644 --- a/spec/translation_quality/checks/leading_trailing_spaces.yaml +++ b/spec/translation_quality/checks/leading_trailing_spaces.yaml @@ -67,6 +67,7 @@ components: example: "LEADING_TRAILING_SPACES" details: type: object + nullable: true positionTypeCode: type: string enum: @@ -79,21 +80,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 150ec000..d49e6c1f 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 @@ -27,6 +28,8 @@ components: - PLACEABLE_FORMAT description: check subtype code example: "PLACEABLE_ADDED" + severityLevelCode: + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveDTO: title: NON_TRANSLATABLE_TEXT @@ -47,6 +50,7 @@ components: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - PLACEABLE_ADDED @@ -55,6 +59,8 @@ components: - PLACEABLE_FORMAT description: check subtype code example: "PLACEABLE_ADDED" + severityLevelCode: + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveResponse: allOf: @@ -80,6 +86,7 @@ components: example: "NON_TRANSLATABLE_TEXT" details: type: object + nullable: true properties: placeable: type: string @@ -105,20 +112,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 dca05d2f..b1be8912 100644 --- a/spec/translation_quality/checks/number_consistency.yaml +++ b/spec/translation_quality/checks/number_consistency.yaml @@ -45,6 +45,8 @@ components: - NUMBER_INCORRECT_CONVERSION description: check subtype code example: "NUMBER_ADDED" + severityLevelCode: + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveDTO: title: NUMBER_CONSISTENCY @@ -67,12 +69,15 @@ components: properties: checkSubTypeCode: type: string + nullable: true enum: - NUMBER_ADDED - NUMBER_DELETED - NUMBER_INCORRECT_CONVERSION description: check subtype code example: "NUMBER_ADDED" + severityLevelCode: + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveResponse: allOf: @@ -97,6 +102,8 @@ components: description: check type code example: "NUMBER_CONSISTENCY" details: + type: object + nullable: true oneOf: - type: object title: NUMBER_ADDED @@ -149,37 +156,43 @@ 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: - "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" @@ -218,13 +231,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": @@ -251,8 +270,8 @@ components: - "checkTypeCode": "NUMBER_CONSISTENCY" "severityLevelCode": "LOW" "positions": - "from": 5 - "to": 7 + - "from": 5 + "to": 7 "details": "type": "NUMBER_ADDED" "number": "20" diff --git a/spec/translation_quality/checks/open_issues.yaml b/spec/translation_quality/checks/open_issues.yaml index 0ce49445..cdc54d7f 100644 --- a/spec/translation_quality/checks/open_issues.yaml +++ b/spec/translation_quality/checks/open_issues.yaml @@ -83,6 +83,7 @@ components: description: check type code example: "OPEN_ISSUES" details: + nullable: true type: object properties: sourceIssuesCount: @@ -131,30 +132,39 @@ 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 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": @@ -172,8 +182,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 0c86eb77..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 @@ -84,6 +83,7 @@ components: description: check type code example: "ORIGINAL_EQUALS_TARGET" details: + nullable: true type: object properties: types: @@ -132,30 +132,39 @@ 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 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": @@ -173,8 +182,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 20ec306a..0f41854f 100644 --- a/spec/translation_quality/checks/plurals_repetition.yaml +++ b/spec/translation_quality/checks/plurals_repetition.yaml @@ -51,6 +51,7 @@ components: description: check type code example: "PLURALS_REPETITION" details: + nullable: true type: object properties: pluralFormGroupUid: @@ -72,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" @@ -117,8 +121,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 91085118..6f6e34d4 100644 --- a/spec/translation_quality/checks/punctuation_consistency.yaml +++ b/spec/translation_quality/checks/punctuation_consistency.yaml @@ -51,6 +51,7 @@ components: description: check type code example: "PUNCTUATION_CONSISTENCY" details: + nullable: true type: object positionTypeCode: type: string @@ -62,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" @@ -107,8 +111,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/regex_check.yaml b/spec/translation_quality/checks/regex_check.yaml index 3db2d764..5efeeb99 100644 --- a/spec/translation_quality/checks/regex_check.yaml +++ b/spec/translation_quality/checks/regex_check.yaml @@ -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: @@ -135,24 +137,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 ad0c66f7..671327c2 100644 --- a/spec/translation_quality/checks/repeated_word.yaml +++ b/spec/translation_quality/checks/repeated_word.yaml @@ -51,6 +51,7 @@ components: description: check type code example: "REPEATED_WORD" details: + nullable: true type: object properties: word: @@ -67,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" @@ -113,10 +117,10 @@ components: - "checkTypeCode": "REPEATED_WORD" "severityLevelCode": "LOW" "positions": - "from": 5 - "to": 9 + - "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..88dbc587 100644 --- a/spec/translation_quality/checks/segment_completeness.yaml +++ b/spec/translation_quality/checks/segment_completeness.yaml @@ -54,6 +54,8 @@ components: - TARGET_IS_MUCH_LONGER_THAN_SOURCE description: check subtype code example: "TARGET_IS_EMPTY" + severityLevelCode: + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveDTO: title: SEGMENT_COMPLETENESS @@ -75,6 +77,7 @@ components: type: object properties: checkSubTypeCode: + nullable: true type: string enum: - TARGET_IS_EMPTY @@ -82,6 +85,8 @@ components: - TARGET_IS_MUCH_LONGER_THAN_SOURCE description: check subtype code example: "TARGET_IS_EMPTY" + severityLevelCode: + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveResponse: allOf: @@ -107,6 +112,7 @@ components: example: "SEGMENT_COMPLETENESS" details: type: object + nullable: true properties: type: type: string @@ -126,21 +132,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" @@ -197,9 +206,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 @@ -207,9 +219,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": @@ -227,8 +242,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 7ac61678..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 @@ -76,6 +75,7 @@ components: description: check type code example: "SOURCE_IN_WRONG_LANGUAGE" details: + nullable: true type: object positionTypeCode: type: string @@ -87,13 +87,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" @@ -124,13 +127,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": @@ -148,8 +157,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 a1eab089..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 @@ -106,6 +105,7 @@ components: example: "SPELLCHECK" details: type: object + nullable: true properties: word: type: string @@ -127,17 +127,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" @@ -184,11 +187,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 @@ -198,11 +204,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": @@ -220,8 +229,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 ba0eaf43..c39bbbcc 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 @@ -26,6 +27,8 @@ components: - TAG_ORDER_IS_CHANGED description: check subtype code example: "TAG_ADDED" + severityLevelCode: + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveDTO: title: TAG_CONSISTENCY @@ -41,12 +44,14 @@ components: description: check type code example: "TAG_CONSISTENCY" subTypes: + nullable: true type: array items: type: object properties: checkSubTypeCode: type: string + nullable: true enum: - TAG_ADDED - TAG_DELETED @@ -54,6 +59,8 @@ components: - TAG_ORDER_IS_CHANGED description: check subtype code example: "TAG_ADDED" + severityLevelCode: + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveResponse: allOf: @@ -103,20 +110,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" @@ -180,8 +190,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 9a9c7d4c..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: @@ -78,6 +77,7 @@ components: example: "TARGET_IN_WRONG_LANGUAGE" details: type: object + nullable: true positionTypeCode: type: string enum: @@ -88,13 +88,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" @@ -125,13 +128,19 @@ components: 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": @@ -149,8 +158,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 04219c73..08b8c5b7 100644 --- a/spec/translation_quality/checks/target_length_limit.yaml +++ b/spec/translation_quality/checks/target_length_limit.yaml @@ -52,6 +52,7 @@ components: example: "TARGET_LENGTH_LIMIT" details: type: object + nullable: true positionTypeCode: type: string enum: @@ -62,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" @@ -107,8 +111,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 587acac9..0b1265a1 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 @@ -52,6 +51,8 @@ components: - SAME_TRANSLATION_DIFFERENT_SOURCES description: check subtype code example: "SAME_SOURCE_DIFFERENT_TRANSLATIONS" + severityLevelCode: + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveDTO: title: TARGET_SOURCE_CONSISTENCY @@ -79,6 +80,8 @@ components: - SAME_TRANSLATION_DIFFERENT_SOURCES description: check subtype code example: "SAME_SOURCE_DIFFERENT_TRANSLATIONS" + severityLevelCode: + $ref: '../tqc_common.yaml#/components/schemas/severityLevelCodeEnum' ProfilesAccountCheckTypeEffectiveResponse: allOf: @@ -104,6 +107,7 @@ components: example: "TARGET_SOURCE_CONSISTENCY" details: type: object + nullable: true properties: type: type: string @@ -130,18 +134,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" @@ -188,16 +195,22 @@ components: 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": @@ -215,8 +228,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 6017763e..452c8c58 100644 --- a/spec/translation_quality/checks/trademark_consistency.yaml +++ b/spec/translation_quality/checks/trademark_consistency.yaml @@ -52,6 +52,7 @@ components: example: "TRADEMARK_CONSISTENCY" details: type: object + nullable: true properties: trademarkTypeCode: type: string @@ -72,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" @@ -117,8 +121,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 2d664823..df6bc1e5 100644 --- a/spec/translation_quality/checks/whitespaces.yaml +++ b/spec/translation_quality/checks/whitespaces.yaml @@ -52,6 +52,7 @@ components: example: "WHITESPACES" details: type: object + nullable: true positionTypeCode: type: string enum: @@ -62,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" @@ -107,8 +111,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/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..9be5373d 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,12 @@ x-paths: allOf: - type: object properties: - checkTypeCode: &ref_0 + checkTypeCode: &ref_1 + type: string + description: >- + [check type + code](#operation/getTranslationQualityCheckTypes) + example: LEADING_TRAILING_SPACES enum: - LEADING_TRAILING_SPACES - ORIGINAL_EQUALS_TARGET @@ -84,7 +89,7 @@ x-paths: type: array items: allOf: - - &ref_2 + - &ref_3 type: object properties: checkSubTypeCode: @@ -159,9 +164,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 +296,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 +459,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 +471,7 @@ x-paths: properties: response: allOf: - - *ref_1 + - *ref_2 - type: object properties: data: @@ -334,7 +484,7 @@ x-paths: type: array items: allOf: - - *ref_2 + - *ref_3 example: response: code: SUCCESS @@ -347,6 +497,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 +523,7 @@ x-paths: properties: response: allOf: - - *ref_1 + - *ref_2 - type: object properties: data: @@ -410,6 +564,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 +590,7 @@ x-paths: properties: response: allOf: - - *ref_1 + - *ref_2 - type: object properties: data: @@ -448,6 +606,9 @@ x-paths: - type: object properties: severityLevelCode: + type: string + description: severity level code + example: MEDIUM enum: - DISABLED - LOW @@ -473,6 +634,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 +660,7 @@ x-paths: properties: response: allOf: - - *ref_1 + - *ref_2 - type: object properties: data: @@ -539,6 +704,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 +721,7 @@ x-paths: - Translation quality checks operationId: getUserCustomDictionary parameters: - - &ref_3 + - &ref_8 name: localeId in: path required: true @@ -569,7 +738,7 @@ x-paths: properties: response: allOf: - - *ref_1 + - *ref_2 - type: object properties: data: @@ -582,7 +751,7 @@ x-paths: type: array items: allOf: - - &ref_4 + - &ref_9 type: object properties: wordUid: @@ -600,6 +769,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 +785,7 @@ x-paths: - Translation quality checks operationId: addWordToUserCustomDictionary parameters: - - *ref_3 + - *ref_8 requestBody: description: '' required: true @@ -630,17 +803,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 +832,7 @@ x-paths: - Translation quality checks operationId: removeWordFromUserCustomDictionary parameters: - - *ref_3 + - *ref_8 - name: wordUid in: path required: true @@ -667,7 +844,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 +872,7 @@ x-paths: properties: response: allOf: - - *ref_1 + - *ref_2 - type: object properties: data: @@ -731,6 +912,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 +938,7 @@ x-paths: properties: response: allOf: - - *ref_1 + - *ref_2 - type: object properties: data: @@ -788,6 +973,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/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/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.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..09b170ec 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: @@ -160,11 +160,161 @@ x-paths: type: string type: array severityLevelCode: + type: string + description: severity level code + example: MEDIUM enum: - DISABLED - 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: {} + '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: + - 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_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 +329,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 +343,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 +360,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 +392,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 +422,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 +444,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 +470,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 +483,7 @@ x-paths: properties: response: allOf: - - *ref_6 + - *ref_11 - type: object properties: data: @@ -333,7 +497,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 +516,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 +531,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 +549,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 +581,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 +601,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 +620,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 +644,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 +663,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 +678,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 +701,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: > diff --git a/spec/translation_quality/tqc_check.yaml b/spec/translation_quality/tqc_check.yaml index 7c53c6af..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' @@ -30,6 +29,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 @@ -68,8 +75,7 @@ components: maxItems: 100 type: array items: - allOf: - - $ref: './tqc_common.yaml#/components/requestBodies/checkTypeCode' + $ref: './tqc_common.yaml#/components/schemas/checkTypeCodeEnum' description: '[check type codes](#operation/getTranslationQualityCheckTypes)' TqcCheckResponse: @@ -93,6 +99,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,13 +116,15 @@ 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: 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 3300aa95..fda8ecb2 100644 --- a/spec/translation_quality/tqc_check_result.yaml +++ b/spec/translation_quality/tqc_check_result.yaml @@ -30,115 +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: - 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 - description: unique identifier of plural form - example: 7191152182c69d9b72069ac1290fe24b - - type: object - properties: - pluralForm: - type: string - description: plural form - example: ONE - useDefaultSettings: - type: boolean - description: use default settings - example: false - checkTypeCodes: - minItems: 1 - 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 - 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 @@ -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,32 @@ x-paths: oneOf: - title: BLACKLISTED_TERMS allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - &ref_0 + type: object + properties: + severityLevelCode: &ref_2 + type: string + description: severity level code + example: MEDIUM + 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: @@ -266,10 +292,8 @@ x-paths: example: TARGET - title: EMOJI_CONSISTENCY allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - *ref_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -279,6 +303,7 @@ x-paths: description: check type code example: EMOJI_CONSISTENCY details: + nullable: true type: object properties: emoji: @@ -293,6 +318,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: @@ -302,10 +336,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_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -315,6 +347,7 @@ x-paths: description: check type code example: GLOBAL_CAPITALISATION_CONSISTENCY details: + nullable: true type: object positionTypeCode: type: string @@ -324,10 +357,8 @@ x-paths: example: TARGET - title: GLOSSARY_COMPLIANCE allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - *ref_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -338,6 +369,7 @@ x-paths: example: GLOSSARY_COMPLIANCE details: type: object + nullable: true properties: glossaryTerm: type: object @@ -365,6 +397,7 @@ x-paths: type: string description: translator user identifier example: 23ddd32e + nullable: true lockTranslation: type: boolean description: lock translation @@ -446,10 +479,8 @@ x-paths: example: SOURCE - title: GRAMMAR_CHECK allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - *ref_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -459,6 +490,7 @@ x-paths: description: check type code example: GRAMMAR_CHECK details: + nullable: true type: object properties: text: @@ -493,10 +525,8 @@ x-paths: example: TARGET - title: INSERTABLE_CONSISTENCY allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - *ref_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -507,6 +537,7 @@ x-paths: example: INSERTABLE_CONSISTENCY details: type: object + nullable: true properties: insertable: type: string @@ -532,10 +563,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_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -546,6 +575,7 @@ x-paths: example: LEADING_TRAILING_SPACES details: type: object + nullable: true positionTypeCode: type: string enum: @@ -554,10 +584,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_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -568,6 +596,7 @@ x-paths: example: NON_TRANSLATABLE_TEXT details: type: object + nullable: true properties: placeable: type: string @@ -591,10 +620,8 @@ x-paths: example: SOURCE - title: NUMBER_CONSISTENCY allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - *ref_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -604,6 +631,8 @@ x-paths: description: check type code example: NUMBER_CONSISTENCY details: + type: object + nullable: true oneOf: - type: object title: NUMBER_ADDED @@ -654,10 +683,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_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -667,6 +694,7 @@ x-paths: description: check type code example: ORIGINAL_EQUALS_TARGET details: + nullable: true type: object properties: types: @@ -687,10 +715,8 @@ x-paths: example: TARGET - title: REPEATED_WORD allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - *ref_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -700,6 +726,7 @@ x-paths: description: check type code example: REPEATED_WORD details: + nullable: true type: object properties: word: @@ -714,10 +741,8 @@ x-paths: example: TARGET - title: SEGMENT_COMPLETENESS allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - *ref_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -728,6 +753,7 @@ x-paths: example: SEGMENT_COMPLETENESS details: type: object + nullable: true properties: type: type: string @@ -745,10 +771,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_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -758,6 +782,7 @@ x-paths: description: check type code example: SOURCE_IN_WRONG_LANGUAGE details: + nullable: true type: object positionTypeCode: type: string @@ -767,10 +792,8 @@ x-paths: example: SOURCE - title: SPELLCHECK allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - *ref_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -781,6 +804,7 @@ x-paths: example: SPELLCHECK details: type: object + nullable: true properties: word: type: string @@ -802,10 +826,8 @@ x-paths: example: TARGET - title: TAG_CONSISTENCY allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - *ref_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -838,10 +860,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_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -852,6 +872,7 @@ x-paths: example: TARGET_IN_WRONG_LANGUAGE details: type: object + nullable: true positionTypeCode: type: string enum: @@ -860,10 +881,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_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -874,6 +893,7 @@ x-paths: example: TARGET_LENGTH_LIMIT details: type: object + nullable: true positionTypeCode: type: string enum: @@ -882,10 +902,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_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -896,6 +914,7 @@ x-paths: example: TARGET_SOURCE_CONSISTENCY details: type: object + nullable: true properties: type: type: string @@ -920,10 +939,8 @@ x-paths: example: TARGET - title: TRADEMARK_CONSISTENCY allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - *ref_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -934,6 +951,7 @@ x-paths: example: TRADEMARK_CONSISTENCY details: type: object + nullable: true properties: trademarkTypeCode: type: string @@ -952,10 +970,8 @@ x-paths: example: SOURCE - title: WHITESPACES allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - *ref_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -966,6 +982,7 @@ x-paths: example: WHITESPACES details: type: object + nullable: true positionTypeCode: type: string enum: @@ -974,10 +991,8 @@ x-paths: example: TARGET - title: PUNCTUATION_CONSISTENCY allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - *ref_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -987,6 +1002,7 @@ x-paths: description: check type code example: PUNCTUATION_CONSISTENCY details: + nullable: true type: object positionTypeCode: type: string @@ -996,10 +1012,8 @@ x-paths: example: SOURCE - title: PLURALS_REPETITION allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - *ref_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -1009,6 +1023,7 @@ x-paths: description: check type code example: PLURALS_REPETITION details: + nullable: true type: object properties: pluralFormGroupUid: @@ -1028,10 +1043,8 @@ x-paths: example: TARGET - title: REGEX_CHECK allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - *ref_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -1041,8 +1054,111 @@ x-paths: description: check type code example: REGEX_CHECK details: - - $ref: >- - ./tqc_common.yaml#/components/schemas/regexRuleWithRuleUid + 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: @@ -1051,10 +1167,8 @@ x-paths: example: TARGET - title: OPEN_ISSUES allOf: - - $ref: >- - ./tqc_common.yaml#/components/schemas/severityLevelCodeResponse - - $ref: >- - ./tqc_common.yaml#/components/schemas/PositionsTqcCheckDTO + - *ref_0 + - *ref_1 - type: object properties: checkTypeCode: @@ -1064,6 +1178,7 @@ x-paths: description: check type code example: OPEN_ISSUES details: + nullable: true type: object properties: sourceIssuesCount: @@ -1101,10 +1216,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 +1241,8 @@ x-paths: - from: 14 to: 16 details: - - emoji: 😀 - type: EMOJI_DELETED + emoji: 😀 + type: EMOJI_DELETED positionTypeCode: SOURCE GLOBAL_CAPITALISATION_CONSISTENCY: value: @@ -1292,8 +1407,8 @@ x-paths: - checkTypeCode: NUMBER_CONSISTENCY severityLevelCode: LOW positions: - from: 5 - to: 7 + - from: 5 + to: 7 details: type: NUMBER_ADDED number: '20' @@ -1315,10 +1430,10 @@ x-paths: - checkTypeCode: REPEATED_WORD severityLevelCode: LOW positions: - from: 5 - to: 9 + - from: 5 + to: 9 details: - - word: Hello + word: Hello positionTypeCode: TARGET SEGMENT_COMPLETENESS: value: @@ -1337,8 +1452,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 @@ -1359,8 +1474,8 @@ x-paths: - checkTypeCode: SOURCE_IN_WRONG_LANGUAGE severityLevelCode: LOW positions: - from: 0 - to: 63 + - from: 0 + to: 63 details: null positionTypeCode: SOURCE SPELLCHECK: @@ -1380,8 +1495,8 @@ x-paths: - checkTypeCode: SPELLCHECK severityLevelCode: MEDIUM positions: - from: 0 - to: 5 + - from: 0 + to: 5 details: word: homewrk suggestions: @@ -1404,8 +1519,8 @@ x-paths: - checkTypeCode: TAG_CONSISTENCY severityLevelCode: MEDIUM positions: - from: 8 - to: 12 + - from: 8 + to: 12 details: tag:

type: TAG_DELETED @@ -1427,8 +1542,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: @@ -1448,8 +1563,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: @@ -1469,8 +1584,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. @@ -1493,8 +1608,8 @@ x-paths: - checkTypeCode: TRADEMARK_CONSISTENCY severityLevelCode: LOW positions: - from: 6 - to: 7 + - from: 6 + to: 7 details: trademarkTypeCode: COPYRIGHT positionTypeCode: SOURCE @@ -1515,8 +1630,8 @@ x-paths: - checkTypeCode: WHITESPACES severityLevelCode: LOW positions: - from: 4 - to: 6 + - from: 4 + to: 6 details: null positionTypeCode: TARGET GRAMMAR_CHECK: @@ -1536,8 +1651,8 @@ x-paths: - checkTypeCode: GRAMMAR_CHECK severityLevelCode: LOW positions: - from: 9 - to: 13 + - from: 9 + to: 13 details: text: ate message: Possible agreement error @@ -1563,8 +1678,8 @@ x-paths: - checkTypeCode: ORIGINAL_EQUALS_TARGET severityLevelCode: LOW positions: - from: 0 - to: 5 + - from: 0 + to: 5 details: types: - IDENTICAL_CAPITALIZATION @@ -1587,8 +1702,8 @@ x-paths: - checkTypeCode: PUNCTUATION_CONSISTENCY severityLevelCode: LOW positions: - from: 5 - to: 6 + - from: 5 + to: 6 details: punctuationMark: '!' type: PUNCTUATION_MARK_DELETED @@ -1611,8 +1726,8 @@ x-paths: - checkTypeCode: PLURALS_REPETITION severityLevelCode: MEDIUM positions: - from: 0 - to: 5 + - from: 0 + to: 5 details: pluralFormGroupUid: a0b1acda22fc97da9c2b9ae5f3b25888 repeatedPluralForms: @@ -1669,12 +1784,159 @@ x-paths: - checkTypeCode: OPEN_ISSUES severityLevelCode: LOW positions: - from: 0 - to: 5 + - from: 0 + to: 5 details: 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_3 + 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': + 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_3 + 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_3 + 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_3 + 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..cb8ea981 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: @@ -147,7 +147,6 @@ components: properties: profileUid: type: string - required: true description: Unique identifier of corresponding profile. example: "ce6d6b5dbc12" required: @@ -163,15 +162,6 @@ components: required: - name - checkTypeCode: - type: object - properties: - checkTypeCode: - type: string - $ref: '#/components/schemas/enum/checkTypeCodeEnum' - description: '[check type code](#operation/getTranslationQualityCheckTypes)' - example: "LEADING_TRAILING_SPACES" - schemas: groupUidResponse: @@ -201,7 +191,7 @@ components: type: array severityLevelCode: type: string - $ref: '#/components/schemas/enum/severityLevelCodeEnum' + $ref: '#/components/schemas/severityLevelCodeEnum' description: severity level code example: "MEDIUM" @@ -214,17 +204,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: @@ -283,7 +273,7 @@ components: properties: ruleTypeCode: type: string - $ref: '#/components/schemas/enum/ruleTypeCodeEnum' + $ref: '#/components/schemas/ruleTypeCodeEnum' description: rule type code example: "FORBIDDEN" @@ -292,7 +282,7 @@ components: properties: flavorCode: type: string - $ref: '#/components/schemas/enum/flavorCodeEnum' + $ref: '#/components/schemas/flavorCodeEnum' description: flavor code example: "JAVA" @@ -309,7 +299,7 @@ components: properties: checkTypeCode: type: string - $ref: '#/components/schemas/enum/checkTypeCodeEnum' + $ref: '#/components/schemas/checkTypeCodeEnum' description: check type code profileResponse: @@ -345,7 +335,7 @@ components: properties: checkSubTypeCode: type: string - $ref: '#/components/schemas/enum/checkSubtypeEnum' + $ref: '#/components/schemas/checkSubtypeEnum' description: check subtype code example: "EMOJI_ADDED" name: @@ -370,16 +360,17 @@ components: properties: severityLevelCode: type: string - $ref: '#/components/schemas/enum/severityLevelCodeEnum' + $ref: '#/components/schemas/severityLevelCodeEnum' description: severity level code example: "MEDIUM" + severityLevelCodeResponse1: type: object properties: severityLevelCode: type: string - $ref: '#/components/schemas/enum/severityLevelCodeEnum' + $ref: '#/components/schemas/severityLevelCodeEnum' description: severity level code example: "MEDIUM" @@ -421,6 +412,10 @@ components: type: string description: check subtype code example: "" + severityLevelCode: + type: string + description: check subtype code + example: "" localeSeverityLevelsAccountCheckTypeSettingsEffective: type: object @@ -436,7 +431,7 @@ components: example: "it-IT" severityLevelCode: type: string - $ref: '#/components/schemas/enum/severityLevelCodeEnum' + $ref: '#/components/schemas/severityLevelCodeEnum' description: severity level code example: "MEDIUM" @@ -456,6 +451,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: "" @@ -489,6 +485,7 @@ components: properties: pluralFormGroupUid: type: string + nullable: true description: unique identifier of plural form example: "7191152182c69d9b72069ac1290fe24b" @@ -496,6 +493,7 @@ components: type: object properties: pluralForm: + nullable: true type: string description: plural form example: "ONE" @@ -681,7 +679,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' @@ -731,111 +729,117 @@ 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: + 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 + + 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: + type: string + description: severity level code + example: "MEDIUM" + 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