components: securitySchemes: bearerAuth: description: 'To use the API you need to authenticate your requests using Token Authentication. Specifically, you need to * Acquire an authentication token from the Transifex (under user settings) * Uses the `Bearer` keyword and prepend the token when passing the header. For example, if the authentication token is `1/0b4e75552e481aeae813aebad53f3de3fcc67ccd`, then the HTTP header should look like this: `Authorization: Bearer 1/0b4e75552e481aeae813aebad53f3de3fcc67ccd` To create an API token: 1. Head to your User Settings by going to the main navigation, and clicking on your profile image in the top right corner. 2. In the left menu, click on API token. 3. Click Generate a token. Once you''ve generated a token, you can edit its name so it''s easier to remember where you use the token. To keep your API token secure, we''ll only show it once, so please be sure to save it somewhere secure. In case you lose your API token, you can regenerate a new one at any time. However, when you regenerate a new token, you''ll need to update your applications and replace the old token with the new one. ' scheme: bearer type: http info: contact: email: support@transifex.com name: Transifex Support description: "
\n
\n\n# Introduction\n\nThis API is based on **{json:api}**.\n\ \n{json:api} is a specification that follows shared conventions and standards.\ \ This specification enables API discoverability and partial\nself-descriptiveness\ \ through conventions. The Json Api specification exposes resources and their\ \ relationships representations with\nunique uris and all CRUD operations are\ \ performed on those endpoints. With it's simplified approach it assists the API\ \ uniformity.\n\nRead more: https://jsonapi.org/\n\nAdditionally, this API is\ \ defined using OpenAPI (ex Swagger). This means that you can easily:\n* Generate\ \ clients in your preferred: https://swagger.io/tools/swagger-codegen/\n* Download\ \ the specification file (see above) and use it in clients like Postman etc\n\n\
\n
\n\n# Pagination\n\nAll list endpoints include pagination to guarantee\ \ performant responses. Those endpoints will return `next` and `previous` links\ \ in the\nresponse payload (`links` section). The client does not have to construct\ \ any pagination specific URLs or headers, just follow those\nlinks.\n\nPage size\ \ is fixed to 150 items per page.\n\n
\n
\n\n# Content Negotiation\n\ \nThe basic media type for the API is `application/vnd.api+json`. If you want\ \ to execute a request that includes data (`POST`, `PATCH`, `DELETE`)\nyou should\ \ include this media type in the `Content-Type` header. The only case where a\ \ different `Content-Type` header will be accepted is for\nendpoints that can\ \ accept file like objects where the media type used should be `multipart/form-data`.\n\ \nThe base media type this API responds is `application/vnd.api+json`. To retrieve\ \ the data in this media type you should include it in the `Accept`\nheader. The\ \ only case where the server will return another media type is for endpoint that\ \ return file like objects.\nIn this case the media type used should be `*/*`\ \ and the server will prioritize the negotiation to the media type dictated from\ \ the file.\nNote that `application/vnd.api+json` will be also available for accept\ \ header in these cases and will return a JSON serialized representation of the\ \ file.\n\nRead more here: https://jsonapi.org/format/#content-negotiation\n\n\ # File Uploads\n\nThere are three different methods for uploading file content\ \ to Transifex:\n* Using Content-Type `application/vnd.api+json` the content must\n\ \ be JSON serializable.\n - For content that is directly JSON serializable\ \ you can dump the content\n of the file directly and set the `content_encoding`\ \ attribute to `text`.\n - For any content, even if it's not JSON serializable\ \ (eg .xlsx, .idml or .docx file extensions),\n you can encode the file using\ \ the `base64` encoding and set the `content_encoding` attribute to `base64`.\n\ * Using Content-Type `multipart/form-data` the content can be any raw file, and\ \ can\n be send without further processing.\n\n# Asynchronous Processing\n\n\ Asynchronous operations are triggered via a POST request. The response status\ \ in such cases is 202 Accepted, with a link in the Content-Location header.\n\ To check the status of the operation, a client can send a request to the location\ \ given earlier.\nAn optional `callback_url` can be provided when the asynchronous\ \ operation is triggered. If such url is provided, upon completion\na HTTP POST\ \ request is executed containing all information required to identify the specific\ \ operation:\n\nExample request:\n```\nPOST callback_url HTTP/1.1\nContent-Type:\ \ application/json\n\n{\n \"data\": {\n \"type\": resource_strings_async_downloads\"\ ,\n \"id\": \"xxxxxxxxx\",\n \"attributes\": {\n \"location\": \"https://rest.api.transifex.com/resource_strings_async_downloads/xxxxxxxxx\"\ ,\n \"status\": \"succeeded\"\n }\n }\n}\n```\n\n# Restrictions\n\nThe\ \ following Plan based restrictions apply:\n* [Activity Reports](#tag/Activity-Reports)\ \ are available to Premium and up\n* [XLIFF export](#tag/Resource-Translations/paths/~1resource_translations_async_downloads/post)\ \ is available to Premium and up.\n* [Screenshots](#tag/Context-Screenshots) are\ \ available to Premium and up\n\n# Rate Limit\n\nTo maintain optimal performance\ \ and availability of the API, we limit the request rate to 500\nrequests/min\ \ or 30,000 requests / 5 minutes / IP. Polling endpoints like\n`resource_translations_async_downloads/{resource_translations_async_download_id}`\ \ and\n`resource_strings_async_downloads/{resource_strings_async_download_id}`\ \ have a rate limit of 1,200 requests/min.\nOnce past the respective limit, requests\ \ will be throttled and you will get a 429 Throttled response.\n\n\nExample response:\n\ ```\n{\n \"errors\": [\n {\n \"code\": \"Throttled\",\n \"detail\"\ : \"Request was throttled. Expected available in 60 seconds.\",\n \"status\"\ : \"429\",\n \"title\": \"Throttled\"\n }\n ]\n}\n```\n\n# Authentication\n\ \n" title: Transifex API version: '3.0' x-logo: altText: Transifex logo backgroundColor: '#FFFFFF' url: transifex-blue-logo.svg openapi: 3.0.1 paths: /context_screenshot_maps: get: description: Get the context screenshots maps for a project. You can further narrow down the list using the available filters. parameters: - description: Filter results by a project in: query name: filter[project] required: true schema: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string - description: Filter results by a resource in: query name: filter[resource] required: false schema: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string - in: query name: filter[resource_string] required: false schema: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string - description: Retrieve maps related to a specific context screenshot in: query name: filter[context_screenshot] required: false schema: description: Context screenshot identifier example: o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:s:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: additionalProperties: false properties: attributes: additionalProperties: false properties: coordinate_x: description: coordinate of the string position in the screenshot determined by measuring parallel to an x-axis, measured in pixels. example: 423 nullable: true type: number coordinate_y: description: coordinate of the string position in the screenshot determined by measuring parallel to an y-axis, measured in pixels. example: 261 nullable: true type: number datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string height: description: height of the string in screenshot, measured in pixels. example: 59 nullable: true type: number width: description: width of the string in screenshot, measured in pixels. example: 372 nullable: true type: number required: - datetime_created - datetime_modified type: object id: description: Context screenshot map identifier. example: o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:r:resource_slug:m:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:s:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}):r:[a-zA-Z0-9._-]+:m:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /context_screenshots_maps/o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:r:resource_slug:m:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: context_screenshot: additionalProperties: false properties: data: additionalProperties: false description: Context Screenshot identifier data container properties: id: description: Context screenshot identifier example: o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:s:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string type: enum: - context_screenshots type: string required: - type - id type: object links: additionalProperties: false description: Context screenshot related link. properties: related: description: Context screenshot details link. example: /context_screenshots/o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - related type: object required: - links - data type: object resource_string: additionalProperties: false properties: data: additionalProperties: false description: Resource String data container. properties: id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string type: enum: - resource_strings type: string required: - type - id type: object links: additionalProperties: false description: Resource String related link. properties: related: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - related type: object required: - links - data type: object required: - resource_string - context_screenshot type: object type: enum: - context_screenshot_map type: string required: - type - id - attributes - relationships - links type: object type: array links: additionalProperties: false description: Pagination links. properties: next: description: Context screenshot cursor link. example: /context_screenshots_maps/o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:r:resource_slug:m:4abfc726-6a27-4c33-9d99-e5254c8df748&page[cursor]=4abfc7266a274c339d99e5254c8df748 nullable: true type: string previous: description: Context screenshot cursor link. example: /context_screenshots_maps/o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:r:resource_slug:m:4abfc726-6a27-4c33-9d99-e5254c8df748&page[cursor]=4abfc7266a274c339d99e5254c8df748 nullable: true type: string self: description: Context screenshot map details link. example: /context_screenshots_maps/o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:r:resource_slug:m:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self - next - previous type: object required: - data - links type: object description: Success '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get project context screenshot map collection. tags: - Context Screenshots x-released: true post: description: Upload screenshot map. requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Create context screenshot map body request details. properties: attributes: additionalProperties: false properties: coordinate_x: description: coordinate of the string position in the screenshot determined by measuring parallel to an x-axis, measured in pixels. example: 423 nullable: true type: number coordinate_y: description: coordinate of the string position in the screenshot determined by measuring parallel to an y-axis, measured in pixels. example: 261 nullable: true type: number height: description: height of the string in screenshot, measured in pixels. example: 59 nullable: true type: number width: description: width of the string in screenshot, measured in pixels. example: 372 nullable: true type: number type: object relationships: additionalProperties: false description: Context screenshot map parent relationships properties: context_screenshot: additionalProperties: false description: The `context_screenshot` the resource_string belongs to. properties: data: additionalProperties: false description: Context Screenshot identifier data container properties: id: description: Context screenshot identifier example: o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:s:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string type: enum: - context_screenshots type: string required: - type - id type: object required: - data type: object resource_string: additionalProperties: false description: The `resource_string` context screenshot map refers to. properties: data: additionalProperties: false description: Resource String data container. properties: id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string type: enum: - resource_strings type: string required: - type - id type: object required: - data type: object required: - context_screenshot - resource_string type: object type: enum: - context_screenshot_maps type: string required: - type - attributes - relationships type: object required: - data type: object required: true responses: '201': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: coordinate_x: description: coordinate of the string position in the screenshot determined by measuring parallel to an x-axis, measured in pixels. example: 423 nullable: true type: number coordinate_y: description: coordinate of the string position in the screenshot determined by measuring parallel to an y-axis, measured in pixels. example: 261 nullable: true type: number datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string height: description: height of the string in screenshot, measured in pixels. example: 59 nullable: true type: number width: description: width of the string in screenshot, measured in pixels. example: 372 nullable: true type: number required: - datetime_created - datetime_modified type: object id: description: Context screenshot map identifier. example: o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:r:resource_slug:m:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:s:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}):r:[a-zA-Z0-9._-]+:m:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /context_screenshots_maps/o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:r:resource_slug:m:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: context_screenshot: additionalProperties: false properties: data: additionalProperties: false description: Context Screenshot identifier data container properties: id: description: Context screenshot identifier example: o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:s:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string type: enum: - context_screenshots type: string required: - type - id type: object links: additionalProperties: false description: Context screenshot related link. properties: related: description: Context screenshot details link. example: /context_screenshots/o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - related type: object required: - links - data type: object resource_string: additionalProperties: false properties: data: additionalProperties: false description: Resource String data container. properties: id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string type: enum: - resource_strings type: string required: - type - id type: object links: additionalProperties: false description: Resource String related link. properties: related: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - related type: object required: - links - data type: object required: - resource_string - context_screenshot type: object type: enum: - context_screenshot_map type: string required: - type - id - attributes - relationships - links type: object type: object description: Created headers: Location: schema: description: Context screenshot map details link. example: /context_screenshots_maps/o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:r:resource_slug:m:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Upload a new context screenshot map to a resource_string. tags: - Context Screenshots x-released: true /context_screenshot_maps/{context_screenshot_map_id}: delete: description: Delete a context screenshot map. responses: '204': description: No Content. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Delete screenshot map. tags: - Context Screenshots x-released: true get: description: Get details for a context screenshot map. responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: coordinate_x: description: coordinate of the string position in the screenshot determined by measuring parallel to an x-axis, measured in pixels. example: 423 nullable: true type: number coordinate_y: description: coordinate of the string position in the screenshot determined by measuring parallel to an y-axis, measured in pixels. example: 261 nullable: true type: number datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string height: description: height of the string in screenshot, measured in pixels. example: 59 nullable: true type: number width: description: width of the string in screenshot, measured in pixels. example: 372 nullable: true type: number required: - datetime_created - datetime_modified type: object id: description: Context screenshot map identifier. example: o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:r:resource_slug:m:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:s:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}):r:[a-zA-Z0-9._-]+:m:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /context_screenshots_maps/o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:r:resource_slug:m:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: context_screenshot: additionalProperties: false properties: data: additionalProperties: false description: Context Screenshot identifier data container properties: id: description: Context screenshot identifier example: o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:s:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string type: enum: - context_screenshots type: string required: - type - id type: object links: additionalProperties: false description: Context screenshot related link. properties: related: description: Context screenshot details link. example: /context_screenshots/o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - related type: object required: - links - data type: object resource_string: additionalProperties: false properties: data: additionalProperties: false description: Resource String data container. properties: id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string type: enum: - resource_strings type: string required: - type - id type: object links: additionalProperties: false description: Resource String related link. properties: related: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - related type: object required: - links - data type: object required: - resource_string - context_screenshot type: object type: enum: - context_screenshot_map type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful response '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get context screenshot map. tags: - Context Screenshots x-released: true parameters: - example: o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:r:resource_slug:m:4abfc726-6a27-4c33-9d99-e5254c8df748 in: path name: context_screenshot_map_id required: true schema: type: string /context_screenshots: get: description: Get the context screenshots for a project. parameters: - description: Filter results by a project in: query name: filter[project] required: true schema: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: additionalProperties: false properties: attributes: additionalProperties: false properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string media_url: description: the URL of the screenshot' example: https://s3-eu-west-1.amazonaws.com/transifex-context/transifex/transifex/1cb3ff6c-65fa-4a41-8384-4eacaed7da3d_original type: string name: description: name of the screenshot example: Home page type: string thumb_url: description: the URL of the screenshot's thumbnail example: https://s3-eu-west-1.amazonaws.com/transifex-context/transifex/transifex/1cb3ff6c-65fa-4a41-8384-4eacaed7da3d_resized type: string required: - name - media_url - thumb_url - datetime_created - datetime_modified type: object id: description: Context screenshot identifier example: o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:s:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /context_screenshots/o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: context_screenshots_maps: additionalProperties: false properties: links: additionalProperties: false description: Context screenshot maps related link. properties: related: description: Context screenshot maps relation link. example: /context_screenshots_maps/?filter[project]=o:organization_slug:p:project_slug&filter[context_screenshot]=o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - related type: object required: - links type: object project: additionalProperties: false properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - project - context_screenshots_maps type: object type: enum: - context_screenshots type: string required: - type - id - attributes - relationships - links type: object type: array links: additionalProperties: false description: Pagination links. properties: next: description: Context screenshot cursor link. example: /context_screenshots/o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748&page[cursor]=4abfc7266a274c339d99e5254c8df748 nullable: true type: string previous: description: Context screenshot cursor link. example: /context_screenshots/o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748&page[cursor]=4abfc7266a274c339d99e5254c8df748 nullable: true type: string self: description: Context screenshot details link. example: /context_screenshots/o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self - next - previous type: object required: - links - data type: object description: Success '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get project context screenshot collection. tags: - Context Screenshots x-released: true summary: Get project context screenshot collection. /context_screenshots/{context_screenshot_id}: delete: description: Delete a project context screenshot. responses: '204': description: No Content. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Delete screenshot. tags: - Context Screenshots x-released: true get: description: Get details for a context screenshot. responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string media_url: description: the URL of the screenshot' example: https://s3-eu-west-1.amazonaws.com/transifex-context/transifex/transifex/1cb3ff6c-65fa-4a41-8384-4eacaed7da3d_original type: string name: description: name of the screenshot example: Home page type: string thumb_url: description: the URL of the screenshot's thumbnail example: https://s3-eu-west-1.amazonaws.com/transifex-context/transifex/transifex/1cb3ff6c-65fa-4a41-8384-4eacaed7da3d_resized type: string required: - name - media_url - thumb_url - datetime_created - datetime_modified type: object id: description: Context screenshot identifier example: o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:s:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /context_screenshots/o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: context_screenshots_maps: additionalProperties: false properties: links: additionalProperties: false description: Context screenshot maps related link. properties: related: description: Context screenshot maps relation link. example: /context_screenshots_maps/?filter[project]=o:organization_slug:p:project_slug&filter[context_screenshot]=o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - related type: object required: - links type: object project: additionalProperties: false properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - project - context_screenshots_maps type: object type: enum: - context_screenshots type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful response. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get context screenshot. tags: - Context Screenshots x-released: true parameters: - example: o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 in: path name: context_screenshot_id required: true schema: type: string patch: description: Update details of a context screenshot. requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Update resource body request details. properties: attributes: additionalProperties: false properties: name: description: name of the screenshot example: Home page type: string required: - name type: object id: description: Context screenshot identifier example: o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:s:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string type: enum: - context_screenshots type: string required: - type - id - attributes type: object required: - data type: object required: true responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string media_url: description: the URL of the screenshot' example: https://s3-eu-west-1.amazonaws.com/transifex-context/transifex/transifex/1cb3ff6c-65fa-4a41-8384-4eacaed7da3d_original type: string name: description: name of the screenshot example: Home page type: string thumb_url: description: the URL of the screenshot's thumbnail example: https://s3-eu-west-1.amazonaws.com/transifex-context/transifex/transifex/1cb3ff6c-65fa-4a41-8384-4eacaed7da3d_resized type: string required: - name - media_url - thumb_url - datetime_created - datetime_modified type: object id: description: Context screenshot identifier example: o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:s:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /context_screenshots/o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: context_screenshots_maps: additionalProperties: false properties: links: additionalProperties: false description: Context screenshot maps related link. properties: related: description: Context screenshot maps relation link. example: /context_screenshots_maps/?filter[project]=o:organization_slug:p:project_slug&filter[context_screenshot]=o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - related type: object required: - links type: object project: additionalProperties: false properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - project - context_screenshots_maps type: object type: enum: - context_screenshots type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful Response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Update context screenshot. tags: - Context Screenshots x-released: true /context_screenshots/{project_id}: parameters: - description: Format of composite id should be `o:organization_slug:p:project_slug`. in: path name: project_id required: true schema: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string post: description: Upload screenshot. requestBody: content: multipart/form-data: schema: additionalProperties: false properties: content: description: The context screenshot file to upload. example: FILE format: binary type: string name: description: name of the screenshot example: Home page type: string required: - content - name required: true responses: '201': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string media_url: description: the URL of the screenshot' example: https://s3-eu-west-1.amazonaws.com/transifex-context/transifex/transifex/1cb3ff6c-65fa-4a41-8384-4eacaed7da3d_original type: string name: description: name of the screenshot example: Home page type: string thumb_url: description: the URL of the screenshot's thumbnail example: https://s3-eu-west-1.amazonaws.com/transifex-context/transifex/transifex/1cb3ff6c-65fa-4a41-8384-4eacaed7da3d_resized type: string required: - name - media_url - thumb_url - datetime_created - datetime_modified type: object id: description: Context screenshot identifier example: o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:s:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /context_screenshots/o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: context_screenshots_maps: additionalProperties: false properties: links: additionalProperties: false description: Context screenshot maps related link. properties: related: description: Context screenshot maps relation link. example: /context_screenshots_maps/?filter[project]=o:organization_slug:p:project_slug&filter[context_screenshot]=o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - related type: object required: - links type: object project: additionalProperties: false properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - project - context_screenshots_maps type: object type: enum: - context_screenshots type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Created. headers: Location: schema: description: Context screenshot details link. example: /context_screenshots/o:organization_slug:p:project_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] servers: - url: https://usermedia.transifex.com summary: Upload a new context screenshot file to a project. tags: - Context Screenshots x-released: true summary: Upload a new context screenshot file to a project. /discussions/{discussion_id}: parameters: - in: path name: discussion_id required: true schema: description: Discussion identifier. example: d:2e354ef120752c67afa1b6855aa80c52 pattern: ^d:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string /discussions/{discussion_id}/replies: parameters: - in: path name: discussion_id required: true schema: description: Discussion identifier. example: d:2e354ef120752c67afa1b6855aa80c52 pattern: ^d:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string /discussions/{discussion_id}/replies/{reply_id}: parameters: - in: path name: discussion_id required: true schema: description: Discussion identifier. example: d:2e354ef120752c67afa1b6855aa80c52 pattern: ^d:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string - in: path name: reply_id required: true schema: description: Discussion reply identifier. example: d:2e354ef120752c67afa1b6855aa80c52:dr:4abfc7266a274c339d99e5254c8df748 pattern: ^d:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}):dr:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string /glossaries: get: description: Get the list of glossaries that belong to a single organization. parameters: - description: Filter results by an organization in: query name: filter[organization] required: true schema: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string - in: query name: filter[slug] required: false schema: pattern: ^[a-zA-Z0-9._-]+$ type: string - in: query name: filter[name] required: false schema: type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: description: List of Glossary objects. items: additionalProperties: false properties: attributes: additionalProperties: false properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string name: description: The name of the Glossary. example: Product glossary maxLength: 255 type: string slug: description: The slug of the Glossary. example: glossary_slug maxLength: 255 pattern: ^[a-zA-Z0-9_-]+$ type: string required: - slug - name - datetime_created - datetime_modified type: object id: description: Glossary identifier. example: o:organization_slug:g:glossary_slug pattern: ^o:[a-zA-Z0-9._-]+:g:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false description: Glossary self link. properties: self: description: Glossary details link. example: /glossaries/o:organization_slug:g:glossary_slug type: string required: - self type: object relationships: additionalProperties: false description: Glossary relationships. properties: organization: additionalProperties: false properties: data: additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object links: additionalProperties: false properties: related: description: Organization details link. example: /organizations/o:organization_slug type: string required: - related type: object required: - links - data type: object source_language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object required: - source_language - organization type: object type: enum: - glossaries type: string required: - type - id - attributes - relationships - links type: object type: array links: additionalProperties: false description: Pagination links. properties: next: description: Glossary cursor link. example: /glossaries?filter[organization]=o:organization_slug&page[cursor]=XXX nullable: true type: string previous: description: Glossary cursor link. example: /glossaries?filter[organization]=o:organization_slug&page[cursor]=XXX nullable: true type: string self: description: Glossary details link. example: /glossaries/o:organization_slug:g:glossary_slug type: string required: - self - next - previous type: object required: - links - data type: object description: Get a list of all glossaries for a given organization '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: List glossaries tags: - Glossaries x-released: true /glossaries/{glossary_id}: get: description: Get the details of a specific glossary. responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string name: description: The name of the Glossary. example: Product glossary maxLength: 255 type: string slug: description: The slug of the Glossary. example: glossary_slug maxLength: 255 pattern: ^[a-zA-Z0-9_-]+$ type: string required: - slug - name - datetime_created - datetime_modified type: object id: description: Glossary identifier. example: o:organization_slug:g:glossary_slug pattern: ^o:[a-zA-Z0-9._-]+:g:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false description: Glossary self link. properties: self: description: Glossary details link. example: /glossaries/o:organization_slug:g:glossary_slug type: string required: - self type: object relationships: additionalProperties: false description: Glossary relationships. properties: organization: additionalProperties: false properties: data: additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object links: additionalProperties: false properties: related: description: Organization details link. example: /organizations/o:organization_slug type: string required: - related type: object required: - links - data type: object source_language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object required: - source_language - organization type: object type: enum: - glossaries type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful Response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get glossary details tags: - Glossaries x-released: true parameters: - description: Format of composite id should be `o:organization_slug:g:glossary_slug`. in: path name: glossary_id required: true schema: description: Glossary identifier. example: o:organization_slug:g:glossary_slug pattern: ^o:[a-zA-Z0-9._-]+:g:[a-zA-Z0-9_-]+$ type: string summary: Glossary details /glossaries_async_downloads: post: description: 'The response represents the glossary file download job. Check the job''s status and download the file itself once that is completed. The downloaded file will be in CSV format containing glossary terms, their translations, and optionally translation comments. If no language relationship is provided, the CSV will include all glossary languages the authenticated user can view. ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Create glossary download body request details. properties: attributes: additionalProperties: false description: Glossary async download attributes properties: callback_url: default: null description: 'The url that will be called when the processing is completed. For more details about callback_url you can refer to [Asynchronous Processing](#section/Asynchronous-Processing) section ' format: uri nullable: true type: string include_translation_comments: default: false description: 'Include translation comments in the downloaded CSV file. When enabled, a notes column will be added for each language. ' type: boolean relationships: additionalProperties: false description: Glossary download parent relationships. properties: glossary: additionalProperties: false description: The `glossary` for which a CSV file is downloaded. properties: data: additionalProperties: false description: Glossary data container. properties: id: description: Glossary identifier. example: o:organization_slug:g:glossary_slug pattern: ^o:[a-zA-Z0-9._-]+:g:[a-zA-Z0-9_-]+$ type: string type: enum: - glossaries type: string required: - type - id type: object required: - data type: object language: additionalProperties: false description: 'The `language` for which glossary translations are downloaded. If not provided, all glossary languages the authenticated user can view will be included. ' properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object required: - data type: object required: - glossary type: object type: enum: - glossaries_async_downloads type: string required: - type - relationships type: object required: - data type: object required: true responses: '202': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: date_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string date_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string errors: items: additionalProperties: false properties: code: example: csv_generation_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending - processing - failed example: failed type: string required: - status - errors - date_created - date_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /glossaries_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: glossary: additionalProperties: false properties: data: additionalProperties: false description: Glossary data container. properties: id: description: Glossary identifier. example: o:organization_slug:g:glossary_slug pattern: ^o:[a-zA-Z0-9._-]+:g:[a-zA-Z0-9_-]+$ type: string type: enum: - glossaries type: string required: - type - id type: object links: additionalProperties: false description: Glossary related link. properties: related: description: Glossary details link. example: /glossaries/o:organization_slug:g:glossary_slug type: string required: - related type: object required: - links - data type: object language: additionalProperties: false description: 'The language that was requested for the download. Will be absent if all glossary languages were requested. ' properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object required: - glossary type: object type: enum: - glossaries_async_downloads type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Accepted. headers: Content-Location: description: The location of the glossary download. required: true schema: type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Create a glossary file download action tags: - Glossaries x-released: true summary: Create a glossary file download action /glossaries_async_downloads/{glossaries_async_download_id}: get: description: "With this endpoint, you can inquire about the status of a glossary\ \ download job.\n\n- If the value of the 'status' attribute is 'pending' or\ \ 'processing', you\n should check this endpoint again later.\n- If the 'status'\ \ is 'failed', the glossary file has failed to be compiled.\n- In case the\ \ download job has been successful, you will receive a \"303 - See\n Other\"\ \ response and you can follow its `Location` to\n [download the file](#tag/File-Downloads/paths/get)\n\ \ that have been extracted from your file.\n" parameters: - description: Format of the glossaries_async_download_id should be a UUID. in: path name: glossaries_async_download_id required: true schema: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: date_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string date_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string errors: items: additionalProperties: false properties: code: example: csv_generation_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending - processing - failed example: failed type: string required: - status - errors - date_created - date_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /glossaries_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: glossary: additionalProperties: false properties: data: additionalProperties: false description: Glossary data container. properties: id: description: Glossary identifier. example: o:organization_slug:g:glossary_slug pattern: ^o:[a-zA-Z0-9._-]+:g:[a-zA-Z0-9_-]+$ type: string type: enum: - glossaries type: string required: - type - id type: object links: additionalProperties: false description: Glossary related link. properties: related: description: Glossary details link. example: /glossaries/o:organization_slug:g:glossary_slug type: string required: - related type: object required: - links - data type: object language: additionalProperties: false description: 'The language that was requested for the download. Will be absent if all glossary languages were requested. ' properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object required: - glossary type: object type: enum: - glossaries_async_downloads type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful response. '303': content: application/vnd.api+json: schema: {} description: See other headers: Location: description: The location of the glossary file. required: true schema: example: https://storage.svc.transifex.net/files/663a7a83-cb15-4c72-a37d-125dfb8432a6-file?auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZXMiOiJkb3dubG9hZCIsIm1ldGFkYXRhIjpudWxsLCJmaWxlX2lkcyI6IjY2M2E3YTgzLWNiMTUtNGM3Mi1hMzdkLTEyNWRmYjg0MzJhNi1maWxlIiwiZXhwIjoxNTg0NzE3NTkzLCJwcm92aWRlciI6InR4YyJ9.IHgLS4gtL0A6YZd-2zKkrg__geitcvs9DV8LcE8-1io type: string '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get glossary file download status tags: - Glossaries x-released: true summary: Get glossary file download status /i18n_formats: get: description: 'Get information for all the supported i18n formats. For more information check https://help.transifex.com/en/articles/6219670-introduction-to-file-formats ' parameters: - description: Filter results by an organization in: query name: filter[organization] required: true schema: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string - description: Get specific i18n format by name in: query name: filter[name] required: false schema: example: ANDROID nullable: true type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: description: List of i18n format objects. items: additionalProperties: false properties: attributes: additionalProperties: false description: I18n format attributes. properties: description: description: The i18n_type description. example: YAML Files based on the content type: string file_extensions: description: The file name extension association to the media_type. example: - .yml - .yaml items: type: string type: array media_type: description: A two-part identifier for file formats and format contents transmitted. example: text/plain type: string name: description: The name of the i18n format. example: YML_KEY type: string required: - name - media_type - file_extensions - description type: object id: example: YML_KEY pattern: ^[A-Z0-9@_-]+$ type: string type: enum: - i18n_formats type: string required: - type - id - attributes type: object type: array required: - data type: object description: Get a list of all the i18n formats Transifex supports. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: List i18n formats. tags: - I18n Formats x-released: true summary: List i18n formats. /languages: get: description: Get information for all the supported languages. parameters: - description: The code of the language to get details example: fr in: query name: filter[code] required: false schema: pattern: ^[a-z0-9._@-]+$ type: string - description: A list of codes of the languages to get details. This will fetch any available. example: en,fr,az@Arab in: query name: filter[code][any] required: false schema: pattern: ^([a-z0-9._@-]+,?)+$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: description: List of language objects. items: additionalProperties: false properties: attributes: additionalProperties: false description: Language attributes. properties: code: description: The language code as defined in CLDR. example: en type: string name: description: The name of the Language as defined in CLDR. example: English type: string plural_equation: description: The language plural rule equation as defined in CLDR. example: (n != 1) type: string plural_rules: description: Object of plural rules for Language as defined in CLDR. items: type: string type: object rtl: description: If the language is rlt. example: false type: boolean required: - code - name - rtl - plural_rules - plural_equation type: object id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string links: additionalProperties: false description: Language links. properties: self: description: Language details link. example: /languages/l:en_US type: string required: - self type: object type: enum: - languages type: string required: - type - id - attributes - links type: object type: array required: - data type: object description: Get a list of all the languages Transifex supports. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: List languages tags: - Languages x-released: true summary: List languages /languages/{language_id}: get: description: Get information for a specific supported language. parameters: - description: Format of the language id should be `l:language_code`. in: path name: language_id required: true schema: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false description: Language attributes. properties: code: description: The language code as defined in CLDR. example: en type: string name: description: The name of the Language as defined in CLDR. example: English type: string plural_equation: description: The language plural rule equation as defined in CLDR. example: (n != 1) type: string plural_rules: description: Object of plural rules for Language as defined in CLDR. items: type: string type: object rtl: description: If the language is rlt. example: false type: boolean required: - code - name - rtl - plural_rules - plural_equation type: object id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string links: additionalProperties: false description: Language links. properties: self: description: Language details link. example: /languages/l:en_US type: string required: - self type: object type: enum: - languages type: string required: - type - id - attributes - links type: object required: - data type: object description: Successful Response. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get language details tags: - Languages x-released: true summary: Get language details /organization_activity_reports_async_downloads: post: description: 'The response represents the organization activity report file download job. Check the job''s status and download the file itself once that is completed. ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: 'Create organization activity report download body request details. ' properties: attributes: additionalProperties: false properties: date_from: description: Date, will be treated as UTC by the API example: XXXX-XX-XX format: date type: string date_to: description: Date, will be treated as UTC by the API example: XXXX-XX-XX format: date type: string first_time_edits: default: false description: Option to include first time edited/reviewed words. example: false type: boolean required: - date_from type: object relationships: additionalProperties: false properties: language: additionalProperties: false description: 'Only fetch translation activity for this language ' properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object required: - data type: object organization: additionalProperties: false description: 'The `organization` whose translation activity you want to make a report for. ' properties: data: additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object required: - data type: object user: additionalProperties: false description: 'Only fetch translation activity for this user ' properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object required: - data type: object required: - organization type: object type: enum: - organization_activity_reports_async_downloads type: string required: - type - attributes - relationships type: object required: - data type: object required: true responses: '202': content: application/vnd.api+json: schema: additionalProperties: false properties: data: allOf: - properties: attributes: additionalProperties: false properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string errors: items: properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending type: string required: - status - errors - datetime_created - datetime_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string required: - id - attributes type: object - description: The organization activity report download job. properties: links: additionalProperties: false properties: self: example: /organization_activity_reports_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: properties: language: properties: data: allOf: - additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: allOf: - additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object type: object organization: properties: data: allOf: - additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object links: allOf: - additionalProperties: false properties: related: description: Organization details link. example: /organizations/o:organization_slug type: string required: - related type: object type: object user: properties: data: allOf: - description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: allOf: - additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object type: object required: - organization type: object type: enum: - organization_activity_reports_async_downloads type: string required: - type - links - relationships type: object required: - data type: object description: Accepted. headers: Content-Location: description: 'The location of the organization activity report download. ' schema: example: /organization_activity_reports_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Create an organization activity report file download action tags: - Activity Reports x-released: true summary: Create an organization activity report file download action /organization_activity_reports_async_downloads/{organization_activity_reports_async_download_id}: get: description: "With this endpoint, you can inquire about the status of an organization\n\ activity report download job.\n\n- If the value of the 'status' attribute\ \ is 'pending' or 'processing', you\n should check this endpoint again later.\n\ - If the 'status' is 'failed', the report has failed to be compiled.\n- In\ \ case the upload job has been successful, you will receive a \"303 - See\n\ \ Other\" response and you can follow its `Location` to\n [download the\ \ file](#tag/File-Downloads/paths/get) that have been\n extracted from your\ \ file.\n" parameters: - description: 'Format of the organization_activity_reports_async_download_id should be a UUID. ' in: path name: organization_activity_reports_async_download_id required: true schema: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: allOf: - properties: attributes: additionalProperties: false properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string errors: items: properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending type: string required: - status - errors - datetime_created - datetime_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string required: - id - attributes type: object - description: The organization activity report download job. properties: links: additionalProperties: false properties: self: example: /organization_activity_reports_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: properties: language: properties: data: allOf: - additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: allOf: - additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object type: object organization: properties: data: allOf: - additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object links: allOf: - additionalProperties: false properties: related: description: Organization details link. example: /organizations/o:organization_slug type: string required: - related type: object type: object user: properties: data: allOf: - description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: allOf: - additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object type: object required: - organization type: object type: enum: - organization_activity_reports_async_downloads type: string required: - type - links - relationships type: object required: - data type: object description: Successful response. '303': content: application/vnd.api+json: schema: {} description: See other headers: Location: description: The location of the file. required: true schema: example: https://storage.svc.transifex.net/files/663a7a83-cb15-4c72-a37d-125dfb8432a6-file?auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZXMiOiJkb3dubG9hZCIsIm1ldGFkYXRhIjpudWxsLCJmaWxlX2lkcyI6IjY2M2E3YTgzLWNiMTUtNGM3Mi1hMzdkLTEyNWRmYjg0MzJhNi1maWxlIiwiZXhwIjoxNTg0NzE3NTkzLCJwcm92aWRlciI6InR4YyJ9.IHgLS4gtL0A6YZd-2zKkrg__geitcvs9DV8LcE8-1io type: string '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Get organization activity report download status tags: - Activity Reports x-released: true summary: Get organization activity report download status /organizations: get: description: Get a list of all the Organizations the user belongs to. parameters: - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string - description: The slug of the organization to get details in: query name: filter[slug] required: false schema: pattern: ^[a-zA-Z0-9._-]+$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: description: List of orgnanization objects. items: additionalProperties: false properties: attributes: additionalProperties: false description: Organization attributes. properties: logo_url: description: The organization logo url. example: https://txc-assets-775662142440-prod.s3.amazonaws.com/mugshots/435381b2e0.jpg format: uri nullable: true type: string name: description: The organization name. example: Transifex type: string private: description: Private organization. A private organization is visible only by you and your team. example: false type: boolean slug: description: The organization slug. example: transifex-94 type: string required: - name - slug - private type: object id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string links: additionalProperties: false description: Organization links. properties: self: description: Organization details link. example: /organizations/o:my_org type: string required: - self type: object relationships: additionalProperties: false properties: projects: additionalProperties: false properties: links: additionalProperties: false description: Project links. properties: related: description: Organization projects relationship link. example: /projects?filter[organization]=XXX type: string required: - related type: object required: - links type: object teams: additionalProperties: false properties: links: additionalProperties: false description: Team links. properties: related: description: Organization teams relationship link. example: /teams?filter[organization]=XXX type: string required: - related type: object required: - links type: object type: object type: enum: - organizations type: string required: - type - id - attributes - links type: object type: array links: additionalProperties: false description: Pagination links. properties: next: description: Organization collection cursor link. example: /organizations?page[cursor]=XXX nullable: true type: string previous: description: Organization collection cursor link. example: /organizations?page[cursor]=XXX nullable: true type: string self: description: Organization collection link. example: /organizations type: string required: - self - next - previous type: object required: - links - data type: object description: Get a list of all the Organizations the user belongs to. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: List organizations tags: - Organizations x-released: true summary: List organizations /organizations/{organization_id}: get: description: Get the details of an Organization. parameters: - description: Format of the organization id. Should be `o:organization_slug`. in: path name: organization_id required: true schema: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false description: Organization attributes. properties: logo_url: description: The organization logo url. example: https://txc-assets-775662142440-prod.s3.amazonaws.com/mugshots/435381b2e0.jpg format: uri nullable: true type: string name: description: The organization name. example: Transifex type: string private: description: Private organization. A private organization is visible only by you and your team. example: false type: boolean slug: description: The organization slug. example: transifex-94 type: string required: - name - slug - private type: object id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string links: additionalProperties: false description: Organization links. properties: self: description: Organization details link. example: /organizations/o:my_org type: string required: - self type: object relationships: additionalProperties: false properties: projects: additionalProperties: false properties: links: additionalProperties: false description: Project links. properties: related: description: Organization projects relationship link. example: /projects?filter[organization]=XXX type: string required: - related type: object required: - links type: object teams: additionalProperties: false properties: links: additionalProperties: false description: Team links. properties: related: description: Organization teams relationship link. example: /teams?filter[organization]=XXX type: string required: - related type: object required: - links type: object type: object type: enum: - organizations type: string required: - type - id - attributes - links type: object required: - data type: object description: Successful Response. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get organization details tags: - Organizations x-released: true summary: Get organization details /organizations/{organization_id}/administrators: description: Organization administrators. parameters: - description: Format of the organization id. Should be `o:organization_slug`. in: path name: organization_id required: true schema: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string summary: Get organization administrators /organizations/{organization_id}/relationships/administrators: description: Update organization administrators. parameters: - description: Format of the organization id. Should be `o:organization_slug`. in: path name: organization_id required: true schema: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string summary: Edit organization administrators /project_activity_reports_async_downloads: post: description: 'The response represents the project activity report download job. Check the job''s status and download the file itself once that is completed. ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: 'Create project activity report download body request details. ' properties: attributes: additionalProperties: false properties: date_from: description: Date, will be treated as UTC by the API example: XXXX-XX-XX format: date type: string date_to: description: Date, will be treated as UTC by the API example: XXXX-XX-XX format: date type: string first_time_edits: default: false description: Option to include first time edited/reviewed words. example: false type: boolean required: - date_from type: object relationships: additionalProperties: false properties: language: additionalProperties: false description: 'Only fetch translation activity for this language ' properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object required: - data type: object project: additionalProperties: false description: 'The `project` whose translation activity you want to make a report for. ' properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object required: - data type: object user: additionalProperties: false description: 'Only fetch translation activity for this user ' properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object required: - data type: object required: - project type: object type: enum: - project_activity_reports_async_downloads type: string required: - type - attributes - relationships type: object required: - data type: object required: true responses: '202': content: application/vnd.api+json: schema: additionalProperties: false properties: data: allOf: - properties: attributes: additionalProperties: false properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string errors: items: properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending type: string required: - status - errors - datetime_created - datetime_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string required: - id - attributes type: object - properties: links: additionalProperties: false properties: self: example: /project_activity_reports_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: properties: language: properties: data: allOf: - additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: allOf: - additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object type: object project: properties: data: allOf: - additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: allOf: - additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object type: object user: properties: data: allOf: - description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: allOf: - additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object type: object required: - project type: object type: enum: - project_activity_reports_async_downloads type: string required: - type - links - relationships type: object required: - data type: object description: Accepted. headers: Content-Location: description: The location of the project activity report download. schema: example: /project_activity_reports_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Create a project activity report file download action tags: - Activity Reports x-released: true summary: Create a project activity report file download action /project_activity_reports_async_downloads/{project_activity_reports_async_download_id}: get: description: "With this endpoint, you can inquire about the status of a project\ \ activity\nreport download job.\n\n- If the value of the 'status' attribute\ \ is 'pending' or 'processing', you\n should check this endpoint again later.\n\ - If the 'status' is 'failed', the report has failed to be compiled.\n- In\ \ case the upload job has been successful, you will receive a \"303 - See\n\ \ Other\" response and you can follow its `Location` to\n [download the\ \ file](#tag/File-Downloads/paths/get) that have been\n extracted from your\ \ file.\n" parameters: - description: 'Format of the project_activity_reports_async_download_id should be a UUID. ' in: path name: project_activity_reports_async_download_id required: true schema: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: allOf: - properties: attributes: additionalProperties: false properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string errors: items: properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending type: string required: - status - errors - datetime_created - datetime_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string required: - id - attributes type: object - properties: links: additionalProperties: false properties: self: example: /project_activity_reports_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: properties: language: properties: data: allOf: - additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: allOf: - additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object type: object project: properties: data: allOf: - additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: allOf: - additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object type: object user: properties: data: allOf: - description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: allOf: - additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object type: object required: - project type: object type: enum: - project_activity_reports_async_downloads type: string required: - type - links - relationships type: object required: - data type: object description: Successful response. '303': content: application/vnd.api+json: schema: {} description: See other headers: Location: description: The location of the file. required: true schema: example: https://storage.svc.transifex.net/files/663a7a83-cb15-4c72-a37d-125dfb8432a6-file?auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZXMiOiJkb3dubG9hZCIsIm1ldGFkYXRhIjpudWxsLCJmaWxlX2lkcyI6IjY2M2E3YTgzLWNiMTUtNGM3Mi1hMzdkLTEyNWRmYjg0MzJhNi1maWxlIiwiZXhwIjoxNTg0NzE3NTkzLCJwcm92aWRlciI6InR4YyJ9.IHgLS4gtL0A6YZd-2zKkrg__geitcvs9DV8LcE8-1io type: string '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Get project activity report download status tags: - Activity Reports x-released: true summary: Get project activity report download status /project_localization_activity: get: description: 'Returns aggregated word count activity (translated, reviewed, proofread) for a project over a specified date range. Unlike the async activity report downloads, this endpoint returns a synchronous JSON response with project-level totals rather than a per-user/language CSV breakdown. Accessible by organization administrators, team managers, and project maintainers. ' parameters: - description: Filter results by a project in: query name: filter[project] required: true schema: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string - description: Start date of the reporting period (inclusive), format YYYY-MM-DD. in: query name: filter[date][from] required: true schema: description: Date, will be treated as UTC by the API example: XXXX-XX-XX format: date type: string - description: End date of the reporting period (inclusive), format YYYY-MM-DD. in: query name: filter[date][to] required: true schema: description: Date, will be treated as UTC by the API example: XXXX-XX-XX format: date type: string - description: Filter results by a language in: query name: filter[language] required: false schema: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: properties: attributes: additionalProperties: false properties: date_from: description: Date, will be treated as UTC by the API example: XXXX-XX-XX format: date type: string date_to: description: Date, will be treated as UTC by the API example: XXXX-XX-XX format: date type: string proofread_words: additionalProperties: false properties: total: example: 280 type: integer required: - total type: object reviewed_words: additionalProperties: false properties: total: example: 350 type: integer required: - total type: object translated_words: additionalProperties: false properties: edited: example: 200 type: integer new: example: 500 type: integer total: example: 700 type: integer required: - new - edited - total type: object required: - date_from - date_to - translated_words - reviewed_words - proofread_words type: object id: description: Project identifier. example: o:organization_slug:p:project_slug type: string type: enum: - project_localization_activity type: string required: - type - id - attributes type: object required: - data type: object description: Success. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get project localization activity tags: - Activity Reports x-released: true summary: Get project localization activity /project_webhooks: get: description: Get information for all the supported project webhooks. parameters: - description: Filter results by an organization in: query name: filter[organization] required: true schema: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string - description: Filter results by a project in: query name: filter[project] required: false schema: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: description: List of project webhook objects. items: additionalProperties: false properties: attributes: additionalProperties: false description: Project Webhook attributes. properties: active: description: Whether the webhook will be triggered when the event occurs. type: boolean callback_url: description: the url the webhook should call when triggered. type: string datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string event_type: description: 'The event that when occurred will trigger the webhook. The following events are supported: * `translation_completed` * `translation_updated_completed` * `review_completed` * `proofread_completed` * `fillup_completed` * `resource_language_stats` * `task_tag_created` * `task_tag_completed` For details about when each of the events is fired, please visit https://help.transifex.com/en/articles/6216204-webhooks. ' enum: - all_events - translation_completed - translation_updated_completed - review_completed - proofread_completed - fillup_completed - resource_language_stats - task_tag_created - task_tag_completed type: string secret_key: description: 'The secret key is used in order to validate the sender of the request as well as that the content is not tampered. The secret key will be included in the http request when the webhook is triggered. The request will include the headers `X-TX-Signature-V2`, `Content-MD5`, `X-TX-Url`, `Date` For more details about webhook verification, check https://help.transifex.com/en/articles/6216204-webhooks. ' example: mysecret type: string required: - event_type - active - callback_url - secret_key - datetime_created - datetime_modified type: object id: description: Project Webhook identifier. example: o:organization_slug:p:project_slug:w:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:w:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false description: Project Webhook self link. properties: self: description: Project Webhook details link. example: /project_webhooks/?filter[organization]=o:organization_slug&filter[organization]=o:organization_slug:p:project_slug type: string required: - self type: object relationships: additionalProperties: false description: Project Webhook relationships. properties: project: additionalProperties: false description: Project object. properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - project type: object type: enum: - project_webhooks type: string required: - type - id - attributes - links - relationships type: object type: array links: additionalProperties: false description: Pagination links. properties: next: description: Project Webhook cursor link. example: /project_webhooks/?filter[organization]=o:organization_slug&filter[organization]=o:organization_slug:p:project_slug&page[cursor]=4abfc7266a274c339d99e5254c8df748 nullable: true type: string previous: description: Project Webhook cursor link. example: /project_webhooks/?filter[organization]=o:organization_slug&filter[organization]=o:organization_slug:p:project_slug&page[cursor]=4abfc7266a274c339d99e5254c8df748 nullable: true type: string self: description: Project Webhook details link. example: /project_webhooks/?filter[organization]=o:organization_slug&filter[organization]=o:organization_slug:p:project_slug type: string required: - self - next - previous type: object required: - data - links type: object description: Get a list of all the project webhooks of your organization. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: List project webhooks. tags: - Project Webhooks x-released: true post: description: Create a new webhook. This needs to be associated with a project. requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Create project webhook body request details. properties: attributes: additionalProperties: false description: Project Webhook attributes. properties: active: description: Whether the webhook will be triggered when the event occurs. type: boolean callback_url: description: the url the webhook should call when triggered. type: string event_type: description: 'The event that when occurred will trigger the webhook. The following events are supported: * `translation_completed` * `translation_updated_completed` * `review_completed` * `proofread_completed` * `fillup_completed` * `resource_language_stats` * `task_tag_created` * `task_tag_completed` For details about when each of the events is fired, please visit https://help.transifex.com/en/articles/6216204-webhooks. ' enum: - all_events - translation_completed - translation_updated_completed - review_completed - proofread_completed - fillup_completed - resource_language_stats - task_tag_created - task_tag_completed type: string secret_key: description: 'The secret key is used in order to validate the sender of the request as well as that the content is not tampered. The secret key will be included in the http request when the webhook is triggered. The request will include the headers `X-TX-Signature-V2`, `Content-MD5`, `X-TX-Url`, `Date` For more details about webhook verification, check https://help.transifex.com/en/articles/6216204-webhooks. ' example: mysecret type: string required: - event_type - active - callback_url type: object relationships: additionalProperties: false description: Project Webhook parent relationships. properties: project: additionalProperties: false description: The `project` this webhook belongs to. properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object required: - data type: object required: - project type: object type: enum: - project_webhooks type: string required: - type - attributes - relationships type: object required: - data type: object required: true responses: '201': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false description: Project Webhook attributes. properties: active: description: Whether the webhook will be triggered when the event occurs. type: boolean callback_url: description: the url the webhook should call when triggered. type: string datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string event_type: description: 'The event that when occurred will trigger the webhook. The following events are supported: * `translation_completed` * `translation_updated_completed` * `review_completed` * `proofread_completed` * `fillup_completed` * `resource_language_stats` * `task_tag_created` * `task_tag_completed` For details about when each of the events is fired, please visit https://help.transifex.com/en/articles/6216204-webhooks. ' enum: - all_events - translation_completed - translation_updated_completed - review_completed - proofread_completed - fillup_completed - resource_language_stats - task_tag_created - task_tag_completed type: string secret_key: description: 'The secret key is used in order to validate the sender of the request as well as that the content is not tampered. The secret key will be included in the http request when the webhook is triggered. The request will include the headers `X-TX-Signature-V2`, `Content-MD5`, `X-TX-Url`, `Date` For more details about webhook verification, check https://help.transifex.com/en/articles/6216204-webhooks. ' example: mysecret type: string required: - event_type - active - callback_url - secret_key - datetime_created - datetime_modified type: object id: description: Project Webhook identifier. example: o:organization_slug:p:project_slug:w:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:w:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false description: Project Webhook self link. properties: self: description: Project Webhook details link. example: /project_webhooks/?filter[organization]=o:organization_slug&filter[organization]=o:organization_slug:p:project_slug type: string required: - self type: object relationships: additionalProperties: false description: Project Webhook relationships. properties: project: additionalProperties: false description: Project object. properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - project type: object type: enum: - project_webhooks type: string required: - type - id - attributes - links - relationships type: object required: - data type: object description: Created. headers: Location: schema: example: /project_webhooks/o:organization_slug:p:project_slug:w:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Create project webhook. tags: - Project Webhooks x-released: true /project_webhooks/{webhook_id}: delete: description: Delete a project webhook from an organization. responses: '204': description: No Content '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Delete project webhook. tags: - Project Webhooks x-released: true get: description: Get the details of the project webhook specified by the required path parameter `webhook_id`. responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false description: Project Webhook attributes. properties: active: description: Whether the webhook will be triggered when the event occurs. type: boolean callback_url: description: the url the webhook should call when triggered. type: string datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string event_type: description: 'The event that when occurred will trigger the webhook. The following events are supported: * `translation_completed` * `translation_updated_completed` * `review_completed` * `proofread_completed` * `fillup_completed` * `resource_language_stats` * `task_tag_created` * `task_tag_completed` For details about when each of the events is fired, please visit https://help.transifex.com/en/articles/6216204-webhooks. ' enum: - all_events - translation_completed - translation_updated_completed - review_completed - proofread_completed - fillup_completed - resource_language_stats - task_tag_created - task_tag_completed type: string secret_key: description: 'The secret key is used in order to validate the sender of the request as well as that the content is not tampered. The secret key will be included in the http request when the webhook is triggered. The request will include the headers `X-TX-Signature-V2`, `Content-MD5`, `X-TX-Url`, `Date` For more details about webhook verification, check https://help.transifex.com/en/articles/6216204-webhooks. ' example: mysecret type: string required: - event_type - active - callback_url - secret_key - datetime_created - datetime_modified type: object id: description: Project Webhook identifier. example: o:organization_slug:p:project_slug:w:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:w:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false description: Project Webhook self link. properties: self: description: Project Webhook details link. example: /project_webhooks/?filter[organization]=o:organization_slug&filter[organization]=o:organization_slug:p:project_slug type: string required: - self type: object relationships: additionalProperties: false description: Project Webhook relationships. properties: project: additionalProperties: false description: Project object. properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - project type: object type: enum: - project_webhooks type: string required: - type - id - attributes - links - relationships type: object required: - data type: object description: Successful Response. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get project webhooks details. tags: - Project Webhooks x-released: true parameters: - description: Format of composite id should be `o:organization_slug:p:project_slug:w:4abfc726-6a27-4c33-9d99-e5254c8df748. in: path name: webhook_id required: true schema: description: Project Webhook identifier. example: o:organization_slug:p:project_slug:w:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:w:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string patch: description: update a project webhook. You can for example modify its status. requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Update project webhook body request details. properties: attributes: additionalProperties: false description: ProjectWebhook attributes. minProperties: 1 properties: active: description: Whether the webhook will be triggered when the event occurs. type: boolean callback_url: description: the url the webhook should call when triggered. type: string event_type: description: 'The event that when occurred will trigger the webhook. The following events are supported: * `translation_completed` * `translation_updated_completed` * `review_completed` * `proofread_completed` * `fillup_completed` * `resource_language_stats` * `task_tag_created` * `task_tag_completed` For details about when each of the events is fired, please visit https://help.transifex.com/en/articles/6216204-webhooks. ' enum: - all_events - translation_completed - translation_updated_completed - review_completed - proofread_completed - fillup_completed - resource_language_stats - task_tag_created - task_tag_completed type: string secret_key: description: 'The secret key is used in order to validate the sender of the request as well as that the content is not tampered. The secret key will be included in the http request when the webhook is triggered. The request will include the headers `X-TX-Signature-V2`, `Content-MD5`, `X-TX-Url`, `Date` For more details about webhook verification, check https://help.transifex.com/en/articles/6216204-webhooks. ' example: mysecret type: string type: object id: description: Project Webhook identifier. example: o:organization_slug:p:project_slug:w:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:w:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string type: enum: - project_webhooks type: string required: - type - id - attributes type: object required: - data type: object required: true responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: List of project webhook objects in an organization properties: attributes: additionalProperties: false description: Project Webhook attributes. properties: active: description: Whether the webhook will be triggered when the event occurs. type: boolean callback_url: description: the url the webhook should call when triggered. type: string datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string event_type: description: 'The event that when occurred will trigger the webhook. The following events are supported: * `translation_completed` * `translation_updated_completed` * `review_completed` * `proofread_completed` * `fillup_completed` * `resource_language_stats` * `task_tag_created` * `task_tag_completed` For details about when each of the events is fired, please visit https://help.transifex.com/en/articles/6216204-webhooks. ' enum: - all_events - translation_completed - translation_updated_completed - review_completed - proofread_completed - fillup_completed - resource_language_stats - task_tag_created - task_tag_completed type: string secret_key: description: 'The secret key is used in order to validate the sender of the request as well as that the content is not tampered. The secret key will be included in the http request when the webhook is triggered. The request will include the headers `X-TX-Signature-V2`, `Content-MD5`, `X-TX-Url`, `Date` For more details about webhook verification, check https://help.transifex.com/en/articles/6216204-webhooks. ' example: mysecret type: string required: - event_type - active - callback_url - secret_key - datetime_created - datetime_modified type: object id: description: Project Webhook identifier. example: o:organization_slug:p:project_slug:w:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:w:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false description: Project Webhook self link. properties: self: description: Project Webhook details link. example: /project_webhooks/?filter[organization]=o:organization_slug&filter[organization]=o:organization_slug:p:project_slug type: string required: - self type: object relationships: additionalProperties: false description: Project Webhook relationships. properties: project: additionalProperties: false description: Project object. properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - project type: object type: enum: - project_webhooks type: string required: - type - id - attributes - links - relationships type: object required: - data type: object description: Successful response '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Update project webhook. tags: - Project Webhooks x-released: true summary: Get the details of a Project Webhook /projects: get: description: Get the list of projects that belong to a single organization. parameters: - description: Filter results by an organization in: query name: filter[organization] required: true schema: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string - in: query name: filter[slug] required: false schema: pattern: ^[a-zA-Z0-9._-]+$ type: string - in: query name: filter[name] required: false schema: type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: description: List of Project objects. items: additionalProperties: false properties: attributes: additionalProperties: false description: Project attributes. properties: ai_fillup: default: false description: 'If the Resources of the Project will be filled-up from Transifex AI. ' example: false type: boolean archived: description: 'If the project is archived or not. If a project is archived the pricing will be lower but no action will be available. ' example: false type: boolean datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string description: description: A description of the Project. example: The localization effort for Transifex core project maxLength: 255 type: string homepage_url: description: The homepage of the Project. example: https://www.transifex.com format: uri type: string instructions_url: description: 'A web page containing documentation or instructions for translators, or localization tips for your community. ' example: https://www.transifex.com/localization-tips format: uri type: string license: description: The license of the Project. enum: - proprietary - open_source - permissive_open_source - other_open_source type: string logo_url: description: The URL of the project's logo. example: https://www.logos.com/project_logo.svg format: uri type: string long_description: description: A long description of the Project. example: 'The localization effort for Transifex core project. Everyone is welcomed to contribute ' maxLength: 1000 type: string machine_translation_fillup: default: false description: 'If the Resources of the Project will be filled-up from a Machine Translation. ' example: false type: boolean name: description: The name of the Project. example: Transifex core maxLength: 255 type: string private: description: 'If the project is private or not. A private project is visible only by you and your team. ' example: false type: boolean repository_url: description: The URL of the public source code repository. example: https://www.github.com/transifex/ format: uri type: string slug: description: The slug of the Project. example: project_slug maxLength: 255 pattern: ^[a-zA-Z0-9_-]+$ type: string tags: description: List of tags for the Project. example: - core - casual items: type: string type: array translation_memory_fillup: default: false description: 'If the Resources of the Project will be filled-up from the common Translation Memory. ' example: false type: boolean type: description: The type of the Project. enum: - live - file type: string required: - slug - name - type - tags - description - long_description - private - archived - translation_memory_fillup - machine_translation_fillup - homepage_url - repository_url - instructions_url - license - datetime_created - datetime_modified - logo_url type: object id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false description: Project self link. properties: self: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - self type: object relationships: additionalProperties: false description: Project relationships. properties: languages: additionalProperties: false properties: links: additionalProperties: false description: Project languages links. properties: related: description: Project language details link. example: /projects/o:organization_slug:p:project_slug/languages type: string self: description: Project language relationship link. example: /projects/o:organization_slug:p:project_slug/relationships/languages type: string required: - related - self type: object required: - links type: object maintainers: additionalProperties: false properties: links: additionalProperties: false description: Project maintainers links. properties: related: description: Project maintainers details link. example: /projects/o:organization_slug:p:project_slug/maintainers type: string self: description: Project maintainers relationship link. example: /projects/o:organization_slug:p:project_slug/relationships/maintainers type: string required: - self - related type: object required: - links type: object organization: additionalProperties: false properties: data: additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object links: additionalProperties: false properties: related: description: Organization details link. example: /organizations/o:organization_slug type: string required: - related type: object required: - links - data type: object resources: additionalProperties: false properties: links: additionalProperties: false description: Project resources links. properties: related: description: Project resources details link. example: /resources?filter[project]:XXX type: string required: - related type: object required: - links type: object source_language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object team: additionalProperties: false properties: data: description: Team data container. properties: id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - teams type: string required: - type - id type: object links: additionalProperties: false properties: related: example: /teams/o:organization_slug:t:team_slug type: string self: example: /projects/o:organization_slug:t:team_slug/relationships/team type: string required: - self - related type: object required: - links - data type: object required: - source_language - organization - team - languages - maintainers - resources type: object type: enum: - projects type: string required: - type - id - attributes - relationships - links type: object type: array links: additionalProperties: false description: Pagination links. properties: next: description: Project cursor link. example: /projects?filter[organization]=o:organization_slug&page[cursor]=XXX nullable: true type: string previous: description: Project cursor link. example: /projects?filter[organization]=o:organization_slug&page[cursor]=XXX nullable: true type: string self: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - self - next - previous type: object required: - links - data type: object description: Get a list of all the projects for a given organization '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: List projects tags: - Projects x-released: true post: requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Create project body request details. properties: attributes: additionalProperties: false properties: ai_fillup: default: false description: 'If the Resources of the Project will be filled-up from Transifex AI. ' example: false type: boolean description: description: A description of the Project. example: The localization effort for Transifex core project maxLength: 255 type: string homepage_url: description: The homepage of the Project. example: https://www.transifex.com format: uri type: string instructions_url: description: 'A web page containing documentation or instructions for translators, or localization tips for your community. ' example: https://www.transifex.com/localization-tips format: uri type: string license: description: The license of the Project. enum: - proprietary - open_source - permissive_open_source - other_open_source type: string long_description: description: A long description of the Project. example: 'The localization effort for Transifex core project. Everyone is welcomed to contribute ' maxLength: 1000 type: string machine_translation_fillup: default: false description: 'If the Resources of the Project will be filled-up from a Machine Translation. ' example: false type: boolean name: description: The name of the Project. example: Transifex core maxLength: 255 type: string private: description: 'If the project is private or not. A private project is visible only by you and your team. ' example: false type: boolean repository_url: description: The URL of the public source code repository. example: https://www.github.com/transifex/ format: uri type: string slug: description: The slug of the Project. example: project_slug maxLength: 255 pattern: ^[a-zA-Z0-9_-]+$ type: string tags: description: List of tags for the Project. example: - core - casual items: type: string type: array translation_memory_fillup: default: false description: 'If the Resources of the Project will be filled-up from the common Translation Memory. ' example: false type: boolean type: description: The type of the Project. enum: - live - file type: string required: - slug - name - private type: object relationships: additionalProperties: false description: Resource parent relationships. properties: organization: additionalProperties: false description: The `organization` resource the project should belong to. properties: data: additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object required: - data type: object source_language: additionalProperties: false description: The `language` resource the project is translated from. properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object required: - data type: object team: additionalProperties: false description: The `team` resource the project should belong to. properties: data: description: Team data container. properties: id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - teams type: string required: - type - id type: object required: - data type: object required: - organization - source_language type: object type: enum: - projects type: string required: - type - attributes - relationships type: object required: - data type: object required: true responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false description: Project attributes. properties: ai_fillup: default: false description: 'If the Resources of the Project will be filled-up from Transifex AI. ' example: false type: boolean archived: description: 'If the project is archived or not. If a project is archived the pricing will be lower but no action will be available. ' example: false type: boolean datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string description: description: A description of the Project. example: The localization effort for Transifex core project maxLength: 255 type: string homepage_url: description: The homepage of the Project. example: https://www.transifex.com format: uri type: string instructions_url: description: 'A web page containing documentation or instructions for translators, or localization tips for your community. ' example: https://www.transifex.com/localization-tips format: uri type: string license: description: The license of the Project. enum: - proprietary - open_source - permissive_open_source - other_open_source type: string logo_url: description: The URL of the project's logo. example: https://www.logos.com/project_logo.svg format: uri type: string long_description: description: A long description of the Project. example: 'The localization effort for Transifex core project. Everyone is welcomed to contribute ' maxLength: 1000 type: string machine_translation_fillup: default: false description: 'If the Resources of the Project will be filled-up from a Machine Translation. ' example: false type: boolean name: description: The name of the Project. example: Transifex core maxLength: 255 type: string private: description: 'If the project is private or not. A private project is visible only by you and your team. ' example: false type: boolean repository_url: description: The URL of the public source code repository. example: https://www.github.com/transifex/ format: uri type: string slug: description: The slug of the Project. example: project_slug maxLength: 255 pattern: ^[a-zA-Z0-9_-]+$ type: string tags: description: List of tags for the Project. example: - core - casual items: type: string type: array translation_memory_fillup: default: false description: 'If the Resources of the Project will be filled-up from the common Translation Memory. ' example: false type: boolean type: description: The type of the Project. enum: - live - file type: string required: - slug - name - type - tags - description - long_description - private - archived - translation_memory_fillup - machine_translation_fillup - homepage_url - repository_url - instructions_url - license - datetime_created - datetime_modified - logo_url type: object id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false description: Project self link. properties: self: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - self type: object relationships: additionalProperties: false description: Project relationships. properties: languages: additionalProperties: false properties: links: additionalProperties: false description: Project languages links. properties: related: description: Project language details link. example: /projects/o:organization_slug:p:project_slug/languages type: string self: description: Project language relationship link. example: /projects/o:organization_slug:p:project_slug/relationships/languages type: string required: - related - self type: object required: - links type: object maintainers: additionalProperties: false properties: links: additionalProperties: false description: Project maintainers links. properties: related: description: Project maintainers details link. example: /projects/o:organization_slug:p:project_slug/maintainers type: string self: description: Project maintainers relationship link. example: /projects/o:organization_slug:p:project_slug/relationships/maintainers type: string required: - self - related type: object required: - links type: object organization: additionalProperties: false properties: data: additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object links: additionalProperties: false properties: related: description: Organization details link. example: /organizations/o:organization_slug type: string required: - related type: object required: - links - data type: object resources: additionalProperties: false properties: links: additionalProperties: false description: Project resources links. properties: related: description: Project resources details link. example: /resources?filter[project]:XXX type: string required: - related type: object required: - links type: object source_language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object team: additionalProperties: false properties: data: description: Team data container. properties: id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - teams type: string required: - type - id type: object links: additionalProperties: false properties: related: example: /teams/o:organization_slug:t:team_slug type: string self: example: /projects/o:organization_slug:t:team_slug/relationships/team type: string required: - self - related type: object required: - links - data type: object required: - source_language - organization - team - languages - maintainers - resources type: object type: enum: - projects type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful Response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '402': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: payment_required type: string detail: example: 'Your plan doesn''t cover the requested feature, please upgrade ' type: string status: example: '402' type: string title: example: Payment required type: string type: object type: array type: object description: Payment required '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict summary: Create a Project tags: - Projects x-released: true /projects/{project_id}: delete: description: Delete a project. responses: '204': description: No Content '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Delete Project tags: - Projects x-released: true get: description: Get the details of a specific project. responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false description: Project attributes. properties: ai_fillup: default: false description: 'If the Resources of the Project will be filled-up from Transifex AI. ' example: false type: boolean archived: description: 'If the project is archived or not. If a project is archived the pricing will be lower but no action will be available. ' example: false type: boolean datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string description: description: A description of the Project. example: The localization effort for Transifex core project maxLength: 255 type: string homepage_url: description: The homepage of the Project. example: https://www.transifex.com format: uri type: string instructions_url: description: 'A web page containing documentation or instructions for translators, or localization tips for your community. ' example: https://www.transifex.com/localization-tips format: uri type: string license: description: The license of the Project. enum: - proprietary - open_source - permissive_open_source - other_open_source type: string logo_url: description: The URL of the project's logo. example: https://www.logos.com/project_logo.svg format: uri type: string long_description: description: A long description of the Project. example: 'The localization effort for Transifex core project. Everyone is welcomed to contribute ' maxLength: 1000 type: string machine_translation_fillup: default: false description: 'If the Resources of the Project will be filled-up from a Machine Translation. ' example: false type: boolean name: description: The name of the Project. example: Transifex core maxLength: 255 type: string private: description: 'If the project is private or not. A private project is visible only by you and your team. ' example: false type: boolean repository_url: description: The URL of the public source code repository. example: https://www.github.com/transifex/ format: uri type: string slug: description: The slug of the Project. example: project_slug maxLength: 255 pattern: ^[a-zA-Z0-9_-]+$ type: string tags: description: List of tags for the Project. example: - core - casual items: type: string type: array translation_memory_fillup: default: false description: 'If the Resources of the Project will be filled-up from the common Translation Memory. ' example: false type: boolean type: description: The type of the Project. enum: - live - file type: string required: - slug - name - type - tags - description - long_description - private - archived - translation_memory_fillup - machine_translation_fillup - homepage_url - repository_url - instructions_url - license - datetime_created - datetime_modified - logo_url type: object id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false description: Project self link. properties: self: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - self type: object relationships: additionalProperties: false description: Project relationships. properties: languages: additionalProperties: false properties: links: additionalProperties: false description: Project languages links. properties: related: description: Project language details link. example: /projects/o:organization_slug:p:project_slug/languages type: string self: description: Project language relationship link. example: /projects/o:organization_slug:p:project_slug/relationships/languages type: string required: - related - self type: object required: - links type: object maintainers: additionalProperties: false properties: links: additionalProperties: false description: Project maintainers links. properties: related: description: Project maintainers details link. example: /projects/o:organization_slug:p:project_slug/maintainers type: string self: description: Project maintainers relationship link. example: /projects/o:organization_slug:p:project_slug/relationships/maintainers type: string required: - self - related type: object required: - links type: object organization: additionalProperties: false properties: data: additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object links: additionalProperties: false properties: related: description: Organization details link. example: /organizations/o:organization_slug type: string required: - related type: object required: - links - data type: object resources: additionalProperties: false properties: links: additionalProperties: false description: Project resources links. properties: related: description: Project resources details link. example: /resources?filter[project]:XXX type: string required: - related type: object required: - links type: object source_language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object team: additionalProperties: false properties: data: description: Team data container. properties: id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - teams type: string required: - type - id type: object links: additionalProperties: false properties: related: example: /teams/o:organization_slug:t:team_slug type: string self: example: /projects/o:organization_slug:t:team_slug/relationships/team type: string required: - self - related type: object required: - links - data type: object required: - source_language - organization - team - languages - maintainers - resources type: object type: enum: - projects type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful Response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get project details tags: - Projects x-released: true parameters: - description: Format of composite id should be `o:organization_slug:p:project_slug`. in: path name: project_id required: true schema: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string patch: requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Update project body request details. minProperties: 3 properties: attributes: additionalProperties: false minProperties: 1 properties: ai_fillup: default: false description: 'If the Resources of the Project will be filled-up from Transifex AI. ' example: false type: boolean archived: description: 'If the project is archived or not. If a project is archived the pricing will be lower but no action will be available. ' example: false type: boolean description: description: A description of the Project. example: The localization effort for Transifex core project maxLength: 255 type: string homepage_url: description: The homepage of the Project. example: https://www.transifex.com format: uri type: string instructions_url: description: 'A web page containing documentation or instructions for translators, or localization tips for your community. ' example: https://www.transifex.com/localization-tips format: uri type: string license: description: The license of the Project. enum: - proprietary - open_source - permissive_open_source - other_open_source type: string long_description: description: A long description of the Project. example: 'The localization effort for Transifex core project. Everyone is welcomed to contribute ' maxLength: 1000 type: string machine_translation_fillup: default: false description: 'If the Resources of the Project will be filled-up from a Machine Translation. ' example: false type: boolean name: description: The name of the Project. example: Transifex core maxLength: 255 type: string private: description: 'If the project is private or not. A private project is visible only by you and your team. ' example: false type: boolean repository_url: description: The URL of the public source code repository. example: https://www.github.com/transifex/ format: uri type: string tags: description: List of tags for the Project. example: - core - casual items: type: string type: array translation_memory_fillup: default: false description: 'If the Resources of the Project will be filled-up from the common Translation Memory. ' example: false type: boolean type: object id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string relationships: additionalProperties: false properties: team: additionalProperties: false properties: data: description: Team data container. properties: id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - teams type: string required: - type - id type: object required: - data type: object required: - team type: object type: enum: - projects type: string required: - id - type type: object required: - data type: object required: true responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: description: List of resource string comment objects. items: additionalProperties: false properties: attributes: additionalProperties: false description: Project attributes. properties: ai_fillup: default: false description: 'If the Resources of the Project will be filled-up from Transifex AI. ' example: false type: boolean archived: description: 'If the project is archived or not. If a project is archived the pricing will be lower but no action will be available. ' example: false type: boolean datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string description: description: A description of the Project. example: The localization effort for Transifex core project maxLength: 255 type: string homepage_url: description: The homepage of the Project. example: https://www.transifex.com format: uri type: string instructions_url: description: 'A web page containing documentation or instructions for translators, or localization tips for your community. ' example: https://www.transifex.com/localization-tips format: uri type: string license: description: The license of the Project. enum: - proprietary - open_source - permissive_open_source - other_open_source type: string logo_url: description: The URL of the project's logo. example: https://www.logos.com/project_logo.svg format: uri type: string long_description: description: A long description of the Project. example: 'The localization effort for Transifex core project. Everyone is welcomed to contribute ' maxLength: 1000 type: string machine_translation_fillup: default: false description: 'If the Resources of the Project will be filled-up from a Machine Translation. ' example: false type: boolean name: description: The name of the Project. example: Transifex core maxLength: 255 type: string private: description: 'If the project is private or not. A private project is visible only by you and your team. ' example: false type: boolean repository_url: description: The URL of the public source code repository. example: https://www.github.com/transifex/ format: uri type: string slug: description: The slug of the Project. example: project_slug maxLength: 255 pattern: ^[a-zA-Z0-9_-]+$ type: string tags: description: List of tags for the Project. example: - core - casual items: type: string type: array translation_memory_fillup: default: false description: 'If the Resources of the Project will be filled-up from the common Translation Memory. ' example: false type: boolean type: description: The type of the Project. enum: - live - file type: string required: - slug - name - type - tags - description - long_description - private - archived - translation_memory_fillup - machine_translation_fillup - homepage_url - repository_url - instructions_url - license - datetime_created - datetime_modified - logo_url type: object id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false description: Project self link. properties: self: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - self type: object relationships: additionalProperties: false description: Project relationships. properties: languages: additionalProperties: false properties: links: additionalProperties: false description: Project languages links. properties: related: description: Project language details link. example: /projects/o:organization_slug:p:project_slug/languages type: string self: description: Project language relationship link. example: /projects/o:organization_slug:p:project_slug/relationships/languages type: string required: - related - self type: object required: - links type: object maintainers: additionalProperties: false properties: links: additionalProperties: false description: Project maintainers links. properties: related: description: Project maintainers details link. example: /projects/o:organization_slug:p:project_slug/maintainers type: string self: description: Project maintainers relationship link. example: /projects/o:organization_slug:p:project_slug/relationships/maintainers type: string required: - self - related type: object required: - links type: object organization: additionalProperties: false properties: data: additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object links: additionalProperties: false properties: related: description: Organization details link. example: /organizations/o:organization_slug type: string required: - related type: object required: - links - data type: object resources: additionalProperties: false properties: links: additionalProperties: false description: Project resources links. properties: related: description: Project resources details link. example: /resources?filter[project]:XXX type: string required: - related type: object required: - links type: object source_language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object team: additionalProperties: false properties: data: description: Team data container. properties: id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - teams type: string required: - type - id type: object links: additionalProperties: false properties: related: example: /teams/o:organization_slug:t:team_slug type: string self: example: /projects/o:organization_slug:t:team_slug/relationships/team type: string required: - self - related type: object required: - links - data type: object required: - source_language - organization - team - languages - maintainers - resources type: object type: enum: - projects type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '402': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: payment_required type: string detail: example: 'Your plan doesn''t cover the requested feature, please upgrade ' type: string status: example: '402' type: string title: example: Payment required type: string type: object type: array type: object description: Payment required '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Update a Project tags: - Projects x-released: true summary: Project details /projects/{project_id}/languages: get: description: Get a list of all target languages of a specific project. responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: additionalProperties: false properties: attributes: additionalProperties: false description: Language attributes. properties: code: description: The language code as defined in CLDR. example: en type: string name: description: The name of the Language as defined in CLDR. example: English type: string plural_equation: description: The language plural rule equation as defined in CLDR. example: (n != 1) type: string plural_rules: description: Object of plural rules for Language as defined in CLDR. items: type: string type: object rtl: description: If the language is rlt. example: false type: boolean required: - code - name - rtl - plural_rules - plural_equation type: object id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string links: additionalProperties: false description: Language links. properties: self: description: Language details link. example: /languages/l:en_US type: string required: - self type: object type: enum: - languages type: string required: - type - id - attributes - links type: object type: array links: additionalProperties: false description: Project languages links. properties: self: description: Project language details link. example: /projects/o:organization_slug:p:project_slug/languages type: string required: - self type: object required: - data type: object description: List of target languages for a specific Project. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: List project languages tags: - Projects x-released: true parameters: - description: Format of composite id should be `o:organization_slug:p:project_slug`. in: path name: project_id required: true schema: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string summary: List project languages /projects/{project_id}/maintainers: description: Project maintainers. get: description: Get the maintainers of a project. responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: allOf: - description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object - properties: attributes: additionalProperties: false description: User attributes. properties: username: description: The username. example: user_1 type: string required: - username type: object links: additionalProperties: false description: User links. properties: self: description: User details link. example: /users/u:user_1 type: string required: - self type: object required: - attributes - links type: object type: array links: additionalProperties: false properties: next: example: /projects/o:organization_slug/maintainers?page[cursor]=XXX nullable: true type: string previous: example: /projects/o:organization_slug/maintainers?page[cursor]=XXX nullable: true type: string self: example: /projects/o:organization_slug/maintainers type: string required: - self - previous - next type: object required: - data - links type: object description: Successful Response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Get project maintainers tags: - Projects x-released: true parameters: - description: Format of composite id should be `o:organization_slug:p:project_slug`. in: path name: project_id required: true schema: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string summary: Get project maintainers /projects/{project_id}/relationships/languages: delete: description: Remove target language from a project. requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: additionalProperties: false properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object type: array required: - data type: object required: true responses: '204': description: No Content '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Delete language relationship tags: - Projects x-released: true get: parameters: - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: additionalProperties: false properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object type: array links: additionalProperties: false description: Project Languages links. properties: self: description: Project language relationships link. example: /projects/o:organization_slug:p:project_slug/relationships/languages type: string required: - self type: object required: - data - links type: object description: List of target language relationships of the project. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: List language relationships tags: - Projects x-released: true parameters: - description: Format of composite id should be `o:organization_slug:p:project_slug`. in: path name: project_id required: true schema: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string patch: description: 'Completely replace the target language of a specific project. _**Warning**: This is a highly destructive operation._ ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: additionalProperties: false description: Update project body request details. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object type: array required: - data type: object required: true responses: '204': description: No Content. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Update language relationships tags: - Projects x-released: true post: description: Add target language to the project. requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: additionalProperties: false properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object type: array required: - data type: object required: true responses: '204': description: No Content. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Create language relationship tags: - Projects x-released: true summary: Edit project-language relationships /projects/{project_id}/relationships/maintainers: delete: description: Remove maintainers from project. requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object type: array required: - data type: object required: true responses: '204': description: No content. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Remove maintainers from project tags: - Projects x-released: true description: Update project maintainers. get: description: Get project maintainer relationships. parameters: - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object type: array links: additionalProperties: false properties: next: example: /projects/o:organization_slug/relationships/maintainers?page[cursor]=XXX nullable: true type: string previous: example: /projects/o:organization_slug/relationships/maintainers?page[cursor]=XXX nullable: true type: string self: example: /projects/o:organization_slug/relationships/maintainers type: string required: - self - previous - next type: object required: - data - links type: object description: Successful Response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '402': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: payment_required type: string detail: example: 'Your plan doesn''t cover the requested feature, please upgrade ' type: string status: example: '402' type: string title: example: Payment required type: string type: object type: array type: object description: Payment required '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Get project maintainer relationships tags: - Projects x-released: true parameters: - description: Format of composite id should be `o:organization_slug:p:project_slug`. in: path name: project_id required: true schema: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string patch: description: 'Completely replace project maintainers. _**Warning**: This is a highly destructive operation._ ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object type: array required: - data type: object required: true responses: '204': description: No content. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Update project maintainers tags: - Projects x-released: true post: description: Add maintainers to project. requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object type: array required: - data type: object required: true responses: '204': description: No content. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '402': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: payment_required type: string detail: example: 'Your plan doesn''t cover the requested feature, please upgrade ' type: string status: example: '402' type: string title: example: Payment required type: string type: object type: array type: object description: Payment required '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Add maintainers to project tags: - Projects x-released: true summary: Edit project maintainers /projects/{project_id}/relationships/team: get: responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: description: Team data container. properties: id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - teams type: string required: - type - id type: object links: additionalProperties: false properties: related: example: /teams/o:organization_slug:t:team_slug type: string self: example: /projects/o:organization_slug:t:team_slug/relationships/team type: string required: - self - related type: object required: - data - links type: object description: Team relationship details. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Get team relationship tags: - Projects x-released: true parameters: - description: Format of composite id should be `o:organization_slug:p:project_slug`. in: path name: project_id required: true schema: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string patch: description: Update team relationship to set a new team to the project. requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - teams type: string required: - type - id type: object required: - data type: object required: true responses: '204': description: No Content. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Update team relationship tags: - Projects x-released: true summary: Update team relationship /resource_activity_reports_async_downloads: post: description: 'The response represents the resource activity report download job. Check the job''s status and download the file itself once that is completed. ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: 'Create resource activity report download body request details. ' properties: attributes: additionalProperties: false properties: date_from: description: Date, will be treated as UTC by the API example: XXXX-XX-XX format: date type: string date_to: description: Date, will be treated as UTC by the API example: XXXX-XX-XX format: date type: string first_time_edits: default: false description: Option to include first time edited/reviewed words. example: false type: boolean required: - date_from type: object relationships: additionalProperties: false properties: language: additionalProperties: false description: 'Only fetch translation activity for this language ' properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object required: - data type: object resource: additionalProperties: false description: 'The `resource` whose translation activity you want to make a report for. ' properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object required: - data type: object user: additionalProperties: false description: 'Only fetch translation activity for this user ' properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object required: - data type: object required: - resource type: object type: enum: - resource_activity_reports_async_downloads type: string required: - type - attributes - relationships type: object required: - data type: object required: true responses: '202': content: application/vnd.api+json: schema: additionalProperties: false properties: data: allOf: - properties: attributes: additionalProperties: false properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string errors: items: properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending type: string required: - status - errors - datetime_created - datetime_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string required: - id - attributes type: object - properties: links: additionalProperties: false properties: self: example: /resource_activity_reports_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: properties: language: properties: data: allOf: - additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: allOf: - additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object type: object resource: properties: data: allOf: - additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: allOf: - additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object type: object user: properties: data: allOf: - description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: allOf: - additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object type: object required: - resource type: object type: enum: - resource_activity_reports_async_downloads type: string required: - type - links - relationships type: object required: - data type: object description: Accepted. headers: Content-Location: description: The location of the resource activity report download. schema: example: /resource_activity_reports_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Create a resource activity report file download action tags: - Activity Reports x-released: true summary: Create a resource activity report file download action /resource_activity_reports_async_downloads/{resource_activity_reports_async_download_id}: get: description: "With this endpoint, you can inquire about the status of an resource\n\ activity report download job.\n\n- If the value of the 'status' attribute\ \ is 'pending' or 'processing', you\n should check this endpoint again later.\n\ - If the 'status' is 'failed', the report has failed to be compiled.\n- In\ \ case the upload job has been successful, you will receive a \"303 - See\n\ \ Other\" response and you can follow its `Location` to\n [download the\ \ file](#tag/File-Downloads/paths/get) that have been\n extracted from your\ \ file.\n" parameters: - description: 'Format of the resource_activity_reports_async_download_id should be a UUID. ' in: path name: resource_activity_reports_async_download_id required: true schema: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: allOf: - properties: attributes: additionalProperties: false properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string errors: items: properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending type: string required: - status - errors - datetime_created - datetime_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string required: - id - attributes type: object - properties: links: additionalProperties: false properties: self: example: /resource_activity_reports_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: properties: language: properties: data: allOf: - additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: allOf: - additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object type: object resource: properties: data: allOf: - additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: allOf: - additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object type: object user: properties: data: allOf: - description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: allOf: - additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object type: object required: - resource type: object type: enum: - resource_activity_reports_async_downloads type: string required: - type - links - relationships type: object required: - data type: object description: Successful response. '303': content: application/vnd.api+json: schema: {} description: See other headers: Location: description: The location of the file. required: true schema: example: https://storage.svc.transifex.net/files/663a7a83-cb15-4c72-a37d-125dfb8432a6-file?auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZXMiOiJkb3dubG9hZCIsIm1ldGFkYXRhIjpudWxsLCJmaWxlX2lkcyI6IjY2M2E3YTgzLWNiMTUtNGM3Mi1hMzdkLTEyNWRmYjg0MzJhNi1maWxlIiwiZXhwIjoxNTg0NzE3NTkzLCJwcm92aWRlciI6InR4YyJ9.IHgLS4gtL0A6YZd-2zKkrg__geitcvs9DV8LcE8-1io type: string '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Get resource activity report download status tags: - Activity Reports x-released: true summary: Get resource activity report download status /resource_async_merges: post: description: 'Merge git based branch ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Create resource merge. properties: attributes: additionalProperties: false description: Resource strings async download attributes properties: callback_url: default: null description: 'The url that will be called when the processing is completed. For more details about callback_url you can refer to [Asynchronous Processing](#section/Asynchronous-Processing) section ' format: uri nullable: true type: string conflict_resolution: description: Conflict resolution option. enum: - USE_HEAD - USE_BASE example: USE_HEAD type: string force: default: false example: false type: boolean required: - conflict_resolution relationships: additionalProperties: false properties: resource: additionalProperties: false description: The resource that will be merged to its parent. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object required: - data type: object required: - resource type: object type: enum: - resource_async_merges type: string required: - type - attributes - relationships type: object required: - data type: object required: true responses: '202': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: conflict_resolution: enum: - USE_HEAD - USE_BASE example: USE_HEAD type: string date_completed: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string date_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string status: enum: - CREATED - CHANGES_CREATED - COMPLETED - HEAD_DELETED example: CREATED type: string required: - status - conflict_resolution - date_created - date_completed type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /resource_strings_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: base: additionalProperties: false properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object required: - data type: object head: additionalProperties: false properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object required: - data type: object required: - base - head type: object type: enum: - resource_async_merges type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Accepted. headers: Content-Location: description: The location of the merge resource job. required: true schema: type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Create new resources merge tags: - Resources /resource_async_merges_{resource_async_merge_id}: get: description: "With this endpoint, you can inquire about the status of a resource\ \ merge job.\n\n- If the value of the 'status' attribute is 'pending' or 'processing',\ \ you\n should check this endpoint again later.\n- If the 'status' is 'failed',\ \ the merge has failed to complete.\n- In case the upload job has been successful,\ \ you will receive a \"200\"\n" responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: conflict_resolution: enum: - USE_HEAD - USE_BASE example: USE_HEAD type: string date_completed: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string date_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string status: enum: - CREATED - CHANGES_CREATED - COMPLETED - HEAD_DELETED example: CREATED type: string required: - status - conflict_resolution - date_created - date_completed type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /resource_strings_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: base: additionalProperties: false properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object required: - data type: object head: additionalProperties: false properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object required: - data type: object required: - base - head type: object type: enum: - resource_async_merges type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful response. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get resource merge status tags: - Resources parameters: - description: Format of the resource_async_merge_id should be a UUID. in: path name: resource_async_merge_id required: true schema: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string /resource_language_stats: get: description: 'Get the statistics for a set of resources. You must specify at least a project and optionally a language / resource to filter against. ' parameters: - description: Filter results by a project in: query name: filter[project] required: true schema: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string - description: Filter results by a resource in: query name: filter[resource] required: false schema: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string - description: Filter results by a language in: query name: filter[language] required: false schema: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string responses: '200': content: application/vnd.api+json: schema: properties: data: items: allOf: - description: ResourceLanguageStats data container properties: id: description: Resource language stats identifier example: o:organization_slug:p:project_slug:r:resource_slug:l:language_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:l:[a-zA-Z0-9@_-]+$ type: string type: enum: - resource_language_stats type: string required: - type - id type: object - properties: attributes: allOf: - additionalProperties: false properties: last_proofread_update: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string last_review_update: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string last_translation_update: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string last_update: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string proofread_strings: example: 10 type: number proofread_words: example: 10 type: number reviewed_strings: example: 10 type: number reviewed_words: example: 10 type: number total_strings: example: 10 type: number total_words: example: 10 type: number translated_strings: example: 10 type: number translated_words: example: 10 type: number untranslated_strings: example: 10 type: number untranslated_words: example: 10 type: number required: - untranslated_words - translated_words - reviewed_words - proofread_words - total_words - untranslated_strings - translated_strings - reviewed_strings - proofread_strings - total_strings - last_update - last_translation_update - last_review_update - last_proofread_update type: object links: additionalProperties: false properties: self: example: /resource_stats/o:organization_slug:p:project_slug:r:resource_slug:l:language_code type: string required: - self type: object relationships: additionalProperties: false properties: language: additionalProperties: false properties: data: allOf: - additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: allOf: - additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object type: object resource: additionalProperties: false properties: data: allOf: - additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: allOf: - additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object type: object required: - resource - language type: object type: object type: array links: properties: last: example: /resource_language_stats/o:organization_slug:p:project_slug:r:resource_slug:l:language_code&page[cursor]=XXX type: string next: example: /resource_language_stats/o:organization_slug:p:project_slug:r:resource_slug:l:language_code&page[cursor]=XXX type: string self: example: /resource_language_stats/o:organization_slug:p:project_slug:r:resource_slug:l:language_code type: string type: object type: object description: Success '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get resource language stats collection tags: - Statistics x-released: true summary: Get resource language stats collection /resource_language_stats/{resource_language_stats_id}: get: description: Get information for a specific supported language. parameters: - description: '' example: o:organization_slug:p:project_slug:r:resource_slug:l:language_code in: path name: resource_language_stats_id required: true schema: type: string responses: '200': content: application/vnd.api+json: schema: properties: data: allOf: - description: ResourceLanguageStats data container properties: id: description: Resource language stats identifier example: o:organization_slug:p:project_slug:r:resource_slug:l:language_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:l:[a-zA-Z0-9@_-]+$ type: string type: enum: - resource_language_stats type: string required: - type - id type: object - properties: attributes: allOf: - additionalProperties: false properties: last_proofread_update: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string last_review_update: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string last_translation_update: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string last_update: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string proofread_strings: example: 10 type: number proofread_words: example: 10 type: number reviewed_strings: example: 10 type: number reviewed_words: example: 10 type: number total_strings: example: 10 type: number total_words: example: 10 type: number translated_strings: example: 10 type: number translated_words: example: 10 type: number untranslated_strings: example: 10 type: number untranslated_words: example: 10 type: number required: - untranslated_words - translated_words - reviewed_words - proofread_words - total_words - untranslated_strings - translated_strings - reviewed_strings - proofread_strings - total_strings - last_update - last_translation_update - last_review_update - last_proofread_update type: object links: additionalProperties: false properties: self: example: /resource_stats/o:organization_slug:p:project_slug:r:resource_slug:l:language_code type: string required: - self type: object relationships: additionalProperties: false properties: language: additionalProperties: false properties: data: allOf: - additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: allOf: - additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object type: object resource: additionalProperties: false properties: data: allOf: - additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: allOf: - additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object type: object required: - resource - language type: object type: object type: object description: Successful Response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get resource language stats tags: - Statistics x-released: true summary: Get resource language stats /resource_metadata: {} /resource_metadata/{resource_metadata_id}: parameters: - description: Format of composite id should be `o:organization_slug:p:project_slug:r:resource_slug:ns:namespace:n:name`. in: path name: resource_metadata_id required: true schema: description: Resource metadata identifier. example: o:organization_slug:p:project_slug:r:resource_slug:ns:namespace:n:name pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:ns:[a-zA-Z0-9_-]+:n:[a-zA-Z0-9_-]+$ type: string /resource_string_comments: get: description: Get a list of all resource string comments for an organization. You can further narrow down the list using the available filters. parameters: - description: Filter results by an organization in: query name: filter[organization] required: true schema: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string - description: Filter results by a project in: query name: filter[project] required: false schema: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string - in: query name: filter[category] required: false schema: example: frontpage type: string - in: query name: filter[author] required: false schema: example: u:username pattern: u:[^:]+ type: string - in: query name: filter[datetime_created][gte] required: false schema: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string - in: query name: filter[datetime_created][lt] required: false schema: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string - in: query name: filter[priority] required: false schema: enum: - low - normal - high - critical - blocker example: critical type: string - in: query name: filter[resource] required: false schema: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string - in: query name: filter[resource_string] required: false schema: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string - in: query name: filter[status] required: false schema: enum: - open - resolved example: open type: string - in: query name: filter[type] required: false schema: enum: - comment - issue example: issue type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: allOf: - properties: id: example: o:organization_slug:p:project_slug:r:resource_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:c:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}:c:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string type: default: resource_string_comments enum: - resource_string_comments type: string required: - type - id type: object - properties: attributes: allOf: - description: Resource String Comment attributes properties: category: example: frontpage nullable: true type: string message: example: the key is wrong type: string priority: default: normal enum: - low - normal - high - critical - blocker nullable: true type: string status: enum: - open - resolved example: resolved nullable: true type: string type: enum: - comment - issue example: issue type: string required: - category - message - priority - status - type type: object - properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_resolved: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string required: - datetime_created - datetime_resolved - datetime_modified type: object links: additionalProperties: false properties: self: description: Resource String details link example: /resource_string_comments/o:organization_slug:p:project_slug:r:resource_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:c:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string type: object relationships: additionalProperties: false description: Resource String Comment relationships. properties: author: additionalProperties: false properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object type: object language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object type: object resolver: additionalProperties: false nullable: true properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object type: object resource: additionalProperties: false properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object type: object resource_string: additionalProperties: false properties: data: additionalProperties: false description: Resource String data container. properties: id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string type: enum: - resource_strings type: string required: - type - id type: object links: additionalProperties: false description: Resource String related link. properties: related: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - related type: object type: object required: - resource_string - resource - language type: object type: object type: array links: additionalProperties: false description: Pagination links properties: next: description: Link to the next page of results example: /resource_strings_comments?filter[organization]=o:organization_slug&page[cursor]=XXX nullable: true type: string previous: description: Link to the previous page of results example: /resource_strings_comments?filter[organization]=o:organization_slug&page[cursor]=XXX nullable: true type: string self: description: Link to the current page of results example: /resource_strings_comments?filter[organization]=o:organization_slug&page[cursor]=XXX type: string type: object required: - data - links type: object description: List of resource string comments ordered by creation date in descending order '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: List resource string comments tags: - Resource String Comments x-released: true post: description: Create a new resource string comment. This needs to be associated with a resource string and a target language. requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Create resource body request details properties: attributes: additionalProperties: false description: Resource String Comment attributes properties: category: example: frontpage nullable: true type: string message: example: the key is wrong type: string priority: default: normal enum: - low - normal - high - critical - blocker nullable: true type: string type: enum: - comment - issue example: issue type: string required: - message - type type: object relationships: additionalProperties: false description: Resource String parent relationships properties: language: additionalProperties: false description: The `language` this comment refers to properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object required: - data type: object resource_string: additionalProperties: false description: The `resource string` this comment refers to properties: data: additionalProperties: false description: Resource String data container. properties: id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string type: enum: - resource_strings type: string required: - type - id type: object required: - data type: object required: - language - resource_string type: object type: enum: - resource_string_comments type: string required: - type - attributes - relationships type: object required: - data type: object required: true responses: '201': content: application/vnd.api+json: schema: additionalProperties: false properties: data: allOf: - properties: id: example: o:organization_slug:p:project_slug:r:resource_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:c:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}:c:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string type: default: resource_string_comments enum: - resource_string_comments type: string required: - type - id type: object - properties: attributes: allOf: - description: Resource String Comment attributes properties: category: example: frontpage nullable: true type: string message: example: the key is wrong type: string priority: default: normal enum: - low - normal - high - critical - blocker nullable: true type: string status: enum: - open - resolved example: resolved nullable: true type: string type: enum: - comment - issue example: issue type: string required: - category - message - priority - status - type type: object - properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_resolved: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string required: - datetime_created - datetime_resolved - datetime_modified type: object links: additionalProperties: false properties: self: description: Resource String details link example: /resource_string_comments/o:organization_slug:p:project_slug:r:resource_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:c:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string type: object relationships: additionalProperties: false description: Resource String Comment relationships. properties: author: additionalProperties: false properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object type: object language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object type: object resolver: additionalProperties: false nullable: true properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object type: object resource: additionalProperties: false properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object type: object resource_string: additionalProperties: false properties: data: additionalProperties: false description: Resource String data container. properties: id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string type: enum: - resource_strings type: string required: - type - id type: object links: additionalProperties: false description: Resource String related link. properties: related: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - related type: object type: object required: - resource_string - resource - language type: object type: object type: object description: Created headers: Location: schema: example: /resource_string_comments/o:organization_slug:p:project_slug:r:resource_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:c:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Create resource string comments tags: - Resource String Comments x-released: true /resource_string_comments/{comment_id}: delete: description: Delete a resource string comment parameters: - description: Format of the command_id should be a `o:organization_slug:p:project_slug:r:resource_slug:s:string_hash:c:comment_hash`. in: path name: comment_id required: true schema: example: o:organization_slug:p:project_slug:r:resource_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:c:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}:c:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string responses: '204': description: No Content '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Delete resource string comment tags: - Resource String Comments x-released: true get: description: Get details for a comment related to a specific resource string parameters: - description: Format of the command_id should be a `o:organization_slug:p:project_slug:r:resource_slug:s:string_hash:c:comment_hash`. in: path name: comment_id required: true schema: example: o:organization_slug:p:project_slug:r:resource_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:c:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}:c:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: allOf: - properties: id: example: o:organization_slug:p:project_slug:r:resource_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:c:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}:c:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string type: default: resource_string_comments enum: - resource_string_comments type: string required: - type - id type: object - properties: attributes: allOf: - description: Resource String Comment attributes properties: category: example: frontpage nullable: true type: string message: example: the key is wrong type: string priority: default: normal enum: - low - normal - high - critical - blocker nullable: true type: string status: enum: - open - resolved example: resolved nullable: true type: string type: enum: - comment - issue example: issue type: string required: - category - message - priority - status - type type: object - properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_resolved: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string required: - datetime_created - datetime_resolved - datetime_modified type: object links: additionalProperties: false properties: self: description: Resource String details link example: /resource_string_comments/o:organization_slug:p:project_slug:r:resource_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:c:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string type: object relationships: additionalProperties: false description: Resource String Comment relationships. properties: author: additionalProperties: false properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object type: object language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object type: object resolver: additionalProperties: false nullable: true properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object type: object resource: additionalProperties: false properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object type: object resource_string: additionalProperties: false properties: data: additionalProperties: false description: Resource String data container. properties: id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string type: enum: - resource_strings type: string required: - type - id type: object links: additionalProperties: false description: Resource String related link. properties: related: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - related type: object type: object required: - resource_string - resource - language type: object type: object description: a resource string comment object type: object description: Successful response '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Get resource string comment tags: - Resource String Comments x-released: true patch: description: Change a resource string comment. You can update it's status, change it to an issue or edit the description. parameters: - description: Format of the command_id should be a `o:organization_slug:p:project_slug:r:resource_slug:s:string_hash:c:comment_hash`. in: path name: comment_id required: true schema: example: o:organization_slug:p:project_slug:r:resource_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:c:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}:c:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Update resource body request details properties: attributes: additionalProperties: false description: Resource String Comment mutable attributes minProperties: 1 properties: category: example: frontpage nullable: true type: string message: example: the key is wrong type: string priority: enum: - low - normal - high - critical - blocker nullable: true type: string status: default: open enum: - open - resolved example: resolved nullable: true type: string type: object id: example: o:organization_slug:p:project_slug:r:resource_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:c:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}:c:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string type: default: resource_string_comments enum: - resource_string_comments type: string required: - type - id - attributes type: object required: - data type: object required: true responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: description: List of resource string comment objects items: allOf: - properties: id: example: o:organization_slug:p:project_slug:r:resource_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:c:4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}:c:([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string type: default: resource_string_comments enum: - resource_string_comments type: string required: - type - id type: object - properties: attributes: allOf: - description: Resource String Comment attributes properties: category: example: frontpage nullable: true type: string message: example: the key is wrong type: string priority: default: normal enum: - low - normal - high - critical - blocker nullable: true type: string status: enum: - open - resolved example: resolved nullable: true type: string type: enum: - comment - issue example: issue type: string required: - category - message - priority - status - type type: object - properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_resolved: example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string required: - datetime_created - datetime_resolved - datetime_modified type: object links: additionalProperties: false properties: self: description: Resource String details link example: /resource_string_comments/o:organization_slug:p:project_slug:r:resource_slug:s:4abfc726-6a27-4c33-9d99-e5254c8df748:c:4abfc726-6a27-4c33-9d99-e5254c8df748 type: string type: object relationships: additionalProperties: false description: Resource String Comment relationships. properties: author: additionalProperties: false properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object type: object language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object type: object resolver: additionalProperties: false nullable: true properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object type: object resource: additionalProperties: false properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object type: object resource_string: additionalProperties: false properties: data: additionalProperties: false description: Resource String data container. properties: id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string type: enum: - resource_strings type: string required: - type - id type: object links: additionalProperties: false description: Resource String related link. properties: related: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - related type: object type: object required: - resource_string - resource - language type: object type: object type: object description: Successful response '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Update resource string comment tags: - Resource String Comments x-released: true /resource_strings: delete: description: 'Include a payload with resource identifiers to all resource strings you wish to delete. Resource identifiers are objects with only the `type` and `id` fields. Available only for file-less resources. All deleted resource strings need to belong to the same resource. Bulk deletes do not support partial success, ie either all resource strings will be deleted, or none will. Consult the error response to figure out which resource strings you need to fix or omit and try again. Don''t forget to use the `application/vnd.api+json;profile="bulk"` Content-Type instead of the more common `application/vnd.api+json`. ' requestBody: content: application/vnd.api+json;profile="bulk": schema: additionalProperties: false properties: data: items: additionalProperties: false description: Resource String data container. properties: id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string type: enum: - resource_strings type: string required: - type - id type: object maxItems: 150 minItems: 1 type: array uniqueItems: true required: - data type: object required: true responses: '204': description: No content '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled security: - bearerAuth: [] summary: Bulk-delete resource strings tags: - Resource Strings x-released: true get: parameters: - description: Filter results by a resource in: query name: filter[resource] required: true schema: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string - in: query name: filter[strings_date_modified][gte] required: false schema: oneOf: - example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string - description: Date, will be treated as UTC by the API example: XXXX-XX-XX format: date type: string - in: query name: filter[strings_date_modified][lte] required: false schema: oneOf: - example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string - description: Date, will be treated as UTC by the API example: XXXX-XX-XX format: date type: string - description: Exact match for the key of the resource string. This filter is case sensitive. in: query name: filter[key] required: false schema: example: hello_world minLength: 1 type: string - description: Retrieve source strings that contain all specified query tags. explode: false in: query name: filter[tags][all] required: false schema: items: example: tag1,tag2,tag3 type: string minItems: 1 type: array style: form - description: Retrieve source strings containing any of the query tags. If the filter value is *, all strings with any tag will be returned. However, if you use * along with another tag value, such as *,tag1, only strings with either * or 'tag1' tags will be returned. explode: false in: query name: filter[tags][any] required: false schema: items: example: tag1,tag2,tag3 type: string minItems: 1 type: array style: form - description: "Retrieve translation strings based on specified query tags.\n\ \nTo filter strings, use a combination of tags with the following syntax:\n\ - Use an ampersand ('&') to signify 'AND' functionality, indicating that\ \ all specified\n tags must be present.\n- Use a pipe ('|') to signify\ \ 'OR' functionality, meaning that at least one of\n the specified tags\ \ must be present.\n- Use parentheses '(' to ')' to define the order of\ \ statement execution.\n- To use the above special characters as part of\ \ the query content, escape them with a\n backslash ('\\\\')\n\nWhen combining\ \ AND and OR conditions, the query is evaluated from left to right, following\ \ operator precedence and respecting existing parentheses. Specifically,\ \ the AND operator (&) takes precedence over the OR operator (|).\n\nFor\ \ example, consider the query:\n'tag1&(tag2|tag3)'\n\nThis query is interpreted\ \ as follows:\ntag1 AND (tag2 OR tag3), and it returns strings that have\ \ both \"tag1\" and either \"tag2\" or \"tag3\"\n\nSimilarly, for the query:\n\ 'tag1&tag2|tag3'\n\nThis query is read as follows:\n(tag1 AND tag2) OR tag3,\ \ and it returns strings that have both \"tag1\" and \"tag2\" or have \"\ tag3\"\n" explode: false in: query name: filter[tags][query] required: false schema: example: tag1&tag2|tag3 minLength: 1 type: string style: form - description: The page size limit. If not set, the default value is 150.
If set, the minimum value it can take is 150 and the maximum 1000. in: query name: limit schema: example: 150 nullable: true type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: description: List of resource string objects. items: additionalProperties: false properties: attributes: additionalProperties: false description: Resource String attributes. properties: appearance_order: description: 'The order that the resource string appears in it''s container. In case of files appearance order is extracted automatically, where in other cases this may be missing ' nullable: true type: integer character_limit: description: The maximum translation string character length, excluding variables. Use value 0 to remove the existing character limit. example: 100 maximum: 2147483647 minimum: 0 nullable: true type: integer context: description: 'Additional context added, in order to link the resource string to the environment in which the communication takes place and/or disambiguate resource strings with the same content. Context can be multiple substrings, concatenated with some separator. ' example: frontpage,footer,verb type: string datetime_created: description: The date the resource string was created. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string developer_comment: description: 'Developer comment gives additional information about the usage of this string and/or technical details relevant to this string. ' example: Wrapped in a 30px width div nullable: true type: string instructions: description: Additional translation instructions. Usually provided if the `developer_comment` is not present or not sufficiently clear. The maximum length should be up to 1000 characters. example: Please use causal language for translations. maxLength: 1000 nullable: true type: string key: description: 'The identifier of the resource string in it''s container. In cases where two resource strings in the same container share the same key, `context` is also used to disambiguate the identity of each resource string. ' example: hello_world type: string metadata_datetime_modified: description: The date the resource string's metadata were last updated. Examples of such attributes are `tags` and `character limit`. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string occurrences: description: The occurrences of the resource string in the source code. example: /my_project/templates/frontpage/hello.html:30 nullable: true type: string pluralized: description: If the resource string is pluralized or not. type: boolean string_hash: description: The hash of the resource string. This is calculated as the hexadecimal digest on the md5 hash of the concatenation of the key and the context. More info [here](https://help.transifex.com/en/articles/6649327-how-string-hashes-are-calculated). example: 2e354ef120752c67afa1b6855aa80c52 type: string strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys should be all the available plural rules for source language, as defined in CLDR, and the values the actual content for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') is required. ' example: one: hello other: world properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object strings_datetime_modified: description: The date the resource string's content was last updated. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string tags: description: List of tags for the resource string. example: - foo - bar items: type: string type: array required: - appearance_order - key - context - strings - tags - occurrences - developer_comment - instructions - character_limit - pluralized - string_hash - datetime_created - metadata_datetime_modified - strings_datetime_modified type: object id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string links: additionalProperties: false description: Resource String link. properties: self: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - self type: object relationships: additionalProperties: false description: Resource String relationships. properties: committer: additionalProperties: false description: User object. properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object language: additionalProperties: false description: Language object. properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object resource: additionalProperties: false description: Resource object. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object required: - language - resource - committer type: object type: enum: - resource_strings type: string required: - type - id - attributes - relationships - links type: object type: array links: additionalProperties: false description: Pagination links. properties: next: description: Resource String collection cursor link. example: /resource_strings?filter[resource]=o:organization_slug:p:project_slug:r:resource_slug&page[cursor]=XXX nullable: true type: string previous: description: Resource String collection cursor link. example: /resource_strings?filter[resource]=o:organization_slug:p:project_slug:r:resource_slug&page[cursor]=XXX nullable: true type: string self: description: Resource String details link. example: /resource_strings?filter[resource]=o:organization_slug:p:project_slug:r:resource_slug type: string required: - self - next - previous type: object required: - links - data type: object description: List of source strings for a given resource. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get resource strings collection tags: - Resource Strings x-released: true patch: requestBody: content: application/vnd.api+json;profile="bulk": schema: additionalProperties: false properties: data: items: additionalProperties: false description: Update resource body request details. properties: attributes: additionalProperties: false minProperties: 1 properties: character_limit: description: The maximum translation string character length, excluding variables. Use value 0 to remove the existing character limit. example: 100 maximum: 2147483647 minimum: 0 nullable: true type: integer instructions: description: Additional translation instructions. Usually provided if the `developer_comment` is not present or not sufficiently clear. The maximum length should be up to 1000 characters. example: Please use causal language for translations. maxLength: 1000 nullable: true type: string strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys should be all the available plural rules for source language, as defined in CLDR, and the values the actual content for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') is required. This field only applies to resources that support the [source string edit](https://help.transifex.com/en/articles/6236820-edit-source-strings-online) functionality. Otherwise, a `400 Bad request` response will be returned. Changing the source string does not remove its translations. ' example: one: hello other: world properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object tags: description: List of tags for the resource string. example: - foo - bar items: type: string type: array type: object id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string type: enum: - resource_strings type: string required: - type - id - attributes type: object maxItems: 150 minItems: 1 type: array uniqueItems: true required: - data type: object required: true responses: '200': content: application/vnd.api+json;profile="bulk": schema: additionalProperties: false properties: data: items: additionalProperties: false properties: attributes: additionalProperties: false description: Resource String attributes. properties: appearance_order: description: 'The order that the resource string appears in it''s container. In case of files appearance order is extracted automatically, where in other cases this may be missing ' nullable: true type: integer character_limit: description: The maximum translation string character length, excluding variables. Use value 0 to remove the existing character limit. example: 100 maximum: 2147483647 minimum: 0 nullable: true type: integer context: description: 'Additional context added, in order to link the resource string to the environment in which the communication takes place and/or disambiguate resource strings with the same content. Context can be multiple substrings, concatenated with some separator. ' example: frontpage,footer,verb type: string datetime_created: description: The date the resource string was created. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string developer_comment: description: 'Developer comment gives additional information about the usage of this string and/or technical details relevant to this string. ' example: Wrapped in a 30px width div nullable: true type: string instructions: description: Additional translation instructions. Usually provided if the `developer_comment` is not present or not sufficiently clear. The maximum length should be up to 1000 characters. example: Please use causal language for translations. maxLength: 1000 nullable: true type: string key: description: 'The identifier of the resource string in it''s container. In cases where two resource strings in the same container share the same key, `context` is also used to disambiguate the identity of each resource string. ' example: hello_world type: string metadata_datetime_modified: description: The date the resource string's metadata were last updated. Examples of such attributes are `tags` and `character limit`. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string occurrences: description: The occurrences of the resource string in the source code. example: /my_project/templates/frontpage/hello.html:30 nullable: true type: string pluralized: description: If the resource string is pluralized or not. type: boolean string_hash: description: The hash of the resource string. This is calculated as the hexadecimal digest on the md5 hash of the concatenation of the key and the context. More info [here](https://help.transifex.com/en/articles/6649327-how-string-hashes-are-calculated). example: 2e354ef120752c67afa1b6855aa80c52 type: string strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys should be all the available plural rules for source language, as defined in CLDR, and the values the actual content for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') is required. ' example: one: hello other: world properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object strings_datetime_modified: description: The date the resource string's content was last updated. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string tags: description: List of tags for the resource string. example: - foo - bar items: type: string type: array required: - appearance_order - key - context - strings - tags - occurrences - developer_comment - instructions - character_limit - pluralized - string_hash - datetime_created - metadata_datetime_modified - strings_datetime_modified type: object id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string links: additionalProperties: false description: Resource String link. properties: self: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - self type: object relationships: additionalProperties: false description: Resource String relationships. properties: committer: additionalProperties: false description: User object. properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object language: additionalProperties: false description: Language object. properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object resource: additionalProperties: false description: Resource object. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object required: - language - resource - committer type: object type: enum: - resource_strings type: string required: - type - id - attributes - relationships - links type: object type: array links: additionalProperties: false properties: profile: enum: - https://github.com/transifex/openapi/txapi_spec/bulk_profile.md type: string required: - profile type: object required: - data - links type: object description: Successful response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Bulk update a resource strings collection tags: - Resource Strings x-released: true post: description: 'Create a new resource string. This path is valid only for file-less resources. ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Create resource string body request details. properties: attributes: additionalProperties: false properties: appearance_order: description: 'The order that the resource string appears in it''s container. In case of files appearance order is extracted automatically, where in other cases this may be missing ' nullable: true type: integer character_limit: description: The maximum translation string character length, excluding variables. Use value 0 to remove the existing character limit. example: 100 maximum: 2147483647 minimum: 0 nullable: true type: integer context: description: 'Additional context added, in order to link the resource string to the environment in which the communication takes place and/or disambiguate resource strings with the same content. Context can be multiple substrings, concatenated with some separator. ' example: frontpage,footer,verb type: string developer_comment: description: 'Developer comment gives additional information about the usage of this string and/or technical details relevant to this string. ' example: Wrapped in a 30px width div nullable: true type: string instructions: description: Additional translation instructions. Usually provided if the `developer_comment` is not present or not sufficiently clear. The maximum length should be up to 1000 characters. example: Please use causal language for translations. maxLength: 1000 nullable: true type: string key: description: 'The identifier of the resource string in it''s container. In cases where two resource strings in the same container share the same key, `context` is also used to disambiguate the identity of each resource string. ' example: hello_world type: string occurrences: description: The occurrences of the resource string in the source code. example: /my_project/templates/frontpage/hello.html:30 nullable: true type: string pluralized: description: If the resource string is pluralized or not. type: boolean strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys should be all the available plural rules for source language, as defined in CLDR, and the values the actual content for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') is required. ' example: one: hello other: world properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object tags: description: List of tags for the resource string. example: - foo - bar items: type: string type: array required: - key - context - strings type: object relationships: additionalProperties: false description: Resource String parent relationships. properties: resource: additionalProperties: false description: The `resource` the created resource string should belong to. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object required: - data type: object required: - resource type: object type: enum: - resource_strings type: string required: - type - attributes - relationships type: object required: - data type: object application/vnd.api+json;profile="bulk": schema: additionalProperties: false properties: data: items: additionalProperties: false description: Create resource string body request details. properties: attributes: additionalProperties: false properties: appearance_order: description: 'The order that the resource string appears in it''s container. In case of files appearance order is extracted automatically, where in other cases this may be missing ' nullable: true type: integer character_limit: description: The maximum translation string character length, excluding variables. Use value 0 to remove the existing character limit. example: 100 maximum: 2147483647 minimum: 0 nullable: true type: integer context: description: 'Additional context added, in order to link the resource string to the environment in which the communication takes place and/or disambiguate resource strings with the same content. Context can be multiple substrings, concatenated with some separator. ' example: frontpage,footer,verb type: string developer_comment: description: 'Developer comment gives additional information about the usage of this string and/or technical details relevant to this string. ' example: Wrapped in a 30px width div nullable: true type: string instructions: description: Additional translation instructions. Usually provided if the `developer_comment` is not present or not sufficiently clear. The maximum length should be up to 1000 characters. example: Please use causal language for translations. maxLength: 1000 nullable: true type: string key: description: 'The identifier of the resource string in it''s container. In cases where two resource strings in the same container share the same key, `context` is also used to disambiguate the identity of each resource string. ' example: hello_world type: string occurrences: description: The occurrences of the resource string in the source code. example: /my_project/templates/frontpage/hello.html:30 nullable: true type: string pluralized: description: If the resource string is pluralized or not. type: boolean strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys should be all the available plural rules for source language, as defined in CLDR, and the values the actual content for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') is required. ' example: one: hello other: world properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object tags: description: List of tags for the resource string. example: - foo - bar items: type: string type: array required: - key - context - strings type: object relationships: additionalProperties: false description: Resource String parent relationships. properties: resource: additionalProperties: false description: The `resource` the created resource string should belong to. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object required: - data type: object required: - resource type: object type: enum: - resource_strings type: string required: - type - attributes - relationships type: object maxItems: 150 minItems: 1 type: array uniqueItems: true required: - data type: object description: 'Use `application/vnd.api+json` to upload single resource strings or `application/vnd.api+json;profile="bulk"` to upload resource strings in bulk. Available only for file-less resources. Bulk requests need to be applied to the same resource, ie all ''resource'' relationships must be identical. Bulk requests do not support partial success, ie either all resource strings will be created, or none will. Consult the error response to figure out which resource strings you need to fix or omit and try again. ' required: true responses: '201': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false description: Resource String attributes. properties: appearance_order: description: 'The order that the resource string appears in it''s container. In case of files appearance order is extracted automatically, where in other cases this may be missing ' nullable: true type: integer character_limit: description: The maximum translation string character length, excluding variables. Use value 0 to remove the existing character limit. example: 100 maximum: 2147483647 minimum: 0 nullable: true type: integer context: description: 'Additional context added, in order to link the resource string to the environment in which the communication takes place and/or disambiguate resource strings with the same content. Context can be multiple substrings, concatenated with some separator. ' example: frontpage,footer,verb type: string datetime_created: description: The date the resource string was created. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string developer_comment: description: 'Developer comment gives additional information about the usage of this string and/or technical details relevant to this string. ' example: Wrapped in a 30px width div nullable: true type: string instructions: description: Additional translation instructions. Usually provided if the `developer_comment` is not present or not sufficiently clear. The maximum length should be up to 1000 characters. example: Please use causal language for translations. maxLength: 1000 nullable: true type: string key: description: 'The identifier of the resource string in it''s container. In cases where two resource strings in the same container share the same key, `context` is also used to disambiguate the identity of each resource string. ' example: hello_world type: string metadata_datetime_modified: description: The date the resource string's metadata were last updated. Examples of such attributes are `tags` and `character limit`. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string occurrences: description: The occurrences of the resource string in the source code. example: /my_project/templates/frontpage/hello.html:30 nullable: true type: string pluralized: description: If the resource string is pluralized or not. type: boolean string_hash: description: The hash of the resource string. This is calculated as the hexadecimal digest on the md5 hash of the concatenation of the key and the context. More info [here](https://help.transifex.com/en/articles/6649327-how-string-hashes-are-calculated). example: 2e354ef120752c67afa1b6855aa80c52 type: string strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys should be all the available plural rules for source language, as defined in CLDR, and the values the actual content for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') is required. ' example: one: hello other: world properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object strings_datetime_modified: description: The date the resource string's content was last updated. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string tags: description: List of tags for the resource string. example: - foo - bar items: type: string type: array required: - appearance_order - key - context - strings - tags - occurrences - developer_comment - instructions - character_limit - pluralized - string_hash - datetime_created - metadata_datetime_modified - strings_datetime_modified type: object id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string links: additionalProperties: false description: Resource String link. properties: self: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - self type: object relationships: additionalProperties: false description: Resource String relationships. properties: committer: additionalProperties: false description: User object. properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object language: additionalProperties: false description: Language object. properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object resource: additionalProperties: false description: Resource object. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object required: - language - resource - committer type: object type: enum: - resource_strings type: string required: - type - id - attributes - relationships - links type: object type: object application/vnd.api+json;profile="bulk": schema: additionalProperties: false properties: data: items: additionalProperties: false properties: attributes: additionalProperties: false description: Resource String attributes. properties: appearance_order: description: 'The order that the resource string appears in it''s container. In case of files appearance order is extracted automatically, where in other cases this may be missing ' nullable: true type: integer character_limit: description: The maximum translation string character length, excluding variables. Use value 0 to remove the existing character limit. example: 100 maximum: 2147483647 minimum: 0 nullable: true type: integer context: description: 'Additional context added, in order to link the resource string to the environment in which the communication takes place and/or disambiguate resource strings with the same content. Context can be multiple substrings, concatenated with some separator. ' example: frontpage,footer,verb type: string datetime_created: description: The date the resource string was created. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string developer_comment: description: 'Developer comment gives additional information about the usage of this string and/or technical details relevant to this string. ' example: Wrapped in a 30px width div nullable: true type: string instructions: description: Additional translation instructions. Usually provided if the `developer_comment` is not present or not sufficiently clear. The maximum length should be up to 1000 characters. example: Please use causal language for translations. maxLength: 1000 nullable: true type: string key: description: 'The identifier of the resource string in it''s container. In cases where two resource strings in the same container share the same key, `context` is also used to disambiguate the identity of each resource string. ' example: hello_world type: string metadata_datetime_modified: description: The date the resource string's metadata were last updated. Examples of such attributes are `tags` and `character limit`. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string occurrences: description: The occurrences of the resource string in the source code. example: /my_project/templates/frontpage/hello.html:30 nullable: true type: string pluralized: description: If the resource string is pluralized or not. type: boolean string_hash: description: The hash of the resource string. This is calculated as the hexadecimal digest on the md5 hash of the concatenation of the key and the context. More info [here](https://help.transifex.com/en/articles/6649327-how-string-hashes-are-calculated). example: 2e354ef120752c67afa1b6855aa80c52 type: string strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys should be all the available plural rules for source language, as defined in CLDR, and the values the actual content for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') is required. ' example: one: hello other: world properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object strings_datetime_modified: description: The date the resource string's content was last updated. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string tags: description: List of tags for the resource string. example: - foo - bar items: type: string type: array required: - appearance_order - key - context - strings - tags - occurrences - developer_comment - instructions - character_limit - pluralized - string_hash - datetime_created - metadata_datetime_modified - strings_datetime_modified type: object id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string links: additionalProperties: false description: Resource String link. properties: self: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - self type: object relationships: additionalProperties: false description: Resource String relationships. properties: committer: additionalProperties: false description: User object. properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object language: additionalProperties: false description: Language object. properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object resource: additionalProperties: false description: Resource object. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object required: - language - resource - committer type: object type: enum: - resource_strings type: string required: - type - id - attributes - relationships - links type: object type: array type: object description: Created. headers: Location: required: true schema: example: /resource_string/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: 'A resource string with key ''some_key'' and context ''[''some context'']'' already exists ' type: string source: additionalProperties: false properties: pointer: example: /data/attributes type: string type: object status: example: '409' type: string title: example: Conflict error type: string type: object type: array type: object application/vnd.api+json;profile="bulk": schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: 'A resource string with key ''some_key'' and context ''[''some context'']'' already exists ' type: string source: additionalProperties: false properties: pointer: example: /data/5/attributes type: string type: object status: example: '409' type: string title: example: Conflict error type: string type: object type: array type: object description: Conflict '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Create resource string tags: - Resource Strings x-released: true /resource_strings/{resource_string_id}: delete: description: 'Delete a resource string. Available only for file-less resources. ' responses: '204': description: No Content '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Delete resource string tags: - Resource Strings x-released: true get: description: Get the details of a specific resource string. responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false description: Resource String attributes. properties: appearance_order: description: 'The order that the resource string appears in it''s container. In case of files appearance order is extracted automatically, where in other cases this may be missing ' nullable: true type: integer character_limit: description: The maximum translation string character length, excluding variables. Use value 0 to remove the existing character limit. example: 100 maximum: 2147483647 minimum: 0 nullable: true type: integer context: description: 'Additional context added, in order to link the resource string to the environment in which the communication takes place and/or disambiguate resource strings with the same content. Context can be multiple substrings, concatenated with some separator. ' example: frontpage,footer,verb type: string datetime_created: description: The date the resource string was created. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string developer_comment: description: 'Developer comment gives additional information about the usage of this string and/or technical details relevant to this string. ' example: Wrapped in a 30px width div nullable: true type: string instructions: description: Additional translation instructions. Usually provided if the `developer_comment` is not present or not sufficiently clear. The maximum length should be up to 1000 characters. example: Please use causal language for translations. maxLength: 1000 nullable: true type: string key: description: 'The identifier of the resource string in it''s container. In cases where two resource strings in the same container share the same key, `context` is also used to disambiguate the identity of each resource string. ' example: hello_world type: string metadata_datetime_modified: description: The date the resource string's metadata were last updated. Examples of such attributes are `tags` and `character limit`. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string occurrences: description: The occurrences of the resource string in the source code. example: /my_project/templates/frontpage/hello.html:30 nullable: true type: string pluralized: description: If the resource string is pluralized or not. type: boolean string_hash: description: The hash of the resource string. This is calculated as the hexadecimal digest on the md5 hash of the concatenation of the key and the context. More info [here](https://help.transifex.com/en/articles/6649327-how-string-hashes-are-calculated). example: 2e354ef120752c67afa1b6855aa80c52 type: string strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys should be all the available plural rules for source language, as defined in CLDR, and the values the actual content for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') is required. ' example: one: hello other: world properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object strings_datetime_modified: description: The date the resource string's content was last updated. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string tags: description: List of tags for the resource string. example: - foo - bar items: type: string type: array required: - appearance_order - key - context - strings - tags - occurrences - developer_comment - instructions - character_limit - pluralized - string_hash - datetime_created - metadata_datetime_modified - strings_datetime_modified type: object id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string links: additionalProperties: false description: Resource String link. properties: self: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - self type: object relationships: additionalProperties: false description: Resource String relationships. properties: committer: additionalProperties: false description: User object. properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object language: additionalProperties: false description: Language object. properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object resource: additionalProperties: false description: Resource object. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object required: - language - resource - committer type: object type: enum: - resource_strings type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful response. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get resource string details tags: - Resource Strings x-released: true parameters: - description: Format of the Resource String id should be `o:organization_slug:p:project_slug:r:resource_slug:s:string_hash`. in: path name: resource_string_id required: true schema: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string patch: requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Update resource body request details. properties: attributes: additionalProperties: false minProperties: 1 properties: character_limit: description: The maximum translation string character length, excluding variables. Use value 0 to remove the existing character limit. example: 100 maximum: 2147483647 minimum: 0 nullable: true type: integer instructions: description: Additional translation instructions. Usually provided if the `developer_comment` is not present or not sufficiently clear. The maximum length should be up to 1000 characters. example: Please use causal language for translations. maxLength: 1000 nullable: true type: string keep_translations: default: true description: 'Option to keep translations if a source string with the same key changes. ' example: false type: boolean x-released: true strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys should be all the available plural rules for source language, as defined in CLDR, and the values the actual content for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') is required. This field only applies to resources that support the [source string edit](https://help.transifex.com/en/articles/6236820-edit-source-strings-online) functionality. Otherwise, a `400 Bad request` response will be returned. Changing the source string does not remove its translations. ' example: one: hello other: world properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object tags: description: List of tags for the resource string. example: - foo - bar items: type: string type: array type: object id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string type: enum: - resource_strings type: string required: - type - id - attributes type: object required: - data type: object required: true responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false description: Resource String attributes. properties: appearance_order: description: 'The order that the resource string appears in it''s container. In case of files appearance order is extracted automatically, where in other cases this may be missing ' nullable: true type: integer character_limit: description: The maximum translation string character length, excluding variables. Use value 0 to remove the existing character limit. example: 100 maximum: 2147483647 minimum: 0 nullable: true type: integer context: description: 'Additional context added, in order to link the resource string to the environment in which the communication takes place and/or disambiguate resource strings with the same content. Context can be multiple substrings, concatenated with some separator. ' example: frontpage,footer,verb type: string datetime_created: description: The date the resource string was created. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string developer_comment: description: 'Developer comment gives additional information about the usage of this string and/or technical details relevant to this string. ' example: Wrapped in a 30px width div nullable: true type: string instructions: description: Additional translation instructions. Usually provided if the `developer_comment` is not present or not sufficiently clear. The maximum length should be up to 1000 characters. example: Please use causal language for translations. maxLength: 1000 nullable: true type: string key: description: 'The identifier of the resource string in it''s container. In cases where two resource strings in the same container share the same key, `context` is also used to disambiguate the identity of each resource string. ' example: hello_world type: string metadata_datetime_modified: description: The date the resource string's metadata were last updated. Examples of such attributes are `tags` and `character limit`. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string occurrences: description: The occurrences of the resource string in the source code. example: /my_project/templates/frontpage/hello.html:30 nullable: true type: string pluralized: description: If the resource string is pluralized or not. type: boolean string_hash: description: The hash of the resource string. This is calculated as the hexadecimal digest on the md5 hash of the concatenation of the key and the context. More info [here](https://help.transifex.com/en/articles/6649327-how-string-hashes-are-calculated). example: 2e354ef120752c67afa1b6855aa80c52 type: string strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys should be all the available plural rules for source language, as defined in CLDR, and the values the actual content for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') is required. ' example: one: hello other: world properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object strings_datetime_modified: description: The date the resource string's content was last updated. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string tags: description: List of tags for the resource string. example: - foo - bar items: type: string type: array required: - appearance_order - key - context - strings - tags - occurrences - developer_comment - instructions - character_limit - pluralized - string_hash - datetime_created - metadata_datetime_modified - strings_datetime_modified type: object id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string links: additionalProperties: false description: Resource String link. properties: self: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - self type: object relationships: additionalProperties: false description: Resource String relationships. properties: committer: additionalProperties: false description: User object. properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object language: additionalProperties: false description: Language object. properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object resource: additionalProperties: false description: Resource object. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object required: - language - resource - committer type: object type: enum: - resource_strings type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Update resource string tags: - Resource Strings x-released: true /resource_strings_async_downloads: post: description: 'The response represents the file download job. Check the job''s status and download the file itself once that is completed. ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Create resource string download body request details. properties: attributes: additionalProperties: false description: Resource strings async download attributes properties: callback_url: default: null description: 'The url that will be called when the processing is completed. For more details about callback_url you can refer to [Asynchronous Processing](#section/Asynchronous-Processing) section ' format: uri nullable: true type: string content_encoding: default: text description: The encoding of the file. enum: - text - base64 type: string file_type: default: default description: The file type. enum: - default - xliff type: string pseudo: default: false description: 'Generate mock string translations with a ~20% default length increase in characters.
More about pseudo-localization: https://help.transifex.com/en/articles/6231812-testing-localized-apps-with-pseudo-files. ' type: boolean pseudo_length_increase: description: 'Length increase percentage of mock string translations.
Applied only when pseudo flag is True. Overrides default pseudo length. ' maximum: 100 minimum: 1 nullable: true type: integer relationships: additionalProperties: false description: Resource strings download parent relationships. properties: resource: additionalProperties: false description: The `resource` for which a source file is downloaded. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object required: - data type: object required: - resource type: object type: enum: - resource_strings_async_downloads type: string required: - type - relationships type: object required: - data type: object required: true responses: '202': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: date_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string date_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string errors: items: additionalProperties: false properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending - processing - failed example: failed type: string required: - status - errors - date_created - date_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /resource_strings_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: resource: additionalProperties: false properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object required: - resource type: object type: enum: - resource_strings_async_downloads type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Accepted. headers: Content-Location: description: The location of the source download. required: true schema: type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Create a source file download action tags: - Resource Strings x-released: true summary: Create a source file download action /resource_strings_async_downloads/{resource_strings_async_download_id}: get: description: "With this endpoint, you can inquire about the status of a resource\ \ strings download job.\n\n- If the value of the 'status' attribute is 'pending'\ \ or 'processing', you\n should check this endpoint again later.\n- If the\ \ 'status' is 'failed', the source file has failed to be compiled.\n- In case\ \ the download job has been successful, you will receive a \"303 - See\n \ \ Other\" response and you can follow its `Location` to [download the file](#tag/File-Downloads/paths/get)\n\ \ that have been extracted from your file.\n" parameters: - description: Format of the resource_strings_async_download_id should be `o:organization_slug:p:project_slug:r:resource_slug`. in: path name: resource_strings_async_download_id required: true schema: example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: date_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string date_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string errors: items: additionalProperties: false properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending - processing - failed example: failed type: string required: - status - errors - date_created - date_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /resource_strings_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: resource: additionalProperties: false properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object required: - resource type: object type: enum: - resource_strings_async_downloads type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful response. '303': content: application/vnd.api+json: schema: {} description: See other headers: Location: description: The location of the source file. required: true schema: example: https://storage.svc.transifex.net/files/663a7a83-cb15-4c72-a37d-125dfb8432a6-file?auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZXMiOiJkb3dubG9hZCIsIm1ldGFkYXRhIjpudWxsLCJmaWxlX2lkcyI6IjY2M2E3YTgzLWNiMTUtNGM3Mi1hMzdkLTEyNWRmYjg0MzJhNi1maWxlIiwiZXhwIjoxNTg0NzE3NTkzLCJwcm92aWRlciI6InR4YyJ9.IHgLS4gtL0A6YZd-2zKkrg__geitcvs9DV8LcE8-1io type: string '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get resource strings download status tags: - Resource Strings x-released: true summary: Get resource strings download status /resource_strings_async_uploads: post: description: 'For more details about File uploads you can refer to [File Uploads](#section/File-Uploads) section The response represents the file upload job. Look into the ''status'' attribute to verify that the upload has completed successfuly. If the status is ''pending'' or ''processing'', then you will need to periodically inquire about its status. Use the ''self'' link, which will get you to the [/resource_strings_async_uploads/{resource_strings_async_upload_id}](#tag/Resource-Strings/paths/~1resource_strings_async_uploads~1{resource_strings_async_upload_id}/get) endpoint. ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Create source upload body request details. properties: attributes: additionalProperties: false description: Source Upload attributes attributes properties: callback_url: default: null description: 'The url that will be called when the processing is completed. For more details about callback_url you can refer to [Asynchronous Processing](#section/Asynchronous-Processing) section ' format: uri nullable: true type: string content: description: The file to upload json or base64 encoded. example: '{"hello": "transifex"}' type: string content_encoding: description: The encoding of the file. enum: - text - base64 type: string keep_translations: default: false description: Option to keep translations if a source string with the same key changes. example: false type: boolean purge_added_strings: default: false description: Option to remove source strings that were added from the editor and were not uploaded as part of a file. example: false type: boolean replace_edited_strings: default: false description: "Option to replace edited strings. \nIf true,\ \ updated strings modified in the editor will be overwritten.\n" example: false type: boolean required: - content - content_encoding relationships: additionalProperties: false description: Source Upload parent relationships. properties: resource: additionalProperties: false description: The `resource` source upload should belong to. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object required: - data type: object required: - resource type: object type: enum: - resource_strings_async_uploads type: string required: - type - attributes - relationships type: object required: - data type: object multipart/form-data: schema: additionalProperties: false properties: callback_url: default: null description: 'The url that will be called when the processing is completed. For more details about callback_url you can refer to [Asynchronous Processing](#section/Asynchronous-Processing) section ' format: uri nullable: true type: string content: description: The file to upload. example: FILE format: binary type: string keep_translations: default: false description: Option to keep translations if a source string with the same key changes. example: false type: boolean purge_added_strings: default: false description: Option to remove source strings that were added from the editor and were not uploaded as part of a file. example: false type: boolean replace_edited_strings: default: false description: "Option to replace edited strings. \nIf true, updated\ \ strings modified in the editor will be overwritten.\n" example: false type: boolean resource: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string required: - content - resource required: true responses: '202': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: date_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string date_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string details: additionalProperties: false nullable: true properties: strings_created: type: integer strings_deleted: type: integer strings_skipped: type: integer strings_updated: type: integer required: - strings_created - strings_updated - strings_skipped - strings_deleted type: object errors: items: additionalProperties: false properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending - processing - failed - succeeded example: failed type: string required: - status - errors - date_created - date_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /resource_strings_async_uploads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: resource: additionalProperties: false properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object required: - resource type: object type: enum: - resource_strings_async_uploads type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Accepted. headers: Content-Location: description: The location of the source upload. required: true schema: type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Upload a new source file for a resource. tags: - Resource Strings x-released: true summary: Upload a new source file for a resource. /resource_strings_async_uploads/{resource_strings_async_upload_id}: get: description: "With this endpoint, you can inquire about the status of a source\ \ upload job.\n\n- If the value of the 'status' attribute is 'pending' or\ \ 'processing', you\n should check this endpoint again later.\n- If the 'status'\ \ is 'failed', the content has failed to be uploaded to the\n resource.\n\ - If the 'status' is 'succeeded', you can get more details about the number\n\ \ of strings created, deleted, skipped and updated in the `details` attribute\n\ \ of the response.\n" parameters: - description: Format of the resource_strings_async_upload_id should be a UUID. in: path name: resource_strings_async_upload_id required: true schema: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: date_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string date_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string details: additionalProperties: false nullable: true properties: strings_created: type: integer strings_deleted: type: integer strings_skipped: type: integer strings_updated: type: integer required: - strings_created - strings_updated - strings_skipped - strings_deleted type: object errors: items: additionalProperties: false properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending - processing - failed - succeeded example: failed type: string required: - status - errors - date_created - date_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /resource_strings_async_uploads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: resource: additionalProperties: false properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object required: - resource type: object type: enum: - resource_strings_async_uploads type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful response. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get source upload tags: - Resource Strings x-released: true summary: Get source upload /resource_strings_revisions: get: description: Get revisions of resource strings parameters: - description: Filter results by a resource in: query name: filter[resource_string][resource] required: true schema: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string - description: Exact match for the key of the resource string. This filter is case sensitive. in: query name: filter[resource_string][key] required: false schema: example: hello_world minLength: 1 type: string - description: Retrieve source strings revisions containing all of the query tags. explode: false in: query name: filter[resource_string][tags][all] required: false schema: items: type: string minItems: 1 type: array style: form - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string - description: The page size limit. If not set, the default value is 150.
If set, the minimum value it can take is 150 and the maximum 1000. in: query name: limit schema: example: 150 nullable: true type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: additionalProperties: false properties: attributes: additionalProperties: false properties: date_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys should be all the available plural rules for source language, as defined in CLDR, and the values the actual content for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') is required. ' example: one: hello other: world properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object required: - strings - date_created type: object id: description: Resource Strings Revisions identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:v:2022-01-19T14:34:24UTC pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}:v:[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}UTC type: string relationships: additionalProperties: false description: Resource Strings Revisions relationships. properties: resource_string: additionalProperties: false description: Resource object. properties: data: additionalProperties: false properties: id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string type: enum: - resource_strings type: string required: - id - type type: object links: additionalProperties: false properties: related: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - related type: object required: - data - links type: object required: - resource_string type: object type: enum: - resource_strings_revisions type: string required: - type - id - attributes - relationships type: object type: array links: additionalProperties: false description: Pagination links. properties: next: description: Resource results cursor link. example: /resource_strings_revisions?filter[resource_string][resource]=o:organization:p:project_slug:r:resource_slug&filter[key]=key&page[cursor]=XXX nullable: true type: string previous: description: Resource results cursor link. example: /resource_strings_revisions?filter[resource_string][resource]=o:organization:p:project_slug:r:resource_slug&filter[key]=key&page[cursor]=XXX nullable: true type: string self: description: Resource Strings Revisions details link. example: /resource_strings_revisions?filter[resource_string][resource]=o:organization:p:project_slug:r:resource_slug&filter[key]=key type: string required: - self - next - previous type: object required: - data type: object description: Successful response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Get revisions of resource strings tags: - Resource Strings x-released: true summary: Get revisions of resource strings /resource_translations: get: parameters: - description: Filter results by a resource in: query name: filter[resource] required: true schema: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string - description: Filter results by a language in: query name: filter[language] required: true schema: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string - in: query name: filter[date_translated][gt] required: false schema: oneOf: - example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string - description: Date, will be treated as UTC by the API example: XXXX-XX-XX format: date type: string - in: query name: filter[date_translated][lt] required: false schema: oneOf: - example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string - description: Date, will be treated as UTC by the API example: XXXX-XX-XX format: date type: string - in: query name: filter[resource_string][key] required: false schema: example: hello_world minLength: 1 type: string - in: query name: filter[resource_string][date_modified][gte] required: false schema: oneOf: - example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string - description: Date, will be treated as UTC by the API example: XXXX-XX-XX format: date type: string - in: query name: filter[resource_string][date_modified][lte] required: false schema: oneOf: - example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string - description: Date, will be treated as UTC by the API example: XXXX-XX-XX format: date type: string - in: query name: filter[translated] required: false schema: example: true type: boolean - in: query name: filter[reviewed] required: false schema: example: true type: boolean - in: query name: filter[proofread] required: false schema: example: false type: boolean - in: query name: filter[finalized] required: false schema: example: false type: boolean - in: query name: filter[translator] required: false schema: example: u:username minLength: 1 type: string - in: query name: filter[origin] required: false schema: enum: - API - EDITOR - UPLOAD - TM - VENDORS:GENGO - VENDORS:TEXTMASTER - VENDORS:E2F - MT:GOOGLE - MT:MICROSOFT - MT:AMAZON - MT:DEEPL - AUTOFETCH - TX:AUTOMATED - TX:NATIVE_MIGRATION - TX:PROPAGATED - TX:MERGED example: EDITOR type: string - in: query name: filter[task_language_identifier] required: false schema: example: project_slug:task_number:language_code:type pattern: ^[a-zA-Z0-9._-]+:[0-9]+:[a-zA-Z0-9._-]+:(translation|review|proofread)$ type: string - description: Use the value `resource_string` to get the list of resource string objects in the response. explode: false in: query name: include required: false schema: enum: - resource_string type: string style: form - description: Retrieve translation strings containing all of the query tags. explode: false in: query name: filter[resource_string][tags][all] required: false schema: items: example: tag1,tag2 type: string minItems: 1 type: array style: form - description: Retrieve translation strings containing any of the query tags. If the filter value is *, all strings with any tag will be returned. However, if you use * along with another tag value, such as *,tag1, only strings with either * or 'tag1' tags will be returned. explode: false in: query name: filter[resource_string][tags][any] required: false schema: items: example: tag1,tag2 type: string minItems: 1 type: array style: form - description: "Retrieve translation strings based on specified query tags.\n\ \nTo filter strings, use a combination of tags with the following syntax:\n\ - Use an ampersand ('&') to signify 'AND' functionality, indicating that\ \ all specified\n tags must be present.\n- Use a pipe ('|') to signify\ \ 'OR' functionality, meaning that at least one of\n the specified tags\ \ must be present.\n- Use parentheses '(' to ')' to define the order of\ \ statement execution.\n- To use the above special characters as part of\ \ the query content, escape them with a\n backslash ('\\\\')\n\nWhen combining\ \ AND and OR conditions, the query is evaluated from left to right, following\ \ operator precedence and respecting existing parentheses. Specifically,\ \ the AND operator (&) takes precedence over the OR operator (|).\n\nFor\ \ example, consider the query:\n'tag1&(tag2|tag3)'\n\nThis query is interpreted\ \ as follows:\ntag1 AND (tag2 OR tag3), and it returns strings that have\ \ both \"tag1\" and either \"tag2\" or \"tag3\"\n\nSimilarly, for the query:\n\ 'tag1&tag2|tag3'\n\nThis query is read as follows:\n(tag1 AND tag2) OR tag3,\ \ and it returns strings that have both \"tag1\" and \"tag2\" or have \"\ tag3\"\n" explode: false in: query name: filter[resource_string][tags][query] required: false schema: example: tag1&tag2|tag3 minLength: 1 type: string style: form - description: The page size limit. If not set, the default value is 150.
If set, the minimum value it can take is 150 and the maximum 1000. in: query name: limit schema: example: 150 nullable: true type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: description: List of resource translation objects. items: additionalProperties: false properties: attributes: additionalProperties: false description: Resource Translation attributes. properties: datetime_created: description: The date when a resource string is made available, in a target language, to receive translations. When a new resource string is added to the system, the value of this field is the same as the resource string creation date, for every existing target language in the related project. When a new target language is added to a project, the value of this field is the same as the date the target language was added, for all resource strings already in the project. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_proofread: description: The date that the resource translation was proofread. Null, if the resource translation is not proofread. example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string datetime_reviewed: description: The date that the resource translation was reviewed. If multiple reviews have occurred, then this date holds the latest. Null, if the resource translation is not reviewed. example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string datetime_translated: description: The date that the resource string was last translated on this language. If multiple edits on the strings have occurred, then this date holds the latest. Null, if the resource string is not translated. example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string finalized: description: If the resource translation is finalized or not. Depending on the number of review steps in the project, this either denotes reviewed (1 review step) or proofread (2 review steps). example: false type: boolean origin: description: The origin of the translation enum: - API - EDITOR - UPLOAD - TM - VENDORS:GENGO - VENDORS:TEXTMASTER - VENDORS:E2F - MT:GOOGLE - MT:MICROSOFT - MT:AMAZON - MT:DEEPL - AUTOFETCH - TX:AUTOMATED - TX:NATIVE_MIGRATION - TX:PROPAGATED - TX:MERGED example: EDITOR nullable: true type: string proofread: description: If the resource translation is proofread or not. example: false type: boolean reviewed: description: If the resource translation is reviewed or not. example: true type: boolean strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys will be all the available plural rules for target language, as defined in CLDR, and the values the actual translation for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') will be present. The object will be `null` in case of untranslated content.' example: one: hello other: world nullable: true properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object required: - strings - reviewed - proofread - finalized - origin - datetime_created - datetime_translated - datetime_reviewed - datetime_proofread type: object id: description: Resource Translation identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:el_GR pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-fA-F]{32}:l:[a-zA-Z0-9@_-]+$ type: string links: additionalProperties: false description: Resource Translation links. properties: self: description: Resource Translation details link. example: /resource_translations/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:language_code type: string required: - self type: object relationships: additionalProperties: false description: Resource Translation relationships. properties: language: additionalProperties: false description: Language object. properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object proofreader: additionalProperties: false description: User object. nullable: true properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object resource: additionalProperties: false description: Resource object. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object resource_string: additionalProperties: false description: Resource String object. properties: data: additionalProperties: false description: Resource String data container. properties: id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string type: enum: - resource_strings type: string required: - type - id type: object links: additionalProperties: false description: Resource String related link. properties: related: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - related type: object required: - links - data type: object reviewer: additionalProperties: false description: User object. nullable: true properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object translator: additionalProperties: false description: User object. nullable: true properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object required: - resource - language - resource_string - translator - reviewer - proofreader type: object type: enum: - resource_translations type: string required: - type - id - attributes - relationships - links type: object type: array included: description: List of included resource string objects. items: additionalProperties: false properties: attributes: additionalProperties: false description: Resource String attributes. properties: appearance_order: description: 'The order that the resource string appears in it''s container. In case of files appearance order is extracted automatically, where in other cases this may be missing ' nullable: true type: integer character_limit: description: The maximum translation string character length, excluding variables. Use value 0 to remove the existing character limit. example: 100 maximum: 2147483647 minimum: 0 nullable: true type: integer context: description: 'Additional context added, in order to link the resource string to the environment in which the communication takes place and/or disambiguate resource strings with the same content. Context can be multiple substrings, concatenated with some separator. ' example: frontpage,footer,verb type: string datetime_created: description: The date the resource string was created. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string developer_comment: description: 'Developer comment gives additional information about the usage of this string and/or technical details relevant to this string. ' example: Wrapped in a 30px width div nullable: true type: string instructions: description: Additional translation instructions. Usually provided if the `developer_comment` is not present or not sufficiently clear. The maximum length should be up to 1000 characters. example: Please use causal language for translations. maxLength: 1000 nullable: true type: string key: description: 'The identifier of the resource string in it''s container. In cases where two resource strings in the same container share the same key, `context` is also used to disambiguate the identity of each resource string. ' example: hello_world type: string metadata_datetime_modified: description: The date the resource string's metadata were last updated. Examples of such attributes are `tags` and `character limit`. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string occurrences: description: The occurrences of the resource string in the source code. example: /my_project/templates/frontpage/hello.html:30 nullable: true type: string pluralized: description: If the resource string is pluralized or not. type: boolean string_hash: description: The hash of the resource string. This is calculated as the hexadecimal digest on the md5 hash of the concatenation of the key and the context. More info [here](https://help.transifex.com/en/articles/6649327-how-string-hashes-are-calculated). example: 2e354ef120752c67afa1b6855aa80c52 type: string strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys should be all the available plural rules for source language, as defined in CLDR, and the values the actual content for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') is required. ' example: one: hello other: world properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object strings_datetime_modified: description: The date the resource string's content was last updated. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string tags: description: List of tags for the resource string. example: - foo - bar items: type: string type: array required: - appearance_order - key - context - strings - tags - occurrences - developer_comment - instructions - character_limit - pluralized - string_hash - datetime_created - metadata_datetime_modified - strings_datetime_modified type: object id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string links: additionalProperties: false description: Resource String link. properties: self: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - self type: object relationships: additionalProperties: false description: Resource String relationships. properties: committer: additionalProperties: false description: User object. properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object language: additionalProperties: false description: Language object. properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object resource: additionalProperties: false description: Resource object. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object required: - language - resource - committer type: object type: enum: - resource_strings type: string required: - type - id - attributes - relationships - links type: object type: array links: additionalProperties: false description: Pagination links. properties: next: description: Link to the next page of results. example: /resource_strings?filter[resource]=o:organization_slug:p:project_slug:r:resource_slug&page[cursor]=XXX nullable: true type: string previous: description: Link to the next page of results. example: /resource_strings?filter[resource]=o:organization_slug:p:project_slug:r:resource_slug&page[cursor]=XXX nullable: true type: string self: description: Link to the current page of results. example: /resource_strings?filter[resource]=o:organization_slug:p:project_slug:r:resource_slug type: string required: - self - next - previous type: object required: - links - data type: object description: List of Resource Translations for a given resource and language. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get a Resource Translations collection tags: - Resource Translations x-released: true patch: description: 'Allows for bulk updating of translations up to 150 at a time. All resource strings should belong to the same resource and target the same translation language. ' requestBody: content: application/vnd.api+json;profile="bulk": schema: additionalProperties: false properties: data: items: additionalProperties: false description: Update resource translations request details. properties: attributes: additionalProperties: false minProperties: 1 properties: proofread: description: If the resource translation is proofread or not. example: false type: boolean reviewed: description: If the resource translation is reviewed or not. example: true type: boolean strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys should be all the available plural rules for target language, as defined in CLDR, and the values the actual translation for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') is required. In order to delete existing translated content, the client should supply `null` as the value of the object.' example: one: hello other: world nullable: true properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object type: object id: description: Resource Translation identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:el_GR pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-fA-F]{32}:l:[a-zA-Z0-9@_-]+$ type: string type: enum: - resource_translations type: string required: - type - id - attributes type: object maxItems: 150 minItems: 1 type: array uniqueItems: true required: - data type: object required: true responses: '200': content: application/vnd.api+json;profile="bulk": schema: additionalProperties: false properties: data: description: List of resource translation objects. items: additionalProperties: false properties: attributes: additionalProperties: false description: Resource Translation attributes. properties: datetime_created: description: The date when a resource string is made available, in a target language, to receive translations. When a new resource string is added to the system, the value of this field is the same as the resource string creation date, for every existing target language in the related project. When a new target language is added to a project, the value of this field is the same as the date the target language was added, for all resource strings already in the project. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_proofread: description: The date that the resource translation was proofread. Null, if the resource translation is not proofread. example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string datetime_reviewed: description: The date that the resource translation was reviewed. If multiple reviews have occurred, then this date holds the latest. Null, if the resource translation is not reviewed. example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string datetime_translated: description: The date that the resource string was last translated on this language. If multiple edits on the strings have occurred, then this date holds the latest. Null, if the resource string is not translated. example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string finalized: description: If the resource translation is finalized or not. Depending on the number of review steps in the project, this either denotes reviewed (1 review step) or proofread (2 review steps). example: false type: boolean origin: description: The origin of the translation enum: - API - EDITOR - UPLOAD - TM - VENDORS:GENGO - VENDORS:TEXTMASTER - VENDORS:E2F - MT:GOOGLE - MT:MICROSOFT - MT:AMAZON - MT:DEEPL - AUTOFETCH - TX:AUTOMATED - TX:NATIVE_MIGRATION - TX:PROPAGATED - TX:MERGED example: EDITOR nullable: true type: string proofread: description: If the resource translation is proofread or not. example: false type: boolean reviewed: description: If the resource translation is reviewed or not. example: true type: boolean strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys will be all the available plural rules for target language, as defined in CLDR, and the values the actual translation for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') will be present. The object will be `null` in case of untranslated content.' example: one: hello other: world nullable: true properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object required: - strings - reviewed - proofread - finalized - origin - datetime_created - datetime_translated - datetime_reviewed - datetime_proofread type: object id: description: Resource Translation identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:el_GR pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-fA-F]{32}:l:[a-zA-Z0-9@_-]+$ type: string links: additionalProperties: false description: Resource Translation links. properties: self: description: Resource Translation details link. example: /resource_translations/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:language_code type: string required: - self type: object relationships: additionalProperties: false description: Resource Translation relationships. properties: language: additionalProperties: false description: Language object. properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object proofreader: additionalProperties: false description: User object. nullable: true properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object resource: additionalProperties: false description: Resource object. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object resource_string: additionalProperties: false description: Resource String object. properties: data: additionalProperties: false description: Resource String data container. properties: id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string type: enum: - resource_strings type: string required: - type - id type: object links: additionalProperties: false description: Resource String related link. properties: related: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - related type: object required: - links - data type: object reviewer: additionalProperties: false description: User object. nullable: true properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object translator: additionalProperties: false description: User object. nullable: true properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object required: - resource - language - resource_string - translator - reviewer - proofreader type: object type: enum: - resource_translations type: string required: - type - id - attributes - relationships - links type: object type: array required: - data type: object description: List of Resource Translations for a given resource and language. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Bulk update a resource's translations. tags: - Resource Translations x-released: true summary: Get a Resource Translations collection /resource_translations/{resource_translation_id}: get: parameters: - description: Format of the Resource Translation id. Should be `o:organization_slug:p:project_slug:r:resource_slug:s:string_hash:l:language_code`. in: path name: resource_translation_id required: true schema: description: Resource Translation identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:el_GR pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-fA-F]{32}:l:[a-zA-Z0-9@_-]+$ type: string - description: Use the value `resource_string` to get the list of resource string objects in the response. explode: false in: query name: include required: false schema: enum: - resource_string type: string style: form responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false description: Resource Translation attributes. properties: datetime_created: description: The date when a resource string is made available, in a target language, to receive translations. When a new resource string is added to the system, the value of this field is the same as the resource string creation date, for every existing target language in the related project. When a new target language is added to a project, the value of this field is the same as the date the target language was added, for all resource strings already in the project. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_proofread: description: The date that the resource translation was proofread. Null, if the resource translation is not proofread. example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string datetime_reviewed: description: The date that the resource translation was reviewed. If multiple reviews have occurred, then this date holds the latest. Null, if the resource translation is not reviewed. example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string datetime_translated: description: The date that the resource string was last translated on this language. If multiple edits on the strings have occurred, then this date holds the latest. Null, if the resource string is not translated. example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string finalized: description: If the resource translation is finalized or not. Depending on the number of review steps in the project, this either denotes reviewed (1 review step) or proofread (2 review steps). example: false type: boolean origin: description: The origin of the translation enum: - API - EDITOR - UPLOAD - TM - VENDORS:GENGO - VENDORS:TEXTMASTER - VENDORS:E2F - MT:GOOGLE - MT:MICROSOFT - MT:AMAZON - MT:DEEPL - AUTOFETCH - TX:AUTOMATED - TX:NATIVE_MIGRATION - TX:PROPAGATED - TX:MERGED example: EDITOR nullable: true type: string proofread: description: If the resource translation is proofread or not. example: false type: boolean reviewed: description: If the resource translation is reviewed or not. example: true type: boolean strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys will be all the available plural rules for target language, as defined in CLDR, and the values the actual translation for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') will be present. The object will be `null` in case of untranslated content.' example: one: hello other: world nullable: true properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object required: - strings - reviewed - proofread - finalized - origin - datetime_created - datetime_translated - datetime_reviewed - datetime_proofread type: object id: description: Resource Translation identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:el_GR pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-fA-F]{32}:l:[a-zA-Z0-9@_-]+$ type: string links: additionalProperties: false description: Resource Translation links. properties: self: description: Resource Translation details link. example: /resource_translations/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:language_code type: string required: - self type: object relationships: additionalProperties: false description: Resource Translation relationships. properties: language: additionalProperties: false description: Language object. properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object proofreader: additionalProperties: false description: User object. nullable: true properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object resource: additionalProperties: false description: Resource object. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object resource_string: additionalProperties: false description: Resource String object. properties: data: additionalProperties: false description: Resource String data container. properties: id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string type: enum: - resource_strings type: string required: - type - id type: object links: additionalProperties: false description: Resource String related link. properties: related: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - related type: object required: - links - data type: object reviewer: additionalProperties: false description: User object. nullable: true properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object translator: additionalProperties: false description: User object. nullable: true properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object required: - resource - language - resource_string - translator - reviewer - proofreader type: object type: enum: - resource_translations type: string required: - type - id - attributes - relationships - links type: object included: description: List of included resource string objects. items: additionalProperties: false properties: attributes: additionalProperties: false description: Resource String attributes. properties: appearance_order: description: 'The order that the resource string appears in it''s container. In case of files appearance order is extracted automatically, where in other cases this may be missing ' nullable: true type: integer character_limit: description: The maximum translation string character length, excluding variables. Use value 0 to remove the existing character limit. example: 100 maximum: 2147483647 minimum: 0 nullable: true type: integer context: description: 'Additional context added, in order to link the resource string to the environment in which the communication takes place and/or disambiguate resource strings with the same content. Context can be multiple substrings, concatenated with some separator. ' example: frontpage,footer,verb type: string datetime_created: description: The date the resource string was created. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string developer_comment: description: 'Developer comment gives additional information about the usage of this string and/or technical details relevant to this string. ' example: Wrapped in a 30px width div nullable: true type: string instructions: description: Additional translation instructions. Usually provided if the `developer_comment` is not present or not sufficiently clear. The maximum length should be up to 1000 characters. example: Please use causal language for translations. maxLength: 1000 nullable: true type: string key: description: 'The identifier of the resource string in it''s container. In cases where two resource strings in the same container share the same key, `context` is also used to disambiguate the identity of each resource string. ' example: hello_world type: string metadata_datetime_modified: description: The date the resource string's metadata were last updated. Examples of such attributes are `tags` and `character limit`. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string occurrences: description: The occurrences of the resource string in the source code. example: /my_project/templates/frontpage/hello.html:30 nullable: true type: string pluralized: description: If the resource string is pluralized or not. type: boolean string_hash: description: The hash of the resource string. This is calculated as the hexadecimal digest on the md5 hash of the concatenation of the key and the context. More info [here](https://help.transifex.com/en/articles/6649327-how-string-hashes-are-calculated). example: 2e354ef120752c67afa1b6855aa80c52 type: string strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys should be all the available plural rules for source language, as defined in CLDR, and the values the actual content for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') is required. ' example: one: hello other: world properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object strings_datetime_modified: description: The date the resource string's content was last updated. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string tags: description: List of tags for the resource string. example: - foo - bar items: type: string type: array required: - appearance_order - key - context - strings - tags - occurrences - developer_comment - instructions - character_limit - pluralized - string_hash - datetime_created - metadata_datetime_modified - strings_datetime_modified type: object id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string links: additionalProperties: false description: Resource String link. properties: self: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - self type: object relationships: additionalProperties: false description: Resource String relationships. properties: committer: additionalProperties: false description: User object. properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object language: additionalProperties: false description: Language object. properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object resource: additionalProperties: false description: Resource object. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object required: - language - resource - committer type: object type: enum: - resource_strings type: string required: - type - id - attributes - relationships - links type: object type: array required: - data type: object description: Successful response. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get a Resource Translation details tags: - Resource Translations x-released: true patch: description: 'Allows to add/update/remove content for Resource Translations as well as reviewing/unreviewing existing work. When not all of the attributes are supplied in the request, these are interpreted as if they were included with their current value. The only exception in this rule is when `strings` are modified, the resource translation is by default unreviewed unless otherwise specified (with the `reviewed`/`proofread` attributes on the request body). ' parameters: - description: Format of the Resource Translation id. Should be `o:organization_slug:p:project_slug:r:resource_slug:s:string_hash:l:language_code`. in: path name: resource_translation_id required: true schema: description: Resource Translation identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:el_GR pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-fA-F]{32}:l:[a-zA-Z0-9@_-]+$ type: string requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Update resource body request details. properties: attributes: additionalProperties: false minProperties: 1 properties: proofread: description: If the resource translation is proofread or not. example: false type: boolean reviewed: description: If the resource translation is reviewed or not. example: true type: boolean strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys should be all the available plural rules for target language, as defined in CLDR, and the values the actual translation for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') is required. In order to delete existing translated content, the client should supply `null` as the value of the object.' example: one: hello other: world nullable: true properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object type: object id: description: Resource Translation identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:el_GR pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-fA-F]{32}:l:[a-zA-Z0-9@_-]+$ type: string type: enum: - resource_translations type: string required: - type - id - attributes type: object required: - data type: object required: true responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false description: Resource Translation attributes. properties: datetime_created: description: The date when a resource string is made available, in a target language, to receive translations. When a new resource string is added to the system, the value of this field is the same as the resource string creation date, for every existing target language in the related project. When a new target language is added to a project, the value of this field is the same as the date the target language was added, for all resource strings already in the project. example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_proofread: description: The date that the resource translation was proofread. Null, if the resource translation is not proofread. example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string datetime_reviewed: description: The date that the resource translation was reviewed. If multiple reviews have occurred, then this date holds the latest. Null, if the resource translation is not reviewed. example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string datetime_translated: description: The date that the resource string was last translated on this language. If multiple edits on the strings have occurred, then this date holds the latest. Null, if the resource string is not translated. example: XXXX-XX-XXTXX:XX:XXZ format: date-time nullable: true type: string finalized: description: If the resource translation is finalized or not. Depending on the number of review steps in the project, this either denotes reviewed (1 review step) or proofread (2 review steps). example: false type: boolean origin: description: The origin of the translation enum: - API - EDITOR - UPLOAD - TM - VENDORS:GENGO - VENDORS:TEXTMASTER - VENDORS:E2F - MT:GOOGLE - MT:MICROSOFT - MT:AMAZON - MT:DEEPL - AUTOFETCH - TX:AUTOMATED - TX:NATIVE_MIGRATION - TX:PROPAGATED - TX:MERGED example: EDITOR nullable: true type: string proofread: description: If the resource translation is proofread or not. example: false type: boolean reviewed: description: If the resource translation is reviewed or not. example: true type: boolean strings: additionalProperties: false description: 'Dictionary with the translation content. For pluralized resource strings, the keys will be all the available plural rules for target language, as defined in CLDR, and the values the actual translation for each plural rule. For non-pluralized resource strings, only the default plural rule (''other'') will be present. The object will be `null` in case of untranslated content.' example: one: hello other: world nullable: true properties: few: type: string many: type: string one: type: string other: type: string two: type: string zero: type: string required: - other type: object required: - strings - reviewed - proofread - finalized - origin - datetime_created - datetime_translated - datetime_reviewed - datetime_proofread type: object id: description: Resource Translation identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:el_GR pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-fA-F]{32}:l:[a-zA-Z0-9@_-]+$ type: string links: additionalProperties: false description: Resource Translation links. properties: self: description: Resource Translation details link. example: /resource_translations/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:language_code type: string required: - self type: object relationships: additionalProperties: false description: Resource Translation relationships. properties: language: additionalProperties: false description: Language object. properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object proofreader: additionalProperties: false description: User object. nullable: true properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object resource: additionalProperties: false description: Resource object. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object resource_string: additionalProperties: false description: Resource String object. properties: data: additionalProperties: false description: Resource String data container. properties: id: description: Resource String identifier. example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32} type: string type: enum: - resource_strings type: string required: - type - id type: object links: additionalProperties: false description: Resource String related link. properties: related: description: Resource String details link. example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52 type: string required: - related type: object required: - links - data type: object reviewer: additionalProperties: false description: User object. nullable: true properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object translator: additionalProperties: false description: User object. nullable: true properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object required: - resource - language - resource_string - translator - reviewer - proofreader type: object type: enum: - resource_translations type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Update a Resource Translation tags: - Resource Translations x-released: true /resource_translations_async_downloads: post: description: 'The response represents the file download job. Check the job''s status and download the file itself once that is completed. ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Create resource translation download body request details. properties: attributes: additionalProperties: false description: Resource translations async download attributes properties: callback_url: default: null description: 'The url that will be called when the processing is completed. For more details about callback_url you can refer to [Asynchronous Processing](#section/Asynchronous-Processing) section ' format: uri nullable: true type: string content_encoding: default: text description: The encoding of the file. enum: - text - base64 type: string file_type: default: default description: The file type. enum: - default - xliff - json type: string mode: default: default description: The transliteration mode of the downloaded file. enum: - default - reviewed - proofread - translator - untranslated - onlytranslated - onlyreviewed - onlyproofread - sourceastranslation type: string pseudo: default: false deprecated: true description: 'Generate mock translation of phrases.
More about pseudo-localization: https://help.transifex.com/en/articles/6231812-testing-localized-apps-with-pseudo-files.
This attribute is deprecated and will be removed in a future release.
For pseudo translations see [/resource_strings_async_downloads](#tag/Resource-Strings/paths/~1resource_strings_async_downloads/post) ' type: boolean relationships: additionalProperties: false description: Resource translation Download parent relationships. properties: language: additionalProperties: false description: The language for which a translation file is downloaded. properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object required: - data type: object resource: additionalProperties: false description: The `resource` for which a translation file is downloaded. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object required: - data type: object required: - resource - language type: object type: enum: - resource_translations_async_downloads type: string required: - type - relationships type: object required: - data type: object required: true responses: '202': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: date_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string date_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string errors: items: additionalProperties: false properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending - processing - failed example: failed type: string required: - status - errors - date_created - date_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /resource_translations_async_uploads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object resource: additionalProperties: false properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object required: - resource - language type: object type: enum: - resource_translations_async_downloads type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Accepted. headers: Content-Location: description: The location of the translation download. required: true schema: type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Create a translation file download action tags: - Resource Translations x-released: true summary: Create a translation file download action /resource_translations_async_downloads/{resource_translations_async_download_id}: get: description: "With this endpoint, you can inquire about the status of an translation\ \ download job.\n\n- If the value of the 'status' attribute is 'pending' or\ \ 'processing', you\n should check this endpoint again later.\n- If the 'status'\ \ is 'failed', the translation has failed to be compiled.\n- In case the upload\ \ job has been successful, you will receive a \"303 - See\n Other\" response\ \ and you can follow its `Location` to [download the file](#tag/File-Downloads/paths/get)\n\ \ that have been extracted from your file.\n" parameters: - description: Format of the resource_translations_async_download_id should be a UUID. in: path name: resource_translations_async_download_id required: true schema: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: date_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string date_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string errors: items: additionalProperties: false properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending - processing - failed example: failed type: string required: - status - errors - date_created - date_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /resource_translations_async_uploads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object resource: additionalProperties: false properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object required: - resource - language type: object type: enum: - resource_translations_async_downloads type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful response. '303': content: application/vnd.api+json: schema: {} description: See other headers: Location: description: The location of the translation file. required: true schema: example: https://storage.svc.transifex.net/files/663a7a83-cb15-4c72-a37d-125dfb8432a6-file?auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZXMiOiJkb3dubG9hZCIsIm1ldGFkYXRhIjpudWxsLCJmaWxlX2lkcyI6IjY2M2E3YTgzLWNiMTUtNGM3Mi1hMzdkLTEyNWRmYjg0MzJhNi1maWxlIiwiZXhwIjoxNTg0NzE3NTkzLCJwcm92aWRlciI6InR4YyJ9.IHgLS4gtL0A6YZd-2zKkrg__geitcvs9DV8LcE8-1io type: string '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get translation download status tags: - Resource Translations x-released: true summary: Get translation download status /resource_translations_async_fillups: post: description: Trigger an on demand fillup process for a resource's translations. requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Provide parameters for fillup. properties: attributes: additionalProperties: false description: Fillup attributes properties: ai_fillup: description: Whether to include AI fillup in the fillup process. example: true type: boolean machine_translation_fillup: description: Whether to include machine translation fillup in the fillup process. example: true type: boolean translation_memory_fillup: description: Whether to include translation memory fillup in the fillup process. example: true type: boolean translation_memory_fillup_options: additionalProperties: false description: Additional settings for the fillup process. Only available for TM fillup. properties: autoreview_policy: default: NONE description: Settings for autoreview policy. enum: - NONE - '100' - '101' example: NONE type: string context_matching_enabled: default: false description: Whether to consider context in the fillup process. example: true type: boolean fuzzy_match_cutoff_percent: default: 100 description: The percent threshold for the fillup process. example: 95 maximum: 100 minimum: 85 type: integer similar_locales_enabled: default: false description: Whether to include similar locales in the fillup process. example: true type: boolean type: object required: - translation_memory_fillup - machine_translation_fillup - ai_fillup type: object relationships: additionalProperties: false description: Fillup relationships properties: language: additionalProperties: false description: The language for which the fillup is triggered. properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object required: - data type: object resource: additionalProperties: false description: The `resource` for which the fillup is triggered. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object required: - data type: object required: - resource - language type: object type: enum: - resource_translations_async_fillups type: string required: - attributes - type - relationships type: object required: - data type: object required: true responses: '204': description: Fillup action created successfully. No response body. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Create a resource translations fillup action tags: - Resource Translations x-released: true /resource_translations_async_uploads: post: description: 'Upload a new resource translation file for a specific language. ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Create resource translation upload body request details. properties: attributes: additionalProperties: false description: Resource translations async upload attributes properties: callback_url: default: null description: 'The url that will be called when the processing is completed. For more details about callback_url you can refer to [Asynchronous Processing](#section/Asynchronous-Processing) section ' format: uri nullable: true type: string content: description: The file to upload json or base64 encoded. example: '{"hello": "Γεια σου"}' type: string content_encoding: description: The encoding of the file. enum: - text - base64 type: string file_type: description: The file type. enum: - default - xliff type: string required: - content - content_encoding - file_type relationships: additionalProperties: false description: Resource translation Upload parent relationships. properties: language: additionalProperties: false description: The language for which a translation file is uploaded. properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object required: - data type: object resource: additionalProperties: false description: The `resource` for which a translation file is uploaded. properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object required: - data type: object required: - resource - language type: object type: enum: - resource_translations_async_uploads type: string required: - type - attributes - relationships type: object required: - data type: object multipart/form-data: schema: additionalProperties: false properties: callback_url: default: null description: 'The url that will be called when the processing is completed. For more details about callback_url you can refer to [Asynchronous Processing](#section/Asynchronous-Processing) section ' format: uri nullable: true type: string content: description: The file to upload. example: FILE format: binary type: string file_type: enum: - default - xliff type: string language: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string resource: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string required: - content - resource - language type: object required: true responses: '202': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: date_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string date_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string details: additionalProperties: false nullable: true properties: translations_created: type: integer translations_updated: type: integer required: - translations_created - translations_updated type: object errors: items: additionalProperties: false properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending - processing - failed - succeeded example: failed type: string required: - status - errors - date_created - date_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /resource_translations_async_uploads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object resource: additionalProperties: false properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object required: - resource - language type: object type: enum: - resource_translations_async_uploads type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Accepted. headers: Content-Location: description: The location of the source upload. required: true schema: type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '429': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: Throttled type: string detail: example: Request was throttled. Expected available in 60 seconds. type: string status: example: '429' type: string title: example: Throttled type: string type: object type: array type: object description: Throttled '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Create a new resource translation upload tags: - Resource Translations x-released: true summary: Create a new resource translation upload /resource_translations_async_uploads/{resource_translations_async_upload_id}: get: description: Get details of a resource translations upload. parameters: - description: Format of the resource_translations_async_upload_id should be a UUID. in: path name: resource_translations_async_upload_id required: true schema: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: date_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string date_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string details: additionalProperties: false nullable: true properties: translations_created: type: integer translations_updated: type: integer required: - translations_created - translations_updated type: object errors: items: additionalProperties: false properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending - processing - failed - succeeded example: failed type: string required: - status - errors - date_created - date_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /resource_translations_async_uploads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: additionalProperties: false properties: language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object resource: additionalProperties: false properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object links: additionalProperties: false description: Resource related link. properties: related: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - related type: object required: - links - data type: object required: - resource - language type: object type: enum: - resource_translations_async_uploads type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get resource translation async upload tags: - Resource Translations x-released: true summary: Get resource translation async upload /resources: get: description: Get a list of all resources (in a specific project). parameters: - description: Filter results by a project in: query name: filter[project] required: true schema: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string - in: query name: filter[slug] required: false schema: pattern: ^[a-zA-Z0-9._-]+$ type: string - in: query name: filter[name] required: false schema: type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: description: List of resource objects. items: additionalProperties: false properties: attributes: additionalProperties: false properties: accept_translations: description: Whether resource should accept translations or not example: true type: boolean categories: description: List of categories to associate similar resources example: - category_1 - category_2 items: type: string type: array datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string i18n_options: description: Any options that determine how the resource will be parsed and compiled example: allow_duplicate_strings: true nullable: true properties: allow_duplicate_strings: description: If true, identical strings found in the resource will be parsed as separate strings; otherwise, identical strings will be considered as instances of the same string. Available in "HTML" i18n type resources. type: boolean type: object i18n_version: description: File format type version. example: 1 type: number mp4_url: description: A (public) url to provide an MP4 video file for subtitles translation example: https://some.host.net/some_mp4_url nullable: true type: string name: description: Name of the resource example: Resource Name type: string ogg_url: description: A (public) url to provide an OGG video file for subtitles translation example: https://some.host.net/some_ogg_url nullable: true type: string priority: enum: - normal - high - urgent example: normal type: string slug: description: Slug of the resource example: Slug Name type: string string_count: description: Number of strings in the resource content. example: 0 type: number webm_url: description: A (public) url to provide a WEMB video file for subtitles translation example: https://some.host.net/some_webm_url nullable: true type: string word_count: description: Number of words in the resource content. example: 0 type: number youtube_url: description: A (public) YouTube url to provide a video file for subtitles translation example: https://www.youtube.com/ nullable: true type: string required: - slug - name - i18n_version - priority - accept_translations - categories - i18n_options - mp4_url - ogg_url - webm_url - youtube_url - string_count - word_count - datetime_created - datetime_modified type: object id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false description: Resource links. properties: self: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - self type: object relationships: additionalProperties: false description: Resource relationships. properties: i18n_format: additionalProperties: false description: I18n format object. properties: data: additionalProperties: false description: I18n Format identifier object. properties: id: example: YML_KEY pattern: ^[A-Z0-9@_-]+$ type: string type: enum: - i18n_formats type: string required: - type - id type: object required: - data type: object project: additionalProperties: false description: Project object. properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - project type: object type: enum: - resources type: string required: - type - id - attributes - relationships - links type: object type: array links: additionalProperties: false description: Pagination links. properties: next: description: Resource results cursor link. example: /resources?filter[project]=o:organization_slug:p:project_slug&page[cursor]=XXX nullable: true type: string previous: description: Resource results cursor link. example: /resources?filter[project]=o:organization_slug:p:project_slug&page[cursor]=XXX nullable: true type: string self: description: Resource results cursor link. example: /resources?filter[project]=o:organization_slug:p:project_slug type: string required: - self - next - previous type: object required: - links - data type: object description: List of resources for a given project. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: List resources tags: - Resources x-released: true post: description: 'Making a POST request to this endpoint creates a resource without content. This step is performed synchronously so you don''t have to verify that resource creation succeeded afterwards. In order to upload content, see the [/resource_strings_async_uploads](#tag/Resource-Strings/paths/~1resource_strings_async_uploads/post) endpoint. ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Create resource body request details. properties: attributes: additionalProperties: false description: Resource attributes. properties: accept_translations: description: Whether resource should accept translations or not example: true type: boolean categories: description: List of categories to associate similar resources example: - category_1 - category_2 items: type: string type: array i18n_options: description: Any options that determine how the resource will be parsed and compiled example: allow_duplicate_strings: true nullable: true properties: allow_duplicate_strings: description: If true, identical strings found in the resource will be parsed as separate strings; otherwise, identical strings will be considered as instances of the same string. Available in "HTML" i18n type resources. type: boolean type: object mp4_url: description: A (public) url to provide an MP4 video file for subtitles translation example: https://some.host.net/some_mp4_url nullable: true type: string name: description: Name of the resource example: Resource Name type: string ogg_url: description: A (public) url to provide an OGG video file for subtitles translation example: https://some.host.net/some_ogg_url nullable: true type: string priority: enum: - normal - high - urgent example: normal type: string slug: description: Slug of the resource example: Slug Name type: string webm_url: description: A (public) url to provide a WEMB video file for subtitles translation example: https://some.host.net/some_webm_url nullable: true type: string youtube_url: description: A (public) YouTube url to provide a video file for subtitles translation example: https://www.youtube.com/ nullable: true type: string required: - name type: object relationships: additionalProperties: false description: Resource parent relationships. properties: base: additionalProperties: false description: The base `resource` that this `resource` is a branch of. nullable: true properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object type: object i18n_format: additionalProperties: false description: The `i18n_format` of the resource to create. properties: data: additionalProperties: false description: I18n Format identifier object. properties: id: example: YML_KEY pattern: ^[A-Z0-9@_-]+$ type: string type: enum: - i18n_formats type: string required: - type - id type: object required: - data type: object project: additionalProperties: false description: The `project` resource should belong to. properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object required: - data type: object required: - project - i18n_format type: object type: enum: - resources type: string required: - type - attributes - relationships type: object required: - data type: object required: true responses: '201': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: accept_translations: description: Whether resource should accept translations or not example: true type: boolean categories: description: List of categories to associate similar resources example: - category_1 - category_2 items: type: string type: array datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string i18n_options: description: Any options that determine how the resource will be parsed and compiled example: allow_duplicate_strings: true nullable: true properties: allow_duplicate_strings: description: If true, identical strings found in the resource will be parsed as separate strings; otherwise, identical strings will be considered as instances of the same string. Available in "HTML" i18n type resources. type: boolean type: object i18n_version: description: File format type version. example: 1 type: number mp4_url: description: A (public) url to provide an MP4 video file for subtitles translation example: https://some.host.net/some_mp4_url nullable: true type: string name: description: Name of the resource example: Resource Name type: string ogg_url: description: A (public) url to provide an OGG video file for subtitles translation example: https://some.host.net/some_ogg_url nullable: true type: string priority: enum: - normal - high - urgent example: normal type: string slug: description: Slug of the resource example: Slug Name type: string string_count: description: Number of strings in the resource content. example: 0 type: number webm_url: description: A (public) url to provide a WEMB video file for subtitles translation example: https://some.host.net/some_webm_url nullable: true type: string word_count: description: Number of words in the resource content. example: 0 type: number youtube_url: description: A (public) YouTube url to provide a video file for subtitles translation example: https://www.youtube.com/ nullable: true type: string required: - slug - name - i18n_version - priority - accept_translations - categories - i18n_options - mp4_url - ogg_url - webm_url - youtube_url - string_count - word_count - datetime_created - datetime_modified type: object id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false description: Resource links. properties: self: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - self type: object relationships: additionalProperties: false description: Resource relationships. properties: i18n_format: additionalProperties: false description: I18n format object. properties: data: additionalProperties: false description: I18n Format identifier object. properties: id: example: YML_KEY pattern: ^[A-Z0-9@_-]+$ type: string type: enum: - i18n_formats type: string required: - type - id type: object required: - data type: object project: additionalProperties: false description: Project object. properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - project type: object type: enum: - resources type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Created. headers: Location: required: true schema: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Create new resource tags: - Resources x-released: true /resources/{resource_id}: delete: description: Delete a resource of a project. responses: '204': description: No Content. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Delete resource tags: - Resources x-released: true get: description: Get details of a specific resource. responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: accept_translations: description: Whether resource should accept translations or not example: true type: boolean categories: description: List of categories to associate similar resources example: - category_1 - category_2 items: type: string type: array datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string i18n_options: description: Any options that determine how the resource will be parsed and compiled example: allow_duplicate_strings: true nullable: true properties: allow_duplicate_strings: description: If true, identical strings found in the resource will be parsed as separate strings; otherwise, identical strings will be considered as instances of the same string. Available in "HTML" i18n type resources. type: boolean type: object i18n_version: description: File format type version. example: 1 type: number mp4_url: description: A (public) url to provide an MP4 video file for subtitles translation example: https://some.host.net/some_mp4_url nullable: true type: string name: description: Name of the resource example: Resource Name type: string ogg_url: description: A (public) url to provide an OGG video file for subtitles translation example: https://some.host.net/some_ogg_url nullable: true type: string priority: enum: - normal - high - urgent example: normal type: string slug: description: Slug of the resource example: Slug Name type: string string_count: description: Number of strings in the resource content. example: 0 type: number webm_url: description: A (public) url to provide a WEMB video file for subtitles translation example: https://some.host.net/some_webm_url nullable: true type: string word_count: description: Number of words in the resource content. example: 0 type: number youtube_url: description: A (public) YouTube url to provide a video file for subtitles translation example: https://www.youtube.com/ nullable: true type: string required: - slug - name - i18n_version - priority - accept_translations - categories - i18n_options - mp4_url - ogg_url - webm_url - youtube_url - string_count - word_count - datetime_created - datetime_modified type: object id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false description: Resource links. properties: self: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - self type: object relationships: additionalProperties: false description: Resource relationships. properties: i18n_format: additionalProperties: false description: I18n format object. properties: data: additionalProperties: false description: I18n Format identifier object. properties: id: example: YML_KEY pattern: ^[A-Z0-9@_-]+$ type: string type: enum: - i18n_formats type: string required: - type - id type: object required: - data type: object project: additionalProperties: false description: Project object. properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - project type: object type: enum: - resources type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful Response. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get resource details tags: - Resources x-released: true parameters: - description: Format of composite id should be `o:organization_slug:p:project_slug:r:resource_slug`. in: path name: resource_id required: true schema: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string patch: description: Update details of a resource. requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Update resource body request details. properties: attributes: additionalProperties: false description: Resource multable attributes minProperties: 1 properties: accept_translations: description: Whether resource should accept translations or not example: true type: boolean categories: description: List of categories to associate similar resources example: - category_1 - category_2 items: type: string type: array mp4_url: description: A (public) url to provide an MP4 video file for subtitles translation example: https://some.host.net/some_mp4_url nullable: true type: string name: description: Name of the resource example: Resource Name type: string ogg_url: description: A (public) url to provide an OGG video file for subtitles translation example: https://some.host.net/some_ogg_url nullable: true type: string priority: enum: - normal - high - urgent example: normal type: string webm_url: description: A (public) url to provide a WEMB video file for subtitles translation example: https://some.host.net/some_webm_url nullable: true type: string youtube_url: description: A (public) YouTube url to provide a video file for subtitles translation example: https://www.youtube.com/ nullable: true type: string type: object id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string relationships: additionalProperties: false description: Resource modifiable relationships. properties: base: additionalProperties: false description: The base `resource` that this `resource` is a branch of. nullable: true properties: data: additionalProperties: false description: Resource data container. properties: id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string type: enum: - resources type: string required: - type - id type: object type: object type: object type: enum: - resources type: string required: - type - id type: object required: - data type: object required: true responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: attributes: additionalProperties: false properties: accept_translations: description: Whether resource should accept translations or not example: true type: boolean categories: description: List of categories to associate similar resources example: - category_1 - category_2 items: type: string type: array datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string i18n_options: description: Any options that determine how the resource will be parsed and compiled example: allow_duplicate_strings: true nullable: true properties: allow_duplicate_strings: description: If true, identical strings found in the resource will be parsed as separate strings; otherwise, identical strings will be considered as instances of the same string. Available in "HTML" i18n type resources. type: boolean type: object i18n_version: description: File format type version. example: 1 type: number mp4_url: description: A (public) url to provide an MP4 video file for subtitles translation example: https://some.host.net/some_mp4_url nullable: true type: string name: description: Name of the resource example: Resource Name type: string ogg_url: description: A (public) url to provide an OGG video file for subtitles translation example: https://some.host.net/some_ogg_url nullable: true type: string priority: enum: - normal - high - urgent example: normal type: string slug: description: Slug of the resource example: Slug Name type: string string_count: description: Number of strings in the resource content. example: 0 type: number webm_url: description: A (public) url to provide a WEMB video file for subtitles translation example: https://some.host.net/some_webm_url nullable: true type: string word_count: description: Number of words in the resource content. example: 0 type: number youtube_url: description: A (public) YouTube url to provide a video file for subtitles translation example: https://www.youtube.com/ nullable: true type: string required: - slug - name - i18n_version - priority - accept_translations - categories - i18n_options - mp4_url - ogg_url - webm_url - youtube_url - string_count - word_count - datetime_created - datetime_modified type: object id: description: Resource identifier. example: o:organization_slug:p:project_slug:r:resource_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false description: Resource links. properties: self: description: Resource details link. example: /resources/o:organization_slug:p:project_slug:r:resource_slug type: string required: - self type: object relationships: additionalProperties: false description: Resource relationships. properties: i18n_format: additionalProperties: false description: I18n format object. properties: data: additionalProperties: false description: I18n Format identifier object. properties: id: example: YML_KEY pattern: ^[A-Z0-9@_-]+$ type: string type: enum: - i18n_formats type: string required: - type - id type: object required: - data type: object project: additionalProperties: false description: Project object. properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - project type: object type: enum: - resources type: string required: - type - id - attributes - relationships - links type: object description: Successful Response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Update resource tags: - Resources x-released: true /tasks: get: description: Get the list of tasks that belong to a single organization. parameters: - description: Filter results by an organization in: query name: filter[organization] required: true schema: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string - description: Filter tasks by a project in: query name: filter[project] required: false schema: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string - description: Filter tasks by a task name in: query name: filter[name] required: false schema: type: string - description: Filter tasks by a task status in: query name: filter[statuses] required: false schema: description: Comma-separated list of task statuses example: PENDING,FINISHED pattern: ^(INITIALIZING|PENDING|FINISHED|DELETED)(,(INITIALIZING|PENDING|FINISHED|DELETED))*$ type: string - description: Filter tasks by a task assignee(s0) in: query name: filter[assignees] required: false schema: description: Comma-separated list of user IDs and optionally "unassigned" example: u:user_1,u:user_2,unassigned pattern: ^(u:[\w.-]+|unassigned)(,(u:[\w.-]+|unassigned))*$ type: string - description: Filter tasks by a task creator(s) in: query name: filter[creators] required: false schema: description: Comma-separated list of user IDs example: u:user_1,u:user_2 pattern: ^u:[\w.-]+(,u:[\w.-]+)*$ type: string - description: Filter tasks by a task due date before in: query name: filter[due_date][before] required: false schema: example: XXXX-XX-XX format: date type: string - description: Filter tasks by a task due date after in: query name: filter[due_date][after] required: false schema: example: XXXX-XX-XX format: date type: string - description: Filter tasks by a task created date before in: query name: filter[created_date][before] required: false schema: example: XXXX-XX-XX format: date type: string - description: Filter tasks by a task created date after in: query name: filter[created_date][after] required: false schema: example: XXXX-XX-XX format: date type: string - description: Filter tasks by a language code in: query name: filter[language_code] required: false schema: example: en type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: description: List of Task objects. items: additionalProperties: false properties: attributes: additionalProperties: false description: Task attributes. properties: completed_at: description: The date when the task was completed. example: '2025-01-01T00:00:00Z' format: date-time nullable: true type: string created_at: description: The date when the task was created. example: '2025-01-01T00:00:00Z' format: date-time type: string description: description: A description of the Task. example: Translate all resource strings type: string due_date: description: The final due date of the task. example: '2025-01-01' format: date nullable: true type: string exclusive_editing: description: Whether the task has exclusive editing enabled. example: false type: boolean name: description: The name of the Task. example: Transifex task maxLength: 255 type: string priority: enum: - NORMAL - HIGH - URGENT example: NORMAL type: string status: enum: - INITIALIZING - PENDING - FINISHED - DELETED example: PENDING type: string type: example: - TRANSLATION - REVIEW items: type: string type: array updated_at: description: The date when the task was updated. example: '2025-01-01T00:00:00Z' format: date-time type: string required: - name type: object id: description: Task identifier. example: o:organization_slug:p:project_slug:t:task_hash pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:t:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false description: Tasks self link. properties: self: description: Tasks details link. example: /tasks/o:organization_slug:p:project_slug:t:task_id type: string required: - self type: object relationships: additionalProperties: false description: Task relationships. properties: languages: additionalProperties: false properties: links: additionalProperties: false description: Task progress per language link. properties: related: description: Task progress per language link. example: /tasks/o:organization_slug:p:project_slug:t:task_id/languages type: string required: - related type: object required: - links type: object owner: additionalProperties: false properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object project: additionalProperties: false properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - owner - project type: object type: enum: - tasks type: string required: - type - id - attributes - relationships - links type: object type: array links: additionalProperties: false description: Pagination links. properties: next: description: Tasks cursor link. example: /tasks?filter[organization]=o:organization_slug&page[cursor]=XXX nullable: true type: string previous: description: Tasks cursor link. example: /tasks?filter[organization]=o:organization_slug&page[cursor]=XXX nullable: true type: string self: description: Tasks details link. example: /tasks/o:organization_slug:p:project_slug:t:task_id type: string required: - self - next - previous type: object required: - data - links type: object description: Get a list of all the tasks for a given organization '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: List tasks tags: - Tasks x-released: true post: description: "Making a POST request to this endpoint creates a task for the\ \ given project, \nwith the provided language and source string attributes.\ \ If it is not set to auto assign the assignees,\nuse the following endpoint\ \ [tasks//languages//relationships/assignees] \n" requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Create task body request details. properties: attributes: additionalProperties: false description: Task attributes. properties: assignee_selection_method: enum: - SKIP - AUTO example: SKIP type: string description: description: A description of the Task. example: Translate all resource strings type: string due_dates: additionalProperties: false description: The due dates to create the task for. nullable: true properties: PROOFREAD: description: The due date to create the task for proofread. example: '2025-01-01' type: string REVIEW: description: The due date to create the task for review. example: '2025-01-01' type: string TRANSLATION: description: The due date to create the task for translation. example: '2025-01-01' type: string type: object exclusive_editing: description: Whether to enable exclusive editing for the task. example: true type: boolean language_codes: description: The languages to create the task for. example: - l:en - l:fr items: type: string type: array name: description: The name of the Task. example: Transifex task maxLength: 255 type: string priority: enum: - NORMAL - HIGH - URGENT example: NORMAL type: string resource_string_ids: description: The resource strings to create the task for. example: - o::p::r::s: - o::p::r::s: items: type: string type: array task_type: enum: - TRANSLATION - AI_TRANSLATION - TRANSLATION_AND_REVIEW - AI_TRANSLATION_AND_REVIEW - TRANSLATION_AND_REVIEW_AND_PROOFREAD - AI_TRANSLATION_AND_REVIEW_AND_PROOFREAD example: TRANSLATION type: string required: - name - task_type - language_codes - resource_string_ids type: object relationships: additionalProperties: false description: Task relationships. properties: project: additionalProperties: false description: The `project` task should belong to. properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object required: - data type: object required: - project type: object type: enum: - tasks type: string required: - type - attributes - relationships type: object required: - data type: object required: true responses: '201': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false description: Task attributes. properties: completed_at: description: The date when the task was completed. example: '2025-01-01T00:00:00Z' format: date-time nullable: true type: string created_at: description: The date when the task was created. example: '2025-01-01T00:00:00Z' format: date-time type: string description: description: A description of the Task. example: Translate all resource strings type: string due_date: description: The final due date of the task. example: '2025-01-01' format: date nullable: true type: string exclusive_editing: description: Whether the task has exclusive editing enabled. example: false type: boolean name: description: The name of the Task. example: Transifex task maxLength: 255 type: string priority: enum: - NORMAL - HIGH - URGENT example: NORMAL type: string status: enum: - INITIALIZING - PENDING - FINISHED - DELETED example: PENDING type: string type: example: - TRANSLATION - REVIEW items: type: string type: array updated_at: description: The date when the task was updated. example: '2025-01-01T00:00:00Z' format: date-time type: string required: - name type: object id: description: Task identifier. example: o:organization_slug:p:project_slug:t:task_hash pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:t:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false description: Tasks self link. properties: self: description: Tasks details link. example: /tasks/o:organization_slug:p:project_slug:t:task_id type: string required: - self type: object relationships: additionalProperties: false description: Task relationships. properties: languages: additionalProperties: false properties: links: additionalProperties: false description: Task progress per language link. properties: related: description: Task progress per language link. example: /tasks/o:organization_slug:p:project_slug:t:task_id/languages type: string required: - related type: object required: - links type: object owner: additionalProperties: false properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object project: additionalProperties: false properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - owner - project type: object type: enum: - tasks type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Created. headers: Location: required: true schema: description: Tasks details link. example: /tasks/o:organization_slug:p:project_slug:t:task_id type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '402': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: payment_required type: string detail: example: 'Your plan doesn''t cover the requested feature, please upgrade ' type: string status: example: '402' type: string title: example: Payment required type: string type: object type: array type: object description: Payment required '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Create new task tags: - Tasks x-released: true /tasks/{task_id}: delete: description: Delete a task. parameters: - description: Task identifier in: path name: task_id required: true schema: description: Task identifier. example: o:organization_slug:p:project_slug:t:task_hash pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:t:[a-zA-Z0-9_-]+$ type: string responses: '204': description: No Content '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Delete Task tags: - Tasks x-released: true get: description: Get a single task by its ID. parameters: - description: Task identifier in: path name: task_id required: true schema: description: Task identifier. example: o:organization_slug:p:project_slug:t:task_hash pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:t:[a-zA-Z0-9_-]+$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false description: Task attributes. properties: completed_at: description: The date when the task was completed. example: '2025-01-01T00:00:00Z' format: date-time nullable: true type: string created_at: description: The date when the task was created. example: '2025-01-01T00:00:00Z' format: date-time type: string description: description: A description of the Task. example: Translate all resource strings type: string due_date: description: The final due date of the task. example: '2025-01-01' format: date nullable: true type: string exclusive_editing: description: Whether the task has exclusive editing enabled. example: false type: boolean name: description: The name of the Task. example: Transifex task maxLength: 255 type: string priority: enum: - NORMAL - HIGH - URGENT example: NORMAL type: string status: enum: - INITIALIZING - PENDING - FINISHED - DELETED example: PENDING type: string type: example: - TRANSLATION - REVIEW items: type: string type: array updated_at: description: The date when the task was updated. example: '2025-01-01T00:00:00Z' format: date-time type: string required: - name type: object id: description: Task identifier. example: o:organization_slug:p:project_slug:t:task_hash pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:t:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false description: Tasks self link. properties: self: description: Tasks details link. example: /tasks/o:organization_slug:p:project_slug:t:task_id type: string required: - self type: object relationships: additionalProperties: false description: Task relationships. properties: languages: additionalProperties: false properties: links: additionalProperties: false description: Task progress per language link. properties: related: description: Task progress per language link. example: /tasks/o:organization_slug:p:project_slug:t:task_id/languages type: string required: - related type: object required: - links type: object owner: additionalProperties: false properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object project: additionalProperties: false properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - owner - project type: object type: enum: - tasks type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Get a single task '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Get a task tags: - Tasks x-released: true patch: parameters: - description: Task identifier in: path name: task_id required: true schema: description: Task identifier. example: o:organization_slug:p:project_slug:t:task_hash pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:t:[a-zA-Z0-9_-]+$ type: string requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Update task body request details. minProperties: 3 properties: attributes: description: 'Task update attributes. Only one of the following can be performed at a time: update [name, description, priority, due_dates] or mark_as_completed or reopen. ' minProperties: 1 oneOf: - additionalProperties: false properties: exclusive_editing: description: Enable or disable exclusive editing for the task. example: true type: boolean required: - exclusive_editing type: object - additionalProperties: false properties: reopen: description: Whether to reopen the task. example: true type: boolean required: - reopen type: object - additionalProperties: false properties: mark_as_completed: description: Whether to mark the task as Completed. example: true type: boolean required: - mark_as_completed type: object - additionalProperties: false anyOf: - required: - name - required: - description - required: - priority - required: - due_dates properties: description: description: A description of the Task. example: Translate all resource strings type: string due_dates: additionalProperties: false description: The due dates to create the task for. nullable: true properties: PROOFREAD: description: The due date to create the task for proofread. example: '2025-01-01' type: string REVIEW: description: The due date to create the task for review. example: '2025-01-01' type: string TRANSLATION: description: The due date to create the task for translation. example: '2025-01-01' type: string type: object name: description: The name of the Task. example: Transifex task maxLength: 255 type: string priority: enum: - NORMAL - HIGH - URGENT example: NORMAL type: string type: object type: object id: description: Task identifier. example: o:organization_slug:p:project_slug:t:task_hash pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - tasks type: string required: - id - type type: object required: - data type: object required: true responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: The updated task object. properties: attributes: additionalProperties: false description: Task attributes. properties: completed_at: description: The date when the task was completed. example: '2025-01-01T00:00:00Z' format: date-time nullable: true type: string created_at: description: The date when the task was created. example: '2025-01-01T00:00:00Z' format: date-time type: string description: description: A description of the Task. example: Translate all resource strings type: string due_date: description: The final due date of the task. example: '2025-01-01' format: date nullable: true type: string exclusive_editing: description: Whether the task has exclusive editing enabled. example: false type: boolean name: description: The name of the Task. example: Transifex task maxLength: 255 type: string priority: enum: - NORMAL - HIGH - URGENT example: NORMAL type: string status: enum: - INITIALIZING - PENDING - FINISHED - DELETED example: PENDING type: string type: example: - TRANSLATION - REVIEW items: type: string type: array updated_at: description: The date when the task was updated. example: '2025-01-01T00:00:00Z' format: date-time type: string required: - name type: object id: description: Task identifier. example: o:organization_slug:p:project_slug:t:task_hash pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:t:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false description: Tasks self link. properties: self: description: Tasks details link. example: /tasks/o:organization_slug:p:project_slug:t:task_id type: string required: - self type: object relationships: additionalProperties: false description: Task relationships. properties: languages: additionalProperties: false properties: links: additionalProperties: false description: Task progress per language link. properties: related: description: Task progress per language link. example: /tasks/o:organization_slug:p:project_slug:t:task_id/languages type: string required: - related type: object required: - links type: object owner: additionalProperties: false properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - links - data type: object project: additionalProperties: false properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - owner - project type: object type: enum: - tasks type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Update a Task tags: - Tasks x-released: true /tasks/{task_id}/languages: get: description: Get the list of all languages of a task. parameters: - description: Format of composite id should be `o:organization_slug:p:project_slug:t:task_hash`. in: path name: task_id required: true schema: description: Task identifier. example: o:organization_slug:p:project_slug:t:task_hash pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:t:[a-zA-Z0-9_-]+$ type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string - in: query name: filter[task_type] required: false schema: description: Required task type to uniquely identify the task, language and task type combination. enum: - TRANSLATION - REVIEW - PROOFREAD - TQI_ALL - TQI_TRANSLATED - TQI_REVIEWED - TQI_PROOFREAD example: TRANSLATION type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: properties: attributes: additionalProperties: false properties: completed_words: example: 10 type: integer completed_words_percentage: example: 34.45 type: number due_date: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string identifier: description: The identifier of the task language. example: project_slug:task_number:language_code:type pattern: ^[a-zA-Z0-9._-]+:[0-9]+:[a-zA-Z0-9._-]+:(translation|review|proofread)$ type: string task_type: enum: - TRANSLATION - REVIEW - PROOFREAD - TQI_ALL - TQI_TRANSLATED - TQI_REVIEWED - TQI_PROOFREAD type: string total_words: example: 2 type: integer required: - task_type - total_words - completed_words - completed_words_percentage - due_date - identifier type: object relationships: properties: language: properties: data: allOf: - additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: allOf: - additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object type: object required: - language type: object type: enum: - task_languages type: string required: - type - attributes - relationships type: object type: array links: additionalProperties: false properties: next: example: /tasks/o:organization_slug:p:project_slug:t:task_hash/languages?page[cursor]=XXX nullable: true type: string previous: example: /tasks/o:organization_slug:p:project_slug:t:task_hash/languages?page[cursor]=XXX nullable: true type: string self: example: /tasks/o:organization_slug:p:project_slug:t:task_hash/languages type: string required: - self - previous - next type: object required: - data - links type: object description: Successful Response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: List task languages tags: - Tasks x-released: true summary: List task languages /tasks/{task_id}/languages/{language_id}/assignees: get: description: List assignees for given task language parameters: - description: Format of composite id should be `o:organization_slug:p:project_slug:t:task_hash`. in: path name: task_id required: true schema: description: Task identifier. example: o:organization_slug:p:project_slug:t:task_hash pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:t:[a-zA-Z0-9_-]+$ type: string - description: Format of the language id should be `l:language_code`. in: path name: language_id required: true schema: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string - in: query name: filter[task_type] required: true schema: description: Required task type to uniquely identify the task, language and task type combination. enum: - TRANSLATION - REVIEW - PROOFREAD - TQI_ALL - TQI_TRANSLATED - TQI_REVIEWED - TQI_PROOFREAD example: TRANSLATION type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: allOf: - description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object - properties: attributes: additionalProperties: false description: User attributes. properties: username: description: The username. example: user_1 type: string required: - username type: object links: additionalProperties: false description: User links. properties: self: description: User details link. example: /users/u:user_1 type: string required: - self type: object required: - attributes - links type: object type: array links: additionalProperties: false properties: next: example: /tasks/o:organization_slug:p:project_slug:t:task_hash/languages/l:code/assignees?page[cursor]=XXX nullable: true type: string previous: example: /tasks/o:organization_slug:p:project_slug:t:task_hash/languages/l:code/assignees?page[cursor]=XXX nullable: true type: string self: example: /tasks/o:organization_slug:p:project_slug:t:task_hash/languages/l:code/assignees type: string required: - self - previous - next type: object required: - data - links type: object description: Successful Response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: List task assignees tags: - Tasks x-released: true summary: List task assignees /tasks/{task_id}/languages/{language_id}/relationships/assignees: get: description: List task assignee relationships. parameters: - in: query name: filter[task_type] required: true schema: description: Required task type to uniquely identify the task, language and task type combination. enum: - TRANSLATION - REVIEW - PROOFREAD - TQI_ALL - TQI_TRANSLATED - TQI_REVIEWED - TQI_PROOFREAD example: TRANSLATION type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object type: array links: additionalProperties: false properties: next: example: /projects/o:organization_slug:p:project_slug:t:task_hash/relationships/languages/l:code/assignees?page[cursor]=XXX nullable: true type: string previous: example: /projects/o:organization_slug:p:project_slug:t:task_hash/relationships/languages/l:code/assignees?page[cursor]=XXX nullable: true type: string self: example: /projects/o:organization_slug:p:project_slug:t:task_hash/languages/l:code/relationships/assignees type: string required: - self - previous - next type: object required: - data - links type: object description: Successful Response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '402': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: payment_required type: string detail: example: 'Your plan doesn''t cover the requested feature, please upgrade ' type: string status: example: '402' type: string title: example: Payment required type: string type: object type: array type: object description: Payment required '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: List task assignee relationships tags: - Tasks x-released: true parameters: - description: Format of composite id should be `o:organization_slug:p:project_slug:t:task_hash`. in: path name: task_id required: true schema: description: Task identifier. example: o:organization_slug:p:project_slug:t:task_hash pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:t:[a-zA-Z0-9_-]+$ type: string - description: Format of the language id should be `l:language_code`. in: path name: language_id required: true schema: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string patch: description: 'Completely replace task assignees. _**Warning**: This is a highly destructive operation._ ' parameters: - in: query name: filter[task_type] required: true schema: description: Required task type to uniquely identify the task, language and task type combination. enum: - TRANSLATION - REVIEW - PROOFREAD - TQI_ALL - TQI_TRANSLATED - TQI_REVIEWED - TQI_PROOFREAD example: TRANSLATION type: string requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object type: array required: - data type: object required: true responses: '204': description: No content. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Update task assignees tags: - Tasks x-released: true summary: Manage task assignee relationships /team_activity_reports_async_downloads: post: description: 'The response represents the team activity report file download job. Check the job''s status and download the file itself once that is completed. ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: 'Create team activity report download body request details. ' properties: attributes: additionalProperties: false properties: date_from: description: Date, will be treated as UTC by the API example: XXXX-XX-XX format: date type: string date_to: description: Date, will be treated as UTC by the API example: XXXX-XX-XX format: date type: string first_time_edits: default: false description: Option to include first time edited/reviewed words. example: false type: boolean required: - date_from type: object relationships: additionalProperties: false properties: language: additionalProperties: false description: 'Only fetch translation activity for this language ' properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object required: - data type: object team: additionalProperties: false description: 'The `team` whose translation activity you want to make a report for. ' properties: data: description: Team data container. properties: id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - teams type: string required: - type - id type: object required: - data type: object user: additionalProperties: false description: 'Only fetch translation activity for this user ' properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object required: - data type: object required: - team type: object type: enum: - team_activity_reports_async_downloads type: string required: - type - attributes - relationships type: object required: - data type: object required: true responses: '202': content: application/vnd.api+json: schema: additionalProperties: false properties: data: allOf: - properties: attributes: additionalProperties: false properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string errors: items: properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending type: string required: - status - errors - datetime_created - datetime_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string required: - id - attributes type: object - description: The team activity report download job. properties: links: additionalProperties: false properties: self: example: /team_activity_reports_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: properties: language: properties: data: allOf: - additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: allOf: - additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object type: object team: properties: data: allOf: - description: Team data container. properties: id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - teams type: string required: - type - id type: object links: allOf: - additionalProperties: false properties: related: example: /teams/o:organization_slug:t:team_slug type: string required: - related type: object type: object user: properties: data: allOf: - description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: allOf: - additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object type: object required: - team type: object type: enum: - team_activity_reports_async_downloads type: string required: - type - links - relationships type: object required: - data type: object description: Accepted. headers: Content-Location: description: 'The location of the team activity report download. ' schema: example: /team_activity_reports_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Create a team activity report file download action tags: - Activity Reports x-released: true summary: Create a team activity report file download action /team_activity_reports_async_downloads/{team_activity_reports_async_download_id}: get: description: "With this endpoint, you can inquire about the status of an team\n\ activity report download job.\n\n- If the value of the 'status' attribute\ \ is 'pending' or 'processing', you\n should check this endpoint again later.\n\ - If the 'status' is 'failed', the report has failed to be compiled.\n- In\ \ case the upload job has been successful, you will receive a \"303 - See\n\ \ Other\" response and you can follow its `Location` to\n [download the\ \ file](#tag/File-Downloads/paths/get) that have been\n extracted from your\ \ file.\n" parameters: - description: 'Format of the team_activity_reports_async_download_id should be a UUID. ' in: path name: team_activity_reports_async_download_id required: true schema: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: allOf: - properties: attributes: additionalProperties: false properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string errors: items: properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending type: string required: - status - errors - datetime_created - datetime_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string required: - id - attributes type: object - description: The team activity report download job. properties: links: additionalProperties: false properties: self: example: /team_activity_reports_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string required: - self type: object relationships: properties: language: properties: data: allOf: - additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: allOf: - additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object type: object team: properties: data: allOf: - description: Team data container. properties: id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - teams type: string required: - type - id type: object links: allOf: - additionalProperties: false properties: related: example: /teams/o:organization_slug:t:team_slug type: string required: - related type: object type: object user: properties: data: allOf: - description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: allOf: - additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object type: object required: - team type: object type: enum: - team_activity_reports_async_downloads type: string required: - type - links - relationships type: object required: - data type: object description: Successful response. '303': content: application/vnd.api+json: schema: {} description: See other headers: Location: description: The location of the file. required: true schema: example: https://storage.svc.transifex.net/files/663a7a83-cb15-4c72-a37d-125dfb8432a6-file?auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZXMiOiJkb3dubG9hZCIsIm1ldGFkYXRhIjpudWxsLCJmaWxlX2lkcyI6IjY2M2E3YTgzLWNiMTUtNGM3Mi1hMzdkLTEyNWRmYjg0MzJhNi1maWxlIiwiZXhwIjoxNTg0NzE3NTkzLCJwcm92aWRlciI6InR4YyJ9.IHgLS4gtL0A6YZd-2zKkrg__geitcvs9DV8LcE8-1io type: string '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Get team activity report download status tags: - Activity Reports x-released: true summary: Get team activity report download status /team_memberships: get: description: List team memberships. parameters: - description: Filter results by an organization in: query name: filter[organization] required: true schema: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string - description: Filter results by a team in: query name: filter[team] required: false schema: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string - description: Filter results by a language in: query name: filter[language] required: false schema: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string - description: Filter results by a user in: query name: filter[user] required: false schema: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string - description: Filter results by role in: query name: filter[role] required: false schema: enum: - coordinator - reviewer - translator example: translator type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string - explode: false in: query name: include required: false schema: enum: - user type: string style: form responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: additionalProperties: false properties: attributes: additionalProperties: false properties: role: enum: - coordinator - reviewer - translator example: translator type: string required: - role type: object id: example: o:organization_slug:t:team_slug:l:lang_code:u:username pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9._-]+:l:[a-zA-Z0-9._-]+:u:[a-zA-Z0-9._-]+$ type: string links: additionalProperties: false properties: self: example: /team_memberships/o:organization_slug:t:team_slug:l:lang_code:u:username type: string required: - self type: object relationships: additionalProperties: false properties: language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - data - links type: object team: additionalProperties: false properties: data: description: Team data container. properties: id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - teams type: string required: - type - id type: object links: additionalProperties: false properties: related: example: /teams/o:organization_slug:t:team_slug type: string required: - related type: object required: - data - links type: object user: additionalProperties: false properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - data - links type: object required: - team - language - user type: object type: enum: - team_memberships example: team_memberships type: string required: - type - id - attributes - relationships - links type: object type: array included: description: List of included user objects. items: allOf: - description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object - properties: attributes: additionalProperties: false description: User attributes. properties: username: description: The username. example: user_1 type: string required: - username type: object links: additionalProperties: false description: User links. properties: self: description: User details link. example: /users/u:user_1 type: string required: - self type: object required: - attributes - links type: object type: array links: additionalProperties: false properties: next: example: /team_memberships?filter[organization]=organization_slug&page[cursor]=XXX nullable: true type: string previous: example: /team_memberships?filter[organization]=organization_slug&page[cursor]=XXX nullable: true type: string self: example: /team_memberships?filter[organization]=o:organization_slug type: string required: - self - previous - next type: object required: - data - links type: object description: Success. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: List team memberships tags: - Team Memberships x-released: true post: description: Create a new team membership. requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: role: enum: - coordinator - reviewer - translator example: translator type: string required: - role type: object relationships: additionalProperties: false properties: language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object required: - data type: object team: additionalProperties: false properties: data: description: Team data container. properties: id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - teams type: string required: - type - id type: object required: - data type: object user: additionalProperties: false properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object required: - data type: object required: - team - language - user type: object type: enum: - team_memberships example: team_memberships type: string required: - type - attributes - relationships type: object required: - data type: object required: true responses: '201': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: role: enum: - coordinator - reviewer - translator example: translator type: string required: - role type: object id: example: o:organization_slug:t:team_slug:l:lang_code:u:username pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9._-]+:l:[a-zA-Z0-9._-]+:u:[a-zA-Z0-9._-]+$ type: string links: additionalProperties: false properties: self: example: /team_memberships/o:organization_slug:t:team_slug:l:lang_code:u:username type: string required: - self type: object relationships: additionalProperties: false properties: language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - data - links type: object team: additionalProperties: false properties: data: description: Team data container. properties: id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - teams type: string required: - type - id type: object links: additionalProperties: false properties: related: example: /teams/o:organization_slug:t:team_slug type: string required: - related type: object required: - data - links type: object user: additionalProperties: false properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - data - links type: object required: - team - language - user type: object type: enum: - team_memberships example: team_memberships type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Success headers: Location: required: true schema: example: /team_memberships/o:organization_slug:t:team_slug:l:lang_code:u:username type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '402': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: payment_required type: string detail: example: 'Your plan doesn''t cover the requested feature, please upgrade ' type: string status: example: '402' type: string title: example: Payment required type: string type: object type: array type: object description: Payment required '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Create a new team membership tags: - Team Memberships x-released: true /team_memberships/{team_membership_id}: delete: description: Delete team membership. responses: '204': description: No content. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Delete team membership tags: - Team Memberships x-released: true get: description: Get single team membership. parameters: - explode: false in: query name: include required: false schema: enum: - user type: string style: form responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: role: enum: - coordinator - reviewer - translator example: translator type: string required: - role type: object id: example: o:organization_slug:t:team_slug:l:lang_code:u:username pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9._-]+:l:[a-zA-Z0-9._-]+:u:[a-zA-Z0-9._-]+$ type: string links: additionalProperties: false properties: self: example: /team_memberships/o:organization_slug:t:team_slug:l:lang_code:u:username type: string required: - self type: object relationships: additionalProperties: false properties: language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - data - links type: object team: additionalProperties: false properties: data: description: Team data container. properties: id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - teams type: string required: - type - id type: object links: additionalProperties: false properties: related: example: /teams/o:organization_slug:t:team_slug type: string required: - related type: object required: - data - links type: object user: additionalProperties: false properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - data - links type: object required: - team - language - user type: object type: enum: - team_memberships example: team_memberships type: string required: - type - id - attributes - relationships - links type: object included: description: List of included user objects. items: allOf: - description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object - properties: attributes: additionalProperties: false description: User attributes. properties: username: description: The username. example: user_1 type: string required: - username type: object links: additionalProperties: false description: User links. properties: self: description: User details link. example: /users/u:user_1 type: string required: - self type: object required: - attributes - links type: object type: array required: - data type: object description: Success '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Get single team membership tags: - Team Memberships x-released: true parameters: - in: path name: team_membership_id required: true schema: example: o:organization_slug:t:team_slug:l:lang_code:u:username pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9._-]+:l:[a-zA-Z0-9._-]+:u:[a-zA-Z0-9._-]+$ type: string patch: description: 'Update a membership''s role. You are only allowed to change the role. If you wish to change one of the relationships, you should delete the existing membership and create a new one with the desired relationships. The corresponding action in the UI is described [here](https://help.transifex.com/en/articles/6223458-managing-and-removing-collaborators#h_66d1be4260) ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: role: enum: - coordinator - reviewer - translator example: translator type: string required: - role type: object id: example: o:organization_slug:t:team_slug:l:lang_code:u:username pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9._-]+:l:[a-zA-Z0-9._-]+:u:[a-zA-Z0-9._-]+$ type: string type: enum: - team_memberships example: team_memberships type: string required: - type - id - attributes type: object required: - data type: object required: true responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: role: enum: - coordinator - reviewer - translator example: translator type: string required: - role type: object id: example: o:organization_slug:t:team_slug:l:lang_code:u:username pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9._-]+:l:[a-zA-Z0-9._-]+:u:[a-zA-Z0-9._-]+$ type: string links: additionalProperties: false properties: self: example: /team_memberships/o:organization_slug:t:team_slug:l:lang_code:u:username type: string required: - self type: object relationships: additionalProperties: false properties: language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - data - links type: object team: additionalProperties: false properties: data: description: Team data container. properties: id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - teams type: string required: - type - id type: object links: additionalProperties: false properties: related: example: /teams/o:organization_slug:t:team_slug type: string required: - related type: object required: - data - links type: object user: additionalProperties: false properties: data: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object links: additionalProperties: false description: User links. properties: related: description: User details link. example: /users/u:user_1 type: string required: - related type: object required: - data - links type: object required: - team - language - user type: object type: enum: - team_memberships example: team_memberships type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Success '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Update a membership's role tags: - Team Memberships x-released: true summary: Edit team membership /teams: get: description: Get the list of teams that belong to a single organization. parameters: - description: Filter results by an organization in: query name: filter[organization] required: true schema: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string - description: The slug of the team to get details in: query name: filter[slug] required: false schema: pattern: ^[a-zA-Z0-9._-]+$ type: string - in: query name: filter[name] required: false schema: type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: description: List of Project objects. items: additionalProperties: false properties: attributes: additionalProperties: false description: Team attributes. properties: auto_join: description: Whether members will be allowed in the team automatically type: boolean cla: description: The CLA members will need to agree to before joining type: string cla_required: description: Whether members will need to agree to a CLA before joining type: boolean datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string name: description: The name of the team type: string slug: description: The slug of the Team. example: team_slug maxLength: 255 pattern: ^[a-zA-Z0-9_-]+$ type: string required: - name - slug - auto_join - cla_required - cla - datetime_created type: object id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false properties: self: example: /teams/o:organization_slug:t:team_slug type: string required: - self type: object relationships: additionalProperties: false description: Team relationships properties: managers: additionalProperties: false description: Managers object. properties: links: additionalProperties: false properties: related: description: Team-managers list link example: /teams/o:organization_slug:t:team_slug/managers type: string self: description: Team-manager relationship link example: /teams/o:organization_slug:t:team_slug/relationships/managers type: string required: - self - related type: object required: - links type: object organization: additionalProperties: false description: Organization object. properties: data: additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object links: additionalProperties: false properties: related: description: Organization details link. example: /organizations/o:organization_slug type: string required: - related type: object required: - links - data type: object required: - organization type: object type: enum: - teams type: string required: - type - id - attributes - relationships - links type: object type: array links: additionalProperties: false description: Pagination links. properties: next: description: Link to the next page of results. example: /teams?filter[organization]=o:organization_slug&page[cursor]=XXX nullable: true type: string previous: description: Link to the previous page of results. example: /'teams?filter[organization]=o:organization_slug&page[cursor]=XXX' nullable: true type: string self: description: Link to the current page of results example: /teams?filter[organization]=o:organization_slug type: string required: - self - next - previous type: object required: - data - links type: object description: Get a list of all the teams for a given organization '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: List teams tags: - Teams x-released: true post: requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Create team body request details. properties: attributes: additionalProperties: false properties: auto_join: description: Whether members will be allowed in the team automatically type: boolean cla: description: The CLA members will need to agree to before joining type: string cla_required: description: Whether members will need to agree to a CLA before joining type: boolean name: description: The name of the team type: string required: - name type: object relationships: additionalProperties: false description: Team parent relationships. properties: organization: additionalProperties: false description: The `organization` the created team should belong to. properties: data: additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object required: - data type: object required: - organization type: object type: enum: - teams type: string required: - type - attributes - relationships type: object required: - data type: object required: true responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false description: Team attributes. properties: auto_join: description: Whether members will be allowed in the team automatically type: boolean cla: description: The CLA members will need to agree to before joining type: string cla_required: description: Whether members will need to agree to a CLA before joining type: boolean datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string name: description: The name of the team type: string slug: description: The slug of the Team. example: team_slug maxLength: 255 pattern: ^[a-zA-Z0-9_-]+$ type: string required: - name - slug - auto_join - cla_required - cla - datetime_created type: object id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false properties: self: example: /teams/o:organization_slug:t:team_slug type: string required: - self type: object relationships: additionalProperties: false description: Team relationships properties: managers: additionalProperties: false description: Managers object. properties: links: additionalProperties: false properties: related: description: Team-managers list link example: /teams/o:organization_slug:t:team_slug/managers type: string self: description: Team-manager relationship link example: /teams/o:organization_slug:t:team_slug/relationships/managers type: string required: - self - related type: object required: - links type: object organization: additionalProperties: false description: Organization object. properties: data: additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object links: additionalProperties: false properties: related: description: Organization details link. example: /organizations/o:organization_slug type: string required: - related type: object required: - links - data type: object required: - organization type: object type: enum: - teams type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful Response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict summary: Create a Team tags: - Teams x-released: true /teams/{team_id}: delete: description: Delete a team. responses: '204': description: No Content. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Delete team tags: - Teams x-released: true get: description: Get the details of a single team. responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false description: Team attributes. properties: auto_join: description: Whether members will be allowed in the team automatically type: boolean cla: description: The CLA members will need to agree to before joining type: string cla_required: description: Whether members will need to agree to a CLA before joining type: boolean datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string name: description: The name of the team type: string slug: description: The slug of the Team. example: team_slug maxLength: 255 pattern: ^[a-zA-Z0-9_-]+$ type: string required: - name - slug - auto_join - cla_required - cla - datetime_created type: object id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false properties: self: example: /teams/o:organization_slug:t:team_slug type: string required: - self type: object relationships: additionalProperties: false description: Team relationships properties: managers: additionalProperties: false description: Managers object. properties: links: additionalProperties: false properties: related: description: Team-managers list link example: /teams/o:organization_slug:t:team_slug/managers type: string self: description: Team-manager relationship link example: /teams/o:organization_slug:t:team_slug/relationships/managers type: string required: - self - related type: object required: - links type: object organization: additionalProperties: false description: Organization object. properties: data: additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object links: additionalProperties: false properties: related: description: Organization details link. example: /organizations/o:organization_slug type: string required: - related type: object required: - links - data type: object required: - organization type: object type: enum: - teams type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful Response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Get team detail tags: - Teams x-released: true parameters: - description: 'Format of composite id should be `o:organization_slug:t:team_slug`. ' in: path name: team_id required: true schema: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string patch: requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Update team body request details. properties: attributes: additionalProperties: false minProperties: 1 properties: auto_join: description: Whether members will be allowed in the team automatically type: boolean cla: description: The CLA members will need to agree to before joining type: string cla_required: description: Whether members will need to agree to a CLA before joining type: boolean name: description: The name of the team type: string type: object id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string type: enum: - teams type: string required: - id - type - attributes type: object required: - data type: object required: true responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: description: List of team objects. items: additionalProperties: false properties: attributes: additionalProperties: false description: Team attributes. properties: auto_join: description: Whether members will be allowed in the team automatically type: boolean cla: description: The CLA members will need to agree to before joining type: string cla_required: description: Whether members will need to agree to a CLA before joining type: boolean datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string name: description: The name of the team type: string slug: description: The slug of the Team. example: team_slug maxLength: 255 pattern: ^[a-zA-Z0-9_-]+$ type: string required: - name - slug - auto_join - cla_required - cla - datetime_created type: object id: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string links: additionalProperties: false properties: self: example: /teams/o:organization_slug:t:team_slug type: string required: - self type: object relationships: additionalProperties: false description: Team relationships properties: managers: additionalProperties: false description: Managers object. properties: links: additionalProperties: false properties: related: description: Team-managers list link example: /teams/o:organization_slug:t:team_slug/managers type: string self: description: Team-manager relationship link example: /teams/o:organization_slug:t:team_slug/relationships/managers type: string required: - self - related type: object required: - links type: object organization: additionalProperties: false description: Organization object. properties: data: additionalProperties: false description: Organization data container. properties: id: description: Organization identifier. example: o:org_123 pattern: ^o:[a-zA-Z0-9._-]+$ type: string type: enum: - organizations type: string required: - type - id type: object links: additionalProperties: false properties: related: description: Organization details link. example: /organizations/o:organization_slug type: string required: - related type: object required: - links - data type: object required: - organization type: object type: enum: - teams type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Update a team tags: - Teams x-released: true /teams/{team_id}/managers: description: Team managers. get: description: Get the managers of a team. responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: allOf: - description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object - properties: attributes: additionalProperties: false description: User attributes. properties: username: description: The username. example: user_1 type: string required: - username type: object links: additionalProperties: false description: User links. properties: self: description: User details link. example: /users/u:user_1 type: string required: - self type: object required: - attributes - links type: object type: array links: additionalProperties: false properties: next: example: /teams/o:organization_slug:t:team_slug/managers?page[cursor]=XXX nullable: true type: string previous: example: /teams/o:organization_slug:t:team_slug/managers?page[cursor]=XXX nullable: true type: string self: example: /teams/o:organization_slug:t:team_slug/managers type: string required: - self - previous - next type: object required: - data - links type: object description: Successful Response. summary: Get team managers tags: - Teams x-released: true parameters: - description: 'Format of composite id should be `o:organization_slug:t:team_slug`. ' in: path name: team_id required: true schema: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string summary: Get team managers /teams/{team_id}/relationships/managers: delete: description: Remove managers from team. requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object type: array required: - data type: object required: true responses: '204': description: No content. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Remove managers from team tags: - Teams x-released: true description: Update team managers. get: description: Get team manager relationships. parameters: - description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own. ' in: query name: page[cursor] schema: type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object type: array links: additionalProperties: false properties: next: example: /teams/o:organization_slug:t:team_slug/relationships/managers?page[cursor]=XXX nullable: true type: string previous: example: /teams/o:organization_slug:t:team_slug/relationships/managers?page[cursor]=XXX nullable: true type: string self: example: /teams/o:organization_slug:t:team_slug/relationships/managers type: string required: - self - previous - next type: object required: - data - links type: object description: Successful Response. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Get team manager relationships tags: - Teams x-released: true parameters: - description: 'Format of composite id should be `o:organization_slug:t:team_slug`. ' in: path name: team_id required: true schema: description: Team identifier. example: o:organization_slug:t:team_slug pattern: ^o:[a-zA-Z0-9._-]+:t:[a-zA-Z0-9_-]+$ type: string patch: description: 'Completely replace team managers. _**Warning**: This is a highly destructive operation._ ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object type: array required: - data type: object required: true responses: '204': description: No content. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '402': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: payment_required type: string detail: example: 'Your plan doesn''t cover the requested feature, please upgrade ' type: string status: example: '402' type: string title: example: Payment required type: string type: object type: array type: object description: Payment required '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Update team managers tags: - Teams x-released: true post: description: Add managers to team. requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: items: description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object type: array required: - data type: object required: true responses: '204': description: No content. '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '402': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: payment_required type: string detail: example: 'Your plan doesn''t cover the requested feature, please upgrade ' type: string status: example: '402' type: string title: example: Payment required type: string type: object type: array type: object description: Payment required '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Add managers to team tags: - Teams x-released: true summary: Edit team managers /tmx_async_downloads: post: description: 'The response represents the file download job. Check the job''s status and download the file itself once that is completed. ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Create tmx_async_download body request properties: attributes: additionalProperties: false properties: callback_url: default: null description: 'The url that will be called when the processing is completed. For more details about callback_url you can refer to [Asynchronous Processing](#section/Asynchronous-Processing) section ' format: uri nullable: true type: string email: default: false description: 'Whether to receive a link to the TMX file as an email when it''s ready. The email address used will be the one registered to the user making the API call ' type: boolean include_context: default: false deprecated: true description: 'Whether to include context in the tmx file.
This attribute will be ignored. Context will always be included.
' type: boolean include_untranslated: default: false deprecated: true description: 'Whether to include untranslated entities in the tmx file.
This attribute will be ignored. Untranslated entities will not be included.
' type: boolean type: object relationships: additionalProperties: false description: Source Upload parent relationships properties: language: additionalProperties: false description: The `language` to compile the tmx for properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object required: - data type: object project: additionalProperties: false description: The `project` to compile the tmx for properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object required: - data type: object required: - project type: object type: enum: - tmx_async_downloads type: string required: - type - relationships type: object required: - data type: object required: true responses: '202': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string errors: items: additionalProperties: false properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending - processing - failed - succeeded example: failed type: string required: - status - errors - datetime_created - datetime_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /tmx_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string type: object relationships: additionalProperties: false properties: language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object project: additionalProperties: false properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - project type: object type: enum: - tmx_async_downloads type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Accepted headers: Content-Location: description: The location of the tmx download. required: true schema: type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Create a tmx file download action tags: - Translation Memory x-released: true summary: Create a tmx file download action /tmx_async_downloads/{tmx_async_download_id}: get: description: "With this endpoint, you can inquire about the status of an tmx\ \ file download job.\n\n- If the value of the 'status' attribute is 'pending'\ \ or 'processing', you\n should check this endpoint again later.\n- If the\ \ 'status' is 'failed', the translation has failed to be compiled.\n- In case\ \ the upload job has been successful, you will receive a \"303 - See\n Other\"\ \ response and you can follow its `Location` to download the file.\n The\ \ download link will be valid for 30 days.\n" parameters: - description: Format of the tmx_async_download_id should be a UUID. in: path name: tmx_async_download_id required: true schema: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string datetime_modified: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string errors: items: additionalProperties: false properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array status: enum: - pending - processing - failed - succeeded example: failed type: string required: - status - errors - datetime_created - datetime_modified type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /tmx_async_downloads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string type: object relationships: additionalProperties: false properties: language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object project: additionalProperties: false properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - project type: object type: enum: - tmx_async_downloads type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Successful response '303': content: application/vnd.api+json: schema: {} description: See other headers: Location: description: The location of the TMX file. required: true schema: example: https://storage.svc.transifex.net/files/663a7a83-cb15-4c72-a37d-125dfb8432a6-file?auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZXMiOiJkb3dubG9hZCIsIm1ldGFkYXRhIjpudWxsLCJmaWxlX2lkcyI6IjY2M2E3YTgzLWNiMTUtNGM3Mi1hMzdkLTEyNWRmYjg0MzJhNi1maWxlIiwiZXhwIjoxNTg0NzE3NTkzLCJwcm92aWRlciI6InR4YyJ9.IHgLS4gtL0A6YZd-2zKkrg__geitcvs9DV8LcE8-1io type: string '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Get tmx file download status tags: - Translation Memory x-released: true summary: Get tmx file download status /tmx_async_uploads: post: description: 'Upload a new TMX file for a project. The response represents the file upload job. Check the job''s status to determine it''s completion. ' requestBody: content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false description: Create tmx_async_upload body request details properties: attributes: additionalProperties: false description: TMX Upload attributes properties: callback_url: default: null description: 'The url that will be called when the processing is completed. For more details about callback_url you can refer to [Asynchronous Processing](#section/Asynchronous-Processing) section ' format: uri nullable: true type: string content: description: The file to upload json or base64 encoded example: helloΓειά σου type: string content_encoding: description: The encoding of the file enum: - text - base64 type: string override: default: false description: Whether to override the tm when uploading a tmx file type: boolean required: - content - content_encoding relationships: additionalProperties: false description: TMX Upload parent relationships properties: language: additionalProperties: false description: The language that should be parsed properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object required: - data type: object project: additionalProperties: false description: The project the TMX upload should belong to properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object required: - data type: object required: - project type: object type: enum: - tmx_async_uploads type: string required: - type - attributes - relationships type: object required: - data type: object multipart/form-data: schema: additionalProperties: false properties: callback_url: default: null description: 'The url that will be called when the processing is completed. For more details about callback_url you can refer to [Asynchronous Processing](#section/Asynchronous-Processing) section ' format: uri nullable: true type: string content: description: The file to upload example: FILE format: binary type: string language_id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string override: default: false type: boolean project_id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string required: - content - project_id required: true responses: '202': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string errors: items: additionalProperties: false properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array override: type: boolean status: enum: - pending - processing - validated - failed - succeeded type: string required: - status - override - datetime_created - errors type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /tmx_async_uploads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string type: object relationships: additionalProperties: false properties: language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object project: additionalProperties: false properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - project type: object type: enum: - tmx_async_uploads type: string required: - type - id - attributes - relationships - links type: object required: - data type: object description: Accepted headers: Content-Location: description: The location of the TMX upload required: true schema: type: string '400': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: invalid type: string detail: example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens type: string source: anyOf: - properties: pointer: example: /data/attributes/name type: string - properties: parameter: example: ?filter[foo] type: string status: example: '400' type: string title: example: Field `name` is invalid type: string type: object type: array type: object description: Invalid '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '409': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: conflict type: string detail: example: Value `some_field_value` already exists type: string source: additionalProperties: false properties: pointer: example: /data/attributes/some_field type: string type: object status: example: '409' type: string title: example: Field `some_field` conflicted type: string type: object type: array type: object description: Conflict '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Create new TMX file upload. tags: - Translation Memory x-released: true summary: Create new TMX file upload. /tmx_async_uploads/{tmx_async_upload_id}: get: description: "With this endpoint, you can inquire about the status of an tmx\ \ file upload job.\n\n- If the value of the 'status' attribute is 'pending'\ \ or 'processing', you\n should check this endpoint again later.\n- If the\ \ 'status' is 'failed', the upload has failed to be parsed or validated.\n\ - In case the upload job has been successful, you will receive a 'succeeded'\n\ \ value for the 'status' attribute.\n" parameters: - description: Format of the tmx_async_upload_id should be a UUID. in: path name: tmx_async_upload_id required: true schema: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: additionalProperties: false properties: attributes: additionalProperties: false properties: datetime_created: example: XXXX-XX-XXTXX:XX:XXZ format: date-time type: string errors: items: additionalProperties: false properties: code: example: parse_error type: string detail: example: Could not decode JSON object type: string required: - code - detail type: object type: array override: type: boolean status: enum: - pending - processing - validated - failed - succeeded type: string required: - status - override - datetime_created - errors type: object id: example: 4abfc726-6a27-4c33-9d99-e5254c8df748 pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$ type: string links: additionalProperties: false properties: self: example: /tmx_async_uploads/4abfc726-6a27-4c33-9d99-e5254c8df748 type: string type: object relationships: additionalProperties: false properties: language: additionalProperties: false properties: data: additionalProperties: false description: Language data container. properties: id: description: Language identifier. example: l:en_US pattern: ^l:[a-zA-Z0-9@_.-]+$ type: string type: enum: - languages type: string required: - type - id type: object links: additionalProperties: false description: Language related link. properties: related: description: Language details link. example: /languages/l:en_US type: string required: - related type: object required: - links - data type: object project: additionalProperties: false properties: data: additionalProperties: false description: Project data container. properties: id: description: Project identifier. example: o:organization_slug:p:project_slug pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+$ type: string type: enum: - projects type: string required: - type - id type: object links: additionalProperties: false description: Project links. properties: related: description: Project details link. example: /projects/o:organization_slug:p:project_slug type: string required: - related type: object required: - links - data type: object required: - project type: object type: enum: - tmx_async_uploads type: string required: - type - id - attributes - relationships - links type: object type: object description: Successful response headers: Location: schema: example: /projects/o:organization_slug:p:project_slug type: string '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '403': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: true properties: code: example: forbidden type: string detail: example: You do not have permissions to perform this action type: string status: example: '403' type: string title: example: Operation not allowed type: string type: object type: array type: object description: Forbidden '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error summary: Get a TMX async upload status tags: - Translation Memory x-released: true summary: Get a TMX async upload status /unique_identifiers/{unique_identifier_id}: parameters: - example: resources:q1iEyY0zNm in: path name: unique_identifier_id required: true schema: type: string summary: Get unique identifier details /users/{user_id}: get: description: Get the details of the user specified by the required path parameter `user_id`. parameters: - description: Format of the user id should be `u:username`. in: path name: user_id required: true schema: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string responses: '200': content: application/vnd.api+json: schema: additionalProperties: false properties: data: allOf: - description: User id. properties: id: description: User identifier. example: u:user_1 pattern: ^u:[\w.-]+$ type: string type: enum: - users type: string required: - type - id type: object - properties: attributes: additionalProperties: false description: User attributes. properties: username: description: The username. example: user_1 type: string required: - username type: object links: additionalProperties: false description: User links. properties: self: description: User details link. example: /users/u:user_1 type: string required: - self type: object required: - attributes - links type: object type: object description: Successful Response. '401': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: unauthorized type: string detail: example: Please verify your credentials type: string status: example: '401' type: string title: example: Unauthorized type: string type: object type: array type: object description: Unauthorized '404': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: properties: code: example: not found type: string detail: example: Object not found. It may have been deleted or not been created yet type: string status: example: '404' type: string title: example: Object not found type: string type: object type: array type: object description: Not found '500': content: application/vnd.api+json: schema: additionalProperties: false properties: errors: items: additionalProperties: false properties: code: example: server error type: string detail: example: Something went wrong, please try again type: string status: example: '500' type: string title: example: Something went wrong type: string type: object type: array type: object description: Internal Error security: - bearerAuth: [] summary: Get the details of a User tags: - Users x-released: true summary: Get the details of a User security: - bearerAuth: [] servers: - url: https://rest.api.transifex.com tags: - description: Represents Transifex's users. name: Users - description: Represents Transifex's organizations. Every user can be a member of one or multiple organizations. Only the organizations the authenticated user belongs to will appear here. name: Organizations - description: Languages objects represent each available language in Transifex. name: Languages - description: Represents projects, as used within Transifex. Each project belongs to an organization. name: Projects - description: 'Project Webhooks lets you specify actions which will trigger some notification event. When that event occurs, Transfex application will make a HTTP request to the URL configured for the webhook (callback_url). The request is done as a HTTP POST request. For example a callback url will be triggered whenever a target language of a resource has fully been translated, enabling the client to implement a custom workflow to pull translations as soon as they are ready, without having to constantly check Transifex for updates. ' name: Project Webhooks - description: Represents a resource that holds source strings. Resources belong to a specific project in Transifex. name: Resources - description: Resource Strings name: Resource Strings - description: "Represents comments on resource strings. These are the same comments\ \ exposed in the Transifex Editor under the \"Comments\" tab.\n\nA comment can\ \ also be flagged as an **issue**. In this case, some extra functionality is available\n\ \ * You can change an issue's status\n * You can change it's category\n * You\ \ can assign a priority\n\nCategories can be configured per organization. To configure\ \ the available categories for your organization, contact\nTransifex Support.\n\nFor further details & examples, take a look below.\n" name: Resource String Comments - description: Internationalization formats supported by Transifex. name: I18n Formats - description: 'Tasks are work items that can be assigned to users within a project. They help organize and track translation work. ' name: Tasks - description: Glossaries name: Glossaries