diff --git a/src/assets/api/crowdin/file-based.yml b/src/assets/api/crowdin/file-based.yml index 4551ac59..9296f688 100644 --- a/src/assets/api/crowdin/file-based.yml +++ b/src/assets/api/crowdin/file-based.yml @@ -11913,6 +11913,12 @@ paths: deprecated: true schema: type: integer + - + name: croql + in: query + description: "Filter strings by [CroQL](https://developer.crowdin.com/croql/)\n\n__Note:__ Can be used only with `orderBy`, `offset` and `limit` in same request" + schema: + type: string - $ref: '#/components/parameters/PaginationLimit' - @@ -29365,7 +29371,7 @@ components: type: string example: 'Not all videos are shown to users. See more' identifier: - description: 'Defines unique string identifier' + description: "Defines unique string identifier. Max. length is 512 characters\n\n __Note:__ Required for YAML files and XLSX files with identifiers in their schema" type: string example: 6a1821e6499ebae94de4b880fd93b985 fileId: @@ -29444,7 +29450,7 @@ components: one: string other: strings identifier: - description: 'Defines unique string identifier' + description: "Defines unique string identifier. Max. length is 512 characters\n\n __Note:__ Required for YAML files and XLSX files with identifiers in their schema" type: string example: 6a1821e6499ebae94de4b880fd93b985 fileId: @@ -29485,7 +29491,7 @@ components: one: string other: strings identifier: - description: 'Defines unique string identifier' + description: 'Defines unique string identifier. Max. length is 512 characters' type: string example: 6a1821e6499ebae94de4b880fd93b985 branchId: @@ -33774,6 +33780,11 @@ components: type: boolean default: false example: false + addToTm: + description: 'Defines whether to add translation to TM' + type: boolean + default: true + example: false type: object CrowdinTranslationDirectoryBuildResource: description: 'Translation Resource' diff --git a/src/assets/api/crowdin/string-based.yml b/src/assets/api/crowdin/string-based.yml index 23b2739a..18918225 100644 --- a/src/assets/api/crowdin/string-based.yml +++ b/src/assets/api/crowdin/string-based.yml @@ -11265,6 +11265,12 @@ paths: deprecated: true schema: type: integer + - + name: croql + in: query + description: "Filter strings by [CroQL](https://developer.crowdin.com/croql/)\n\n__Note:__ Can be used only with `orderBy`, `offset` and `limit` in same request" + schema: + type: string - $ref: '#/components/parameters/PaginationLimit' - @@ -27926,7 +27932,7 @@ components: type: string example: 'Not all videos are shown to users. See more' identifier: - description: 'Defines unique string identifier' + description: "Defines unique string identifier. Max. length is 512 characters\n\n __Note:__ Required for YAML files and XLSX files with identifiers in their schema" type: string example: 6a1821e6499ebae94de4b880fd93b985 fileId: @@ -28005,7 +28011,7 @@ components: one: string other: strings identifier: - description: 'Defines unique string identifier' + description: "Defines unique string identifier. Max. length is 512 characters\n\n __Note:__ Required for YAML files and XLSX files with identifiers in their schema" type: string example: 6a1821e6499ebae94de4b880fd93b985 fileId: @@ -28046,7 +28052,7 @@ components: one: string other: strings identifier: - description: 'Defines unique string identifier' + description: 'Defines unique string identifier. Max. length is 512 characters' type: string example: 6a1821e6499ebae94de4b880fd93b985 branchId: @@ -32302,6 +32308,11 @@ components: type: boolean default: false example: false + addToTm: + description: 'Defines whether to add translation to TM' + type: boolean + default: true + example: false type: object CrowdinTranslationDirectoryBuildResource: description: 'Translation Resource' diff --git a/src/assets/api/enterprise/file-based.yml b/src/assets/api/enterprise/file-based.yml index 99ab4116..52afdb50 100644 --- a/src/assets/api/enterprise/file-based.yml +++ b/src/assets/api/enterprise/file-based.yml @@ -13935,6 +13935,12 @@ paths: deprecated: true schema: type: integer + - + name: croql + in: query + description: "Filter strings by [CroQL](https://developer.crowdin.com/croql/)\n\n__Note:__ Can be used only with `orderBy`, `offset` and `limit` in same request" + schema: + type: string - $ref: '#/components/parameters/PaginationLimit' - @@ -16806,6 +16812,89 @@ paths: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedExceptionResource' + '/projects/{projectId}/workflow-steps/{stepId}/strings': + get: + tags: + - Workflows + summary: 'List Strings on the Workflow Step' + operationId: api.projects.workflow-steps.strings.getMany + parameters: + - + $ref: '#/components/parameters/ProjectId' + - + $ref: '#/components/parameters/StepId' + - + $ref: '#/components/parameters/LanguageIds' + - + name: orderBy + in: query + description: 'Read more about [sorting rules](#section/Introduction/Sorting)' + schema: + type: string + default: id + enum: + - id + - text + - identifier + - context + - createdAt + - updatedAt + example: 'createdAt desc,text,identifier' + - + name: status + in: query + description: 'String status on the workflow step' + schema: + type: string + enum: + - todo + - done + - pending + - incomplete + - need_review + - + $ref: '#/components/parameters/PaginationLimit' + - + $ref: '#/components/parameters/PaginationOffset' + responses: + '200': + description: 'Project strings list' + content: + application/json: + schema: + $ref: '#/components/schemas/EnterpriseFileBasedStringCollectionResource' + x-doc-sections: + - file-based + '400': + description: 'Invalid Request Parameters' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorCollectionResource' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/AuthenticateError' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ForbiddenExceptionResource' + '404': + description: 'Project or workflow step with specified id was not found' + content: + application/json: + schema: + $ref: '#/components/schemas/NotFoundExceptionResource' + '405': + description: 'Method Not Allowed' + content: + application/json: + schema: + $ref: '#/components/schemas/MethodNotAllowedExceptionResource' /workflow-templates: get: tags: @@ -32613,7 +32702,7 @@ components: type: string example: 'Not all videos are shown to users. See more' identifier: - description: 'Defines unique string identifier' + description: "Defines unique string identifier. Max. length is 512 characters\n\n __Note:__ Required for YAML files and XLSX files with identifiers in their schema" type: string example: 6a1821e6499ebae94de4b880fd93b985 fileId: @@ -32657,7 +32746,7 @@ components: type: string example: 'Not all videos are shown to users. See more' identifier: - description: 'Defines unique string identifier' + description: 'Defines unique string identifier. Max. length is 512 characters' type: string example: 6a1821e6499ebae94de4b880fd93b985 branchId: @@ -32702,7 +32791,7 @@ components: one: string other: strings identifier: - description: 'Defines unique string identifier' + description: "Defines unique string identifier. Max. length is 512 characters\n\n __Note:__ Required for YAML files and XLSX files with identifiers in their schema" type: string example: 6a1821e6499ebae94de4b880fd93b985 fileId: @@ -32743,7 +32832,7 @@ components: one: string other: strings identifier: - description: 'Defines unique string identifier' + description: 'Defines unique string identifier. Max. length is 512 characters' type: string example: 6a1821e6499ebae94de4b880fd93b985 branchId: @@ -36993,6 +37082,11 @@ components: type: boolean default: false example: false + addToTm: + description: 'Defines whether to add translation to TM' + type: boolean + default: true + example: false markAddedTranslationsAsDone: description: "Strings marked as done follow your project's workflow and appear on the corresponding step" type: boolean @@ -37085,6 +37179,11 @@ components: type: boolean default: false example: false + addToTm: + description: 'Defines whether to add translation to TM' + type: boolean + default: true + example: false type: object EnterpriseTranslationDirectoryBuildResource: description: 'Translation Resource' diff --git a/src/assets/api/enterprise/string-based.yml b/src/assets/api/enterprise/string-based.yml index 4e0a3770..743f9964 100644 --- a/src/assets/api/enterprise/string-based.yml +++ b/src/assets/api/enterprise/string-based.yml @@ -13065,6 +13065,12 @@ paths: deprecated: true schema: type: integer + - + name: croql + in: query + description: "Filter strings by [CroQL](https://developer.crowdin.com/croql/)\n\n__Note:__ Can be used only with `orderBy`, `offset` and `limit` in same request" + schema: + type: string - $ref: '#/components/parameters/PaginationLimit' - @@ -15478,6 +15484,89 @@ paths: application/json: schema: $ref: '#/components/schemas/MethodNotAllowedExceptionResource' + '/projects/{projectId}/workflow-steps/{stepId}/strings': + get: + tags: + - Workflows + summary: 'List Strings on the Workflow Step' + operationId: api.projects.workflow-steps.strings.getMany + parameters: + - + $ref: '#/components/parameters/ProjectId' + - + $ref: '#/components/parameters/StepId' + - + $ref: '#/components/parameters/LanguageIds' + - + name: orderBy + in: query + description: 'Read more about [sorting rules](#section/Introduction/Sorting)' + schema: + type: string + default: id + enum: + - id + - text + - identifier + - context + - createdAt + - updatedAt + example: 'createdAt desc,text,identifier' + - + name: status + in: query + description: 'String status on the workflow step' + schema: + type: string + enum: + - todo + - done + - pending + - incomplete + - need_review + - + $ref: '#/components/parameters/PaginationLimit' + - + $ref: '#/components/parameters/PaginationOffset' + responses: + '200': + description: 'Project strings list' + content: + application/json: + schema: + $ref: '#/components/schemas/EnterpriseStringBasedStringCollectionResource' + x-doc-sections: + - string-based + '400': + description: 'Invalid Request Parameters' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorCollectionResource' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/AuthenticateError' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ForbiddenExceptionResource' + '404': + description: 'Project or workflow step with specified id was not found' + content: + application/json: + schema: + $ref: '#/components/schemas/NotFoundExceptionResource' + '405': + description: 'Method Not Allowed' + content: + application/json: + schema: + $ref: '#/components/schemas/MethodNotAllowedExceptionResource' /workflow-templates: get: tags: @@ -30950,7 +31039,7 @@ components: type: string example: 'Not all videos are shown to users. See more' identifier: - description: 'Defines unique string identifier' + description: "Defines unique string identifier. Max. length is 512 characters\n\n __Note:__ Required for YAML files and XLSX files with identifiers in their schema" type: string example: 6a1821e6499ebae94de4b880fd93b985 fileId: @@ -30994,7 +31083,7 @@ components: type: string example: 'Not all videos are shown to users. See more' identifier: - description: 'Defines unique string identifier' + description: 'Defines unique string identifier. Max. length is 512 characters' type: string example: 6a1821e6499ebae94de4b880fd93b985 branchId: @@ -31039,7 +31128,7 @@ components: one: string other: strings identifier: - description: 'Defines unique string identifier' + description: "Defines unique string identifier. Max. length is 512 characters\n\n __Note:__ Required for YAML files and XLSX files with identifiers in their schema" type: string example: 6a1821e6499ebae94de4b880fd93b985 fileId: @@ -31080,7 +31169,7 @@ components: one: string other: strings identifier: - description: 'Defines unique string identifier' + description: 'Defines unique string identifier. Max. length is 512 characters' type: string example: 6a1821e6499ebae94de4b880fd93b985 branchId: @@ -35283,6 +35372,11 @@ components: type: boolean default: false example: false + addToTm: + description: 'Defines whether to add translation to TM' + type: boolean + default: true + example: false markAddedTranslationsAsDone: description: "Strings marked as done follow your project's workflow and appear on the corresponding step" type: boolean @@ -35375,6 +35469,11 @@ components: type: boolean default: false example: false + addToTm: + description: 'Defines whether to add translation to TM' + type: boolean + default: true + example: false type: object EnterpriseTranslationDirectoryBuildResource: description: 'Translation Resource'