Figma workspace schemas
These definitions are generated from the downloadable OpenAPI contract. Required fields, validation constraints and additional-property policies are preserved.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
protocol |
number | Yes | — |
challenge |
string | Yes | pattern: "^[\\w-]{43}$" |
{ "type": "object", "properties": { "protocol": { "type": "number", "const": 1 }, "challenge": { "type": "string", "pattern": "^[\\w-]{43}$" } }, "required": [ "protocol", "challenge" ], "additionalProperties": false}Pairing
Section titled “Pairing”| Field | Type | Required | Constraints / description |
|---|---|---|---|
id |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
code |
string | Yes | pattern: "^\\d{6}$" |
readKey |
string | Yes | — |
expiresAt |
string | Yes | format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" |
{ "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "code": { "type": "string", "pattern": "^\\d{6}$" }, "readKey": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "code", "readKey", "expiresAt" ], "additionalProperties": false}PairingStatus
Section titled “PairingStatus”| Field | Type | Required | Constraints / description |
|---|---|---|---|
id |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
expiresAt |
string | Yes | format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" |
approved |
boolean | Yes | — |
{ "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "approved": { "type": "boolean" } }, "required": [ "id", "expiresAt", "approved" ], "additionalProperties": false}Approve
Section titled “Approve”| Field | Type | Required | Constraints / description |
|---|---|---|---|
code |
string | Yes | pattern: "^\\d{6}$" |
scope |
object | Yes | — |
{ "type": "object", "properties": { "code": { "type": "string", "pattern": "^\\d{6}$" }, "scope": { "type": "object", "properties": { "workspace": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "project": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "branch": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "workspace", "project", "branch" ], "additionalProperties": false } }, "required": [ "code", "scope" ], "additionalProperties": false}Redeem
Section titled “Redeem”| Field | Type | Required | Constraints / description |
|---|---|---|---|
readKey |
string | Yes | pattern: "^[\\w-]{43}$" |
verifier |
string | Yes | pattern: "^[A-Za-z0-9_.~-]{43,128}$" |
{ "type": "object", "properties": { "readKey": { "type": "string", "pattern": "^[\\w-]{43}$" }, "verifier": { "type": "string", "pattern": "^[A-Za-z0-9_.~-]{43,128}$" } }, "required": [ "readKey", "verifier" ], "additionalProperties": false}Redemption
Section titled “Redemption”{ "anyOf": [ { "type": "object", "properties": { "state": { "type": "string", "const": "pending" } }, "required": [ "state" ], "additionalProperties": false }, { "type": "object", "properties": { "state": { "type": "string", "const": "connected" }, "token": { "type": "string" }, "connection": { "type": "object", "properties": { "workspace": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "project": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "branch": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "workspace", "project", "branch", "id", "expiresAt" ], "additionalProperties": false } }, "required": [ "state", "token", "connection" ], "additionalProperties": false } ]}Connection
Section titled “Connection”| Field | Type | Required | Constraints / description |
|---|---|---|---|
workspace |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
project |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
branch |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
id |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
expiresAt |
string | Yes | format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" |
{ "type": "object", "properties": { "workspace": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "project": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "branch": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "workspace", "project", "branch", "id", "expiresAt" ], "additionalProperties": false}Connections
Section titled “Connections”{ "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "workspace": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "project": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "branch": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "revokedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "workspace", "project", "branch", "id", "createdAt", "expiresAt", "revokedAt" ], "additionalProperties": false }}Operation
Section titled “Operation”{ "oneOf": [ { "type": "object", "properties": { "operation": { "type": "string", "const": "scope" }, "page": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "pageSize": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "page", "pageSize" ], "additionalProperties": false } }, "required": [ "operation", "page" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "search" }, "locale": { "type": "string", "minLength": 2, "maxLength": 255 }, "q": { "type": "string", "maxLength": 200 }, "page": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "pageSize": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "page", "pageSize" ], "additionalProperties": false } }, "required": [ "operation", "locale", "q", "page" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "resolve" }, "input": { "type": "object", "properties": { "documentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rows": { "minItems": 1, "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "nodeId": { "type": "string", "minLength": 1, "maxLength": 100 }, "nodeName": { "type": "string", "maxLength": 200 }, "locale": { "type": "string", "minLength": 2, "maxLength": 255 }, "text": { "type": "string", "maxLength": 16384 }, "keyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "definition": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\p{L}\\p{N}_.-]+$" }, "format": { "type": "string", "enum": [ "plain", "icu" ] }, "parameters": { "maxItems": 32, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "type": { "type": "string", "enum": [ "text", "number" ] } }, "required": [ "name", "type" ], "additionalProperties": false } } }, "required": [ "name", "format", "parameters" ], "additionalProperties": false }, { "type": "null" } ] }, "bindingId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "bindingVersion": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "resolution": { "anyOf": [ { "type": "string", "enum": [ "design", "server", "skip" ] }, { "type": "null" } ] }, "samples": { "default": {}, "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "number" } ] } }, "rendered": { "default": false, "type": "boolean" } }, "required": [ "nodeId", "nodeName", "locale", "text", "keyId", "definition", "bindingId", "bindingVersion", "resolution", "samples", "rendered" ], "additionalProperties": false } } }, "required": [ "documentId", "rows" ], "additionalProperties": false } }, "required": [ "operation", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "preview" }, "input": { "type": "object", "properties": { "documentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rows": { "minItems": 1, "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "nodeId": { "type": "string", "minLength": 1, "maxLength": 100 }, "nodeName": { "type": "string", "maxLength": 200 }, "locale": { "type": "string", "minLength": 2, "maxLength": 255 }, "text": { "type": "string", "maxLength": 16384 }, "keyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "definition": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\p{L}\\p{N}_.-]+$" }, "format": { "type": "string", "enum": [ "plain", "icu" ] }, "parameters": { "maxItems": 32, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "type": { "type": "string", "enum": [ "text", "number" ] } }, "required": [ "name", "type" ], "additionalProperties": false } } }, "required": [ "name", "format", "parameters" ], "additionalProperties": false }, { "type": "null" } ] }, "bindingId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "bindingVersion": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "resolution": { "anyOf": [ { "type": "string", "enum": [ "design", "server", "skip" ] }, { "type": "null" } ] }, "samples": { "default": {}, "type": "object", "propertyNames": { "type": "string", "maxLength": 100 }, "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "number" } ] } }, "rendered": { "default": false, "type": "boolean" } }, "required": [ "nodeId", "nodeName", "locale", "text", "keyId", "definition", "bindingId", "bindingVersion", "resolution", "samples", "rendered" ], "additionalProperties": false } } }, "required": [ "documentId", "rows" ], "additionalProperties": false }, "direction": { "type": "string", "enum": [ "push", "pull" ] }, "request": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "operation", "input", "direction", "request" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "result" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "operation", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "cancel" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "operation", "id", "version" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "save" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "operation", "id", "version" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "acknowledge" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "applied": { "minItems": 1, "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string", "minLength": 1, "maxLength": 100 }, "to": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "from", "to" ], "additionalProperties": false } } }, "required": [ "operation", "id", "version", "applied" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "key" }, "key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "operation", "key" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "values" }, "key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "page": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "pageSize": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "page", "pageSize" ], "additionalProperties": false } }, "required": [ "operation", "key", "page" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "value.save" }, "key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "locale": { "type": "string", "minLength": 2, "maxLength": 255 }, "keyVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "value": { "anyOf": [ { "type": "string", "maxLength": 16384 }, { "type": "null" } ] } }, "required": [ "operation", "key", "locale", "keyVersion", "version", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "key.update" }, "key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "definition": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[\\p{L}\\p{N}_.-]+$" }, "format": { "type": "string", "enum": [ "plain", "icu" ] }, "parameters": { "maxItems": 32, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "type": { "type": "string", "enum": [ "text", "number" ] } }, "required": [ "name", "type" ], "additionalProperties": false } } }, "required": [ "name", "format", "parameters" ], "additionalProperties": false }, "values": { "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "locale": { "type": "string", "minLength": 2, "maxLength": 255 }, "value": { "anyOf": [ { "type": "string", "maxLength": 16384 }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "locale", "value", "version" ], "additionalProperties": false } } }, "required": [ "operation", "key", "version", "definition", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "review" }, "approve": { "type": "boolean" }, "items": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "keyId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "locale": { "type": "string", "minLength": 2, "maxLength": 255 }, "keyVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "valueVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "evidenceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "sourceLocale": { "type": "string", "minLength": 2, "maxLength": 255 }, "sourceVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "keyId", "locale", "keyVersion", "valueVersion", "evidenceId" ], "additionalProperties": false } }, "request": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "operation", "approve", "items", "request" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "history" }, "key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "page": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "pageSize": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "page", "pageSize" ], "additionalProperties": false } }, "required": [ "operation", "key", "page" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "context" }, "key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "operation", "key" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "context.save" }, "key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "context": { "type": "object", "properties": { "description": { "type": "string" }, "notes": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200 }, "format": { "type": "string", "enum": [ "arb", "apple-xcstrings", "xliff12", "xliff20", "po", "pot", "resx", "android", "apple-strings", "apple-stringsdict", "properties", "yaml", "csv", "xlsx", "xls" ] }, "scope": { "type": "string", "enum": [ "file", "key", "locale", "parameter" ] }, "kind": { "type": "string", "minLength": 1, "maxLength": 100 }, "locale": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 255 }, { "type": "null" } ] }, "parameter": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "text": { "type": "string" }, "attributes": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_.:-]*$" }, "additionalProperties": { "type": "string" } } }, "required": [ "id", "format", "scope", "kind", "locale", "parameter", "text" ], "additionalProperties": false } }, "images": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "alt": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "id", "alt" ], "additionalProperties": false } } }, "required": [ "description", "notes" ], "additionalProperties": false } }, "required": [ "operation", "key", "version", "context" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "suggestions" }, "key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "source": { "type": "string", "minLength": 2, "maxLength": 255 }, "target": { "type": "string", "minLength": 2, "maxLength": 255 } }, "required": [ "operation", "key", "source", "target" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "mentions" }, "page": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "pageSize": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "page", "pageSize" ], "additionalProperties": false } }, "required": [ "operation", "page" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "discussions" }, "key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "page": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "pageSize": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "page", "pageSize" ], "additionalProperties": false } }, "required": [ "operation", "key", "page" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "discussion.create" }, "key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "input": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1 }, "mentions": { "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "locale": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 255 }, { "type": "null" } ] } }, "required": [ "text", "mentions", "locale" ], "additionalProperties": false }, "request": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "operation", "key", "input", "request" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "discussion.resolve" }, "key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "thread": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "resolved": { "type": "boolean" } }, "required": [ "operation", "key", "thread", "version", "resolved" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "comments" }, "key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "thread": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "page": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "pageSize": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "page", "pageSize" ], "additionalProperties": false } }, "required": [ "operation", "key", "thread", "page" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "comment.reply" }, "key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "thread": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "input": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1 }, "mentions": { "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "replyToId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "text", "mentions" ], "additionalProperties": false }, "request": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "operation", "key", "thread", "input", "request" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "comment.edit" }, "key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "thread": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "comment": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "input": { "anyOf": [ { "type": "object", "properties": { "text": { "type": "string", "minLength": 1 }, "mentions": { "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "text", "mentions" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "operation", "key", "thread", "comment", "version", "input" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "comment.history" }, "key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "thread": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "comment": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "page": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "pageSize": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "page", "pageSize" ], "additionalProperties": false } }, "required": [ "operation", "key", "thread", "comment", "page" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "images" }, "key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "operation", "key" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "image.reserve" }, "key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "alt": { "type": "string", "minLength": 1, "maxLength": 500 }, "request": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "operation", "key", "version", "alt", "request" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "providers" }, "page": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "pageSize": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "page", "pageSize" ], "additionalProperties": false } }, "required": [ "operation", "page" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "provider.usage" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "operation", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "assistance.preview" }, "input": { "type": "object", "properties": { "connectionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "context": { "type": "object", "properties": { "description": { "default": true, "type": "boolean" }, "notes": { "default": true, "type": "boolean" }, "glossary": { "default": true, "type": "boolean" }, "memory": { "default": true, "type": "boolean" } }, "required": [ "description", "notes", "glossary", "memory" ], "additionalProperties": false }, "sourceLocale": { "type": "string", "minLength": 1, "maxLength": 100 }, "targetLocales": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "keyIds": { "minItems": 1, "maxItems": 1000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "q": { "default": "", "type": "string", "maxLength": 200 }, "includeTags": { "default": [], "maxItems": 100, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "excludeTags": { "default": [], "maxItems": 100, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "timeField": { "type": "string", "enum": [ "key_created", "source_changed" ] }, "from": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "until": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "timeZone": { "default": "UTC", "type": "string", "maxLength": 100 } }, "required": [ "connectionId", "sourceLocale", "targetLocales", "keyIds", "q", "includeTags", "excludeTags", "timeZone" ], "additionalProperties": false }, "request": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "operation", "input", "request" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "assistance.job" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "operation", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "assistance.items" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "page": { "type": "object", "properties": { "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "pageSize": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "page", "pageSize" ], "additionalProperties": false } }, "required": [ "operation", "id", "page" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "assistance.generate" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "approved": { "type": "boolean", "const": true }, "retry": { "default": false, "type": "boolean" }, "request": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "operation", "id", "version", "approved", "retry", "request" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "assistance.cancel" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "operation", "id", "version" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "assistance.context" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "item": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "selected": { "maxItems": 161, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 220 } } }, "required": [ "operation", "id", "item", "version", "selected" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "assistance.edit" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "item": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "value": { "type": "string", "maxLength": 16384 } }, "required": [ "operation", "id", "item", "version", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "operation": { "type": "string", "const": "assistance.apply" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "approved": { "type": "boolean", "const": true }, "ids": { "minItems": 1, "maxItems": 1000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "request": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "operation", "id", "version", "approved", "ids", "request" ], "additionalProperties": false } ]}Preview
Section titled “Preview”| Field | Type | Required | Constraints / description |
|---|---|---|---|
id |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
state |
ready, completed, cancelled, expired |
Yes | — |
revision |
integer | Yes | maximum: 9007199254740991 |
createdAt |
string | Yes | format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" |
expiresAt |
string | Yes | format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" |
content |
See schema | Yes | — |
result |
See schema | Yes | — |
{ "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "state": { "type": "string", "enum": [ "ready", "completed", "cancelled", "expired" ] }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "content": { "anyOf": [ { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "push", "pull" ] }, "decisions": { "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "nodeId": { "type": "string" }, "locale": { "type": "string" }, "keyId": { "type": "string" }, "name": { "type": "string" }, "bindingId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "bindingVersion": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "before": { "type": [ "string", "null" ] }, "after": { "type": [ "string", "null" ] }, "design": { "type": "string" }, "baseline": { "type": [ "string", "null" ] }, "keyVersion": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "valueVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "action": { "type": "string", "enum": [ "new", "changed", "unchanged", "remote", "skipped", "conflict", "blocked" ] }, "message": { "type": [ "string", "null" ] }, "bind": { "type": "boolean" }, "display": { "type": [ "string", "null" ] }, "rendered": { "type": "boolean" } }, "required": [ "nodeId", "locale", "keyId", "name", "bindingId", "bindingVersion", "before", "after", "design", "baseline", "keyVersion", "valueVersion", "action", "message", "bind", "display", "rendered" ], "additionalProperties": false } } }, "required": [ "direction", "decisions" ], "additionalProperties": false }, { "type": "null" } ] }, "result": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "keyId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "locale": { "type": "string" }, "documentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "nodeId": { "type": "string" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "value": { "type": [ "string", "null" ] }, "valueVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "keyVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "keyId", "locale", "documentId", "nodeId", "version", "value", "valueVersion", "keyVersion" ], "additionalProperties": false } }, { "type": "null" } ] } }, "required": [ "id", "state", "revision", "createdAt", "expiresAt", "content", "result" ], "additionalProperties": false}Binding
Section titled “Binding”| Field | Type | Required | Constraints / description |
|---|---|---|---|
id |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
keyId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
locale |
string | Yes | — |
documentId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
nodeId |
string | Yes | — |
version |
integer | Yes | maximum: 9007199254740991 |
value |
string or null | Yes | — |
valueVersion |
integer | Yes | minimum: 0; maximum: 9007199254740991 |
keyVersion |
integer | Yes | maximum: 9007199254740991 |
{ "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "keyId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "locale": { "type": "string" }, "documentId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "nodeId": { "type": "string" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "value": { "type": [ "string", "null" ] }, "valueVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "keyVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "keyId", "locale", "documentId", "nodeId", "version", "value", "valueVersion", "keyVersion" ], "additionalProperties": false}Success
Section titled “Success”| Field | Type | Required | Constraints / description |
|---|---|---|---|
success |
boolean | Yes | — |
{ "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false}Mentions
Section titled “Mentions”| Field | Type | Required | Constraints / description |
|---|---|---|---|
items |
Array of object | Yes | — |
page |
integer | Yes | maximum: 9007199254740991 |
pageSize |
integer | Yes | maximum: 9007199254740991 |
hasMore |
boolean | Yes | — |
{ "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": false } }, "page": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "hasMore": { "type": "boolean" } }, "required": [ "items", "page", "pageSize", "hasMore" ], "additionalProperties": false}SafeProviders
Section titled “SafeProviders”| Field | Type | Required | Constraints / description |
|---|---|---|---|
items |
Array of object | Yes | — |
page |
integer | Yes | maximum: 9007199254740991 |
pageSize |
integer | Yes | maximum: 9007199254740991 |
hasMore |
boolean | Yes | — |
{ "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" }, "provider": { "type": "string", "enum": [ "openai", "gemini", "google", "deepl" ] }, "model": { "type": "string" }, "account": { "anyOf": [ { "type": "string", "enum": [ "free", "pro" ] }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "limits": { "type": "object", "properties": { "dailyJobs": { "type": "integer", "minimum": 1, "maximum": 10000 }, "dailyCalls": { "type": "integer", "minimum": 1, "maximum": 100000 }, "dailyUnits": { "type": "integer", "minimum": 1, "maximum": 1000000000 }, "jobUnits": { "type": "integer", "minimum": 1, "maximum": 1000000000 }, "outputTokens": { "type": "integer", "minimum": 256, "maximum": 32768 } }, "required": [ "dailyJobs", "dailyCalls", "dailyUnits", "jobUnits", "outputTokens" ], "additionalProperties": false } }, "required": [ "id", "name", "provider", "model", "account", "enabled", "limits" ], "additionalProperties": false } }, "page": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "hasMore": { "type": "boolean" } }, "required": [ "items", "page", "pageSize", "hasMore" ], "additionalProperties": false}| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
requestId |
string | No | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
{ "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "error", "message" ], "additionalProperties": false}TTranslationKey
Section titled “TTranslationKey”| Field | Type | Required | Constraints / description |
|---|---|---|---|
name |
string | Yes | Case-sensitive letters, digits, underscore, hyphen or period. Unique in the project, including archived keys.; minLength: 1; maxLength: 200 |
format |
plain, icu |
Yes | default: "plain" |
parameters |
Array of object | Yes | maxItems: 32; default: [] |
id |
string | Yes | format: "uuid" |
workspaceId |
string | Yes | format: "uuid" |
projectId |
string | Yes | format: "uuid" |
version |
integer | Yes | minimum: 1; maximum: 2147483646 |
archivedAt |
string or null | Yes | format: "date-time" |
createdAt |
string | Yes | format: "date-time" |
tags |
Array of object | No | maxItems: 20 |
{ "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "description": "Case-sensitive letters, digits, underscore, hyphen or period. Unique in the project, including archived keys." }, "format": { "type": "string", "enum": [ "plain", "icu" ], "default": "plain" }, "parameters": { "type": "array", "maxItems": 32, "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$", "maxLength": 100 }, "type": { "type": "string", "enum": [ "text", "number" ] } }, "required": [ "name", "type" ] }, "default": [] }, "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "minimum": 1, "maximum": 2147483646 }, "archivedAt": { "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "tags": { "type": "array", "maxItems": 20, "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "required": [ "name", "format", "parameters", "id", "workspaceId", "projectId", "version", "archivedAt", "createdAt" ]}TTranslationValue
Section titled “TTranslationValue”| Field | Type | Required | Constraints / description |
|---|---|---|---|
keyId |
string | Yes | format: "uuid" |
locale |
string | Yes | minLength: 2; maxLength: 255 |
value |
string or null | Yes | At most 16 KiB UTF-8. Null, empty or whitespace-only becomes Missing; other whitespace is preserved.; maxLength: 16384 |
version |
integer | Yes | Zero means no stored value yet. Clearing a stored value increments its version.; minimum: 0 |
evidenceId |
string or null | No | Current review evidence, included in matrix cells; null means Unreviewed.; format: "uuid" |
{ "type": "object", "additionalProperties": false, "properties": { "keyId": { "type": "string", "format": "uuid" }, "locale": { "type": "string", "minLength": 2, "maxLength": 255 }, "value": { "type": [ "string", "null" ], "maxLength": 16384, "description": "At most 16 KiB UTF-8. Null, empty or whitespace-only becomes Missing; other whitespace is preserved." }, "version": { "type": "integer", "minimum": 0, "description": "Zero means no stored value yet. Clearing a stored value increments its version." }, "evidenceId": { "type": [ "string", "null" ], "format": "uuid", "description": "Current review evidence, included in matrix cells; null means Unreviewed." } }, "required": [ "keyId", "locale", "value", "version" ]}TTablePage
Section titled “TTablePage”Schema reference: TTranslationValue.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
items |
Array of object | Yes | — |
page |
integer | Yes | minimum: 1 |
pageSize |
integer | Yes | minimum: 1; maximum: 100 |
hasMore |
boolean | Yes | — |
languageCoverage |
Array of object | Yes | Saved direct translation and valid review counts for every requested locale across all active keys in the explicit branch. Search, tags, key status, value/review filters and pagination do not affect these counts. Archived keys, fallback values and unsaved drafts are excluded. Inactive languages are included when requested. With no active keys, all counts are zero. Review coverage uses translated as its denominator.; maxItems: 5 |
canEditShared |
boolean | Yes | — |
permissions |
Array of object | Yes | maxItems: 5 |
{ "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200, "description": "Case-sensitive letters, digits, underscore, hyphen or period. Unique in the project, including archived keys." }, "format": { "type": "string", "enum": [ "plain", "icu" ], "default": "plain" }, "parameters": { "type": "array", "maxItems": 32, "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$", "maxLength": 100 }, "type": { "type": "string", "enum": [ "text", "number" ] } }, "required": [ "name", "type" ] }, "default": [] }, "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "minimum": 1, "maximum": 2147483646 }, "archivedAt": { "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "values": { "type": "array", "maxItems": 5, "items": { "$ref": "#/components/schemas/TTranslationValue" } }, "coverage": { "type": "object", "additionalProperties": false, "description": "Direct translation coverage across all configured languages in the selected branch, including inactive and undisplayed languages. Missing and fallback values do not count. translated never exceeds total. activeTranslated counts only non-Missing direct values in active languages, including undisplayed columns; it determines whether a Missing cell has a usable assistance source. Existing translated/total coverage still includes inactive languages.", "properties": { "translated": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 1 }, "activeTranslated": { "type": "integer", "minimum": 0 } }, "required": [ "translated", "total", "activeTranslated" ] } }, "required": [ "name", "format", "parameters", "id", "workspaceId", "projectId", "version", "archivedAt", "createdAt", "values", "coverage" ] } }, "page": { "type": "integer", "minimum": 1 }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100 }, "hasMore": { "type": "boolean" }, "languageCoverage": { "type": "array", "maxItems": 5, "description": "Saved direct translation and valid review counts for every requested locale across all active keys in the explicit branch. Search, tags, key status, value/review filters and pagination do not affect these counts. Archived keys, fallback values and unsaved drafts are excluded. Inactive languages are included when requested. With no active keys, all counts are zero. Review coverage uses translated as its denominator.", "items": { "type": "object", "additionalProperties": false, "properties": { "locale": { "type": "string" }, "translated": { "type": "integer", "minimum": 0, "description": "Never exceeds total." }, "total": { "type": "integer", "minimum": 0 }, "reviewed": { "type": "integer", "minimum": 0, "description": "Nonempty saved values with unrevoked evidence matching their current text and ICU contract revisions. Never exceeds translated; translated never exceeds total." } }, "required": [ "locale", "translated", "total", "reviewed" ] } }, "canEditShared": { "type": "boolean" }, "permissions": { "type": "array", "maxItems": 5, "items": { "type": "object", "additionalProperties": false, "properties": { "locale": { "type": "string" }, "write": { "type": "boolean" }, "review": { "type": "boolean" } }, "required": [ "locale", "write", "review" ] } } }, "required": [ "items", "page", "pageSize", "hasMore", "languageCoverage", "canEditShared", "permissions" ]}TValuesPage
Section titled “TValuesPage”| Field | Type | Required | Constraints / description |
|---|---|---|---|
items |
Array of object | Yes | — |
page |
integer | Yes | minimum: 1 |
pageSize |
integer | Yes | minimum: 1; maximum: 100 |
hasMore |
boolean | Yes | — |
{ "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "keyId": { "type": "string", "format": "uuid" }, "locale": { "type": "string", "minLength": 2, "maxLength": 255 }, "value": { "type": [ "string", "null" ], "maxLength": 16384, "description": "At most 16 KiB UTF-8. Null, empty or whitespace-only becomes Missing; other whitespace is preserved." }, "version": { "type": "integer", "minimum": 0, "description": "Zero means no stored value yet. Clearing a stored value increments its version." }, "active": { "type": "boolean" }, "writable": { "type": "boolean", "description": "Effective language write permission and active status." } }, "required": [ "keyId", "locale", "value", "version", "active", "writable" ] } }, "page": { "type": "integer", "minimum": 1 }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100 }, "hasMore": { "type": "boolean" } }, "required": [ "items", "page", "pageSize", "hasMore" ]}THistoryPage
Section titled “THistoryPage”| Field | Type | Required | Constraints / description |
|---|---|---|---|
items |
Array of object | Yes | — |
page |
integer | Yes | minimum: 1 |
pageSize |
integer | Yes | minimum: 1; maximum: 100 |
hasMore |
boolean | Yes | — |
{ "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "actorId": { "type": "string", "format": "uuid" }, "actorEmail": { "type": "string" }, "action": { "type": "string", "description": "Original translation/tag action or branch.merge.metadata, branch.merge.value and branch.merge.binding." }, "locale": { "type": [ "string", "null" ] }, "before": { "description": "Previous key definition, archived flag or value snapshot. Null for creation." }, "after": { "description": "Next key definition, archived flag or value snapshot." }, "createdAt": { "type": "string", "format": "date-time" }, "branchId": { "type": "string", "format": "uuid" }, "branchName": { "type": "string" }, "inherited": { "type": "boolean", "description": "Original event belongs to an ancestor or merged branch; it is not a fabricated local edit." } }, "required": [ "id", "actorId", "actorEmail", "action", "locale", "before", "after", "createdAt", "branchId", "branchName", "inherited" ] } }, "page": { "type": "integer", "minimum": 1 }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100 }, "hasMore": { "type": "boolean" } }, "required": [ "items", "page", "pageSize", "hasMore" ]}WImage
Section titled “WImage”| Field | Type | Required | Constraints / description |
|---|---|---|---|
id |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
state |
reserved, uploading, queued, processing, ready, failed, deleting |
Yes | — |
width |
See schema | Yes | — |
height |
See schema | Yes | — |
size |
integer | Yes | minimum: 0; maximum: 9007199254740991 |
hash |
string or null | Yes | — |
alt |
string | Yes | — |
code |
string or null | Yes | — |
{ "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "state": { "type": "string", "enum": [ "reserved", "uploading", "queued", "processing", "ready", "failed", "deleting" ] }, "width": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "height": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "size": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hash": { "type": [ "string", "null" ] }, "alt": { "type": "string" }, "code": { "type": [ "string", "null" ] } }, "required": [ "id", "state", "width", "height", "size", "hash", "alt", "code" ], "additionalProperties": false}WImages
Section titled “WImages”| Field | Type | Required | Constraints / description |
|---|---|---|---|
images |
Array of object | Yes | maxItems: 30 |
quota |
integer | Yes | minimum: 0; maximum: 9007199254740991 |
used |
integer | Yes | minimum: 0; maximum: 9007199254740991 |
reserved |
integer | Yes | minimum: 0; maximum: 9007199254740991 |
version |
integer | Yes | maximum: 2147483646 |
{ "type": "object", "properties": { "images": { "maxItems": 30, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "state": { "type": "string", "enum": [ "reserved", "uploading", "queued", "processing", "ready", "failed", "deleting" ] }, "width": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "height": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "size": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hash": { "type": [ "string", "null" ] }, "alt": { "type": "string" }, "code": { "type": [ "string", "null" ] } }, "required": [ "id", "state", "width", "height", "size", "hash", "alt", "code" ], "additionalProperties": false } }, "quota": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "used": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "reserved": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2147483646 } }, "required": [ "images", "quota", "used", "reserved", "version" ], "additionalProperties": false}WImageQueued
Section titled “WImageQueued”| Field | Type | Required | Constraints / description |
|---|---|---|---|
id |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
state |
string | Yes | — |
{ "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "state": { "type": "string", "const": "queued" } }, "required": [ "id", "state" ], "additionalProperties": false}WImageUpload
Section titled “WImageUpload”| Field | Type | Required | Constraints / description |
|---|---|---|---|
file |
string | Yes | — |
{ "type": "object", "properties": { "file": { "type": "string" } }, "required": [ "file" ], "additionalProperties": false}WDiscussionThread
Section titled “WDiscussionThread”| Field | Type | Required | Constraints / description |
|---|---|---|---|
id |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
locale |
See schema | Yes | — |
authorId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
resolved |
boolean | Yes | — |
version |
integer | Yes | maximum: 2147483646 |
createdAt |
string | Yes | format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" |
canResolve |
boolean | Yes | — |
{ "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "locale": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 255 }, { "type": "null" } ] }, "authorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "resolved": { "type": "boolean" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2147483646 }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "canResolve": { "type": "boolean" } }, "required": [ "id", "locale", "authorId", "resolved", "version", "createdAt", "canResolve" ], "additionalProperties": false}WDiscussionThreads
Section titled “WDiscussionThreads”| Field | Type | Required | Constraints / description |
|---|---|---|---|
items |
Array of object | Yes | maxItems: 100 |
page |
integer | Yes | maximum: 2147483646 |
pageSize |
integer | Yes | minimum: 1; maximum: 100 |
hasMore |
boolean | Yes | — |
{ "type": "object", "properties": { "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "locale": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 255 }, { "type": "null" } ] }, "authorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "resolved": { "type": "boolean" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2147483646 }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "canResolve": { "type": "boolean" } }, "required": [ "id", "locale", "authorId", "resolved", "version", "createdAt", "canResolve" ], "additionalProperties": false } }, "page": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2147483646 }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100 }, "hasMore": { "type": "boolean" } }, "required": [ "items", "page", "pageSize", "hasMore" ], "additionalProperties": false}WDiscussionComment
Section titled “WDiscussionComment”| Field | Type | Required | Constraints / description |
|---|---|---|---|
id |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
threadId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
replyToId |
See schema | Yes | — |
authorId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
authorLabel |
string or null | Yes | — |
text |
string or null | Yes | — |
mentions |
Array of string | Yes | maxItems: 20 |
version |
integer | Yes | maximum: 2147483646 |
createdAt |
string | Yes | format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" |
updatedAt |
string | Yes | format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" |
removedAt |
See schema | Yes | — |
canEdit |
boolean | Yes | — |
{ "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "threadId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "replyToId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "authorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "authorLabel": { "type": [ "string", "null" ] }, "text": { "type": [ "string", "null" ] }, "mentions": { "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2147483646 }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "removedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "canEdit": { "type": "boolean" } }, "required": [ "id", "threadId", "replyToId", "authorId", "authorLabel", "text", "mentions", "version", "createdAt", "updatedAt", "removedAt", "canEdit" ], "additionalProperties": false}WDiscussionComments
Section titled “WDiscussionComments”| Field | Type | Required | Constraints / description |
|---|---|---|---|
items |
Array of object | Yes | maxItems: 100 |
page |
integer | Yes | maximum: 2147483646 |
pageSize |
integer | Yes | minimum: 1; maximum: 100 |
hasMore |
boolean | Yes | — |
{ "type": "object", "properties": { "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "threadId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "replyToId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "authorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "authorLabel": { "type": [ "string", "null" ] }, "text": { "type": [ "string", "null" ] }, "mentions": { "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2147483646 }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "removedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "canEdit": { "type": "boolean" } }, "required": [ "id", "threadId", "replyToId", "authorId", "authorLabel", "text", "mentions", "version", "createdAt", "updatedAt", "removedAt", "canEdit" ], "additionalProperties": false } }, "page": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2147483646 }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100 }, "hasMore": { "type": "boolean" } }, "required": [ "items", "page", "pageSize", "hasMore" ], "additionalProperties": false}WDiscussionHistory
Section titled “WDiscussionHistory”| Field | Type | Required | Constraints / description |
|---|---|---|---|
items |
Array of object | Yes | maxItems: 100 |
page |
integer | Yes | maximum: 2147483646 |
pageSize |
integer | Yes | minimum: 1; maximum: 100 |
hasMore |
boolean | Yes | — |
{ "type": "object", "properties": { "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2147483646 }, "text": { "type": [ "string", "null" ] }, "mentions": { "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "actorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "changedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "removed": { "type": "boolean" } }, "required": [ "version", "text", "mentions", "actorId", "changedAt", "removed" ], "additionalProperties": false } }, "page": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2147483646 }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100 }, "hasMore": { "type": "boolean" } }, "required": [ "items", "page", "pageSize", "hasMore" ], "additionalProperties": false}WReviewResult
Section titled “WReviewResult”| Field | Type | Required | Constraints / description |
|---|---|---|---|
items |
Array of object | Yes | — |
{ "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "keyId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "locale": { "type": "string", "minLength": 2, "maxLength": 255 }, "evidenceId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "keyId", "locale", "evidenceId" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false}WContext
Section titled “WContext”| Field | Type | Required | Constraints / description |
|---|---|---|---|
description |
string | Yes | — |
notes |
Array of object | Yes | maxItems: 100 |
images |
Array of object | No | maxItems: 10 |
version |
integer | Yes | maximum: 2147483646 |
{ "type": "object", "properties": { "description": { "type": "string" }, "notes": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200 }, "format": { "type": "string", "enum": [ "arb", "apple-xcstrings", "xliff12", "xliff20", "po", "pot", "resx", "android", "apple-strings", "apple-stringsdict", "properties", "yaml", "csv", "xlsx", "xls" ] }, "scope": { "type": "string", "enum": [ "file", "key", "locale", "parameter" ] }, "kind": { "type": "string", "minLength": 1, "maxLength": 100 }, "locale": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 255 }, { "type": "null" } ] }, "parameter": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "text": { "type": "string" }, "attributes": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_.:-]*$" }, "additionalProperties": { "type": "string" } } }, "required": [ "id", "format", "scope", "kind", "locale", "parameter", "text" ], "additionalProperties": false } }, "images": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "alt": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "id", "alt" ], "additionalProperties": false } }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2147483646 } }, "required": [ "description", "notes", "version" ], "additionalProperties": false}WSuggestions
Section titled “WSuggestions”| Field | Type | Required | Constraints / description |
|---|---|---|---|
memories |
Array of object | Yes | maxItems: 25 |
glossaries |
Array of object | Yes | maxItems: 25 |
{ "type": "object", "properties": { "memories": { "maxItems": 25, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2147483646 }, "content": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "memory" }, "sourceLocale": { "type": "string", "minLength": 2, "maxLength": 255 }, "targetLocale": { "type": "string", "minLength": 2, "maxLength": 255 }, "source": { "type": "string" }, "target": { "type": "string" }, "format": { "type": "string", "enum": [ "plain", "icu" ] }, "parameters": { "maxItems": 32, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "type": { "type": "string", "enum": [ "text", "number" ] } }, "required": [ "name", "type" ], "additionalProperties": false } } }, "required": [ "kind", "sourceLocale", "targetLocale", "source", "target", "format", "parameters" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "glossary" }, "concept": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string" }, "terms": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "locale": { "type": "string", "minLength": 2, "maxLength": 255 }, "preferred": { "type": "string" }, "alternatives": { "maxItems": 20, "type": "array", "items": { "type": "string" } }, "caseSensitive": { "type": "boolean" }, "doNotTranslate": { "type": "boolean" } }, "required": [ "locale", "preferred", "alternatives", "caseSensitive", "doNotTranslate" ], "additionalProperties": false } } }, "required": [ "kind", "concept", "description", "terms" ], "additionalProperties": false } ] }, "origin": { "type": "string", "enum": [ "manual", "review" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "match": { "type": "string", "enum": [ "exact", "similar" ] }, "similarity": { "type": "number" } }, "required": [ "id", "version", "content", "origin", "createdAt", "match", "similarity" ], "additionalProperties": false } }, "glossaries": { "maxItems": 25, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2147483646 }, "content": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "memory" }, "sourceLocale": { "type": "string", "minLength": 2, "maxLength": 255 }, "targetLocale": { "type": "string", "minLength": 2, "maxLength": 255 }, "source": { "type": "string" }, "target": { "type": "string" }, "format": { "type": "string", "enum": [ "plain", "icu" ] }, "parameters": { "maxItems": 32, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "type": { "type": "string", "enum": [ "text", "number" ] } }, "required": [ "name", "type" ], "additionalProperties": false } } }, "required": [ "kind", "sourceLocale", "targetLocale", "source", "target", "format", "parameters" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "glossary" }, "concept": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string" }, "terms": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "locale": { "type": "string", "minLength": 2, "maxLength": 255 }, "preferred": { "type": "string" }, "alternatives": { "maxItems": 20, "type": "array", "items": { "type": "string" } }, "caseSensitive": { "type": "boolean" }, "doNotTranslate": { "type": "boolean" } }, "required": [ "locale", "preferred", "alternatives", "caseSensitive", "doNotTranslate" ], "additionalProperties": false } } }, "required": [ "kind", "concept", "description", "terms" ], "additionalProperties": false } ] }, "origin": { "type": "string", "enum": [ "manual", "review" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "version", "content", "origin", "createdAt" ], "additionalProperties": false } } }, "required": [ "memories", "glossaries" ], "additionalProperties": false}AUsage
Section titled “AUsage”| Field | Type | Required | Constraints / description |
|---|---|---|---|
jobs |
number | Yes | — |
calls |
number | Yes | — |
reserved |
number | Yes | — |
actual |
number | Yes | — |
unknown |
number | Yes | — |
limits |
object | Yes | — |
{ "type": "object", "properties": { "jobs": { "type": "number" }, "calls": { "type": "number" }, "reserved": { "type": "number" }, "actual": { "type": "number" }, "unknown": { "type": "number" }, "limits": { "type": "object", "properties": { "dailyJobs": { "type": "integer", "minimum": 1, "maximum": 10000 }, "dailyCalls": { "type": "integer", "minimum": 1, "maximum": 100000 }, "dailyUnits": { "type": "integer", "minimum": 1, "maximum": 1000000000 }, "jobUnits": { "type": "integer", "minimum": 1, "maximum": 1000000000 }, "outputTokens": { "type": "integer", "minimum": 256, "maximum": 32768 } }, "required": [ "dailyJobs", "dailyCalls", "dailyUnits", "jobUnits", "outputTokens" ], "additionalProperties": false } }, "required": [ "jobs", "calls", "reserved", "actual", "unknown", "limits" ]}| Field | Type | Required | Constraints / description |
|---|---|---|---|
id |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
workspaceId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
projectId |
See schema | Yes | — |
branchId |
See schema | Yes | — |
actorId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
connectionId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
connectionVersion |
integer | Yes | maximum: 9007199254740991 |
secretVersion |
integer | Yes | maximum: 9007199254740991 |
provider |
openai, gemini, google, deepl |
Yes | — |
model |
string | Yes | — |
kind |
test, translation |
Yes | — |
state |
preview, queued, generating, review, partial, outcome_unknown, cancelled, expired, completed, failed, conflict, limited |
Yes | — |
version |
integer | Yes | maximum: 9007199254740991 |
sourceLocale |
string | Yes | — |
options |
See schema | Yes | — |
summary |
object | Yes | — |
errorCode |
string or null | Yes | — |
reservedUnits |
number | Yes | — |
actualUnits |
number | Yes | — |
unknownUnits |
number | Yes | — |
createdAt |
string | Yes | format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" |
expiresAt |
string | Yes | format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" |
{ "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workspaceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "branchId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "actorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "connectionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "connectionVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "secretVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "provider": { "type": "string", "enum": [ "openai", "gemini", "google", "deepl" ] }, "model": { "type": "string" }, "kind": { "type": "string", "enum": [ "test", "translation" ] }, "state": { "type": "string", "enum": [ "preview", "queued", "generating", "review", "partial", "outcome_unknown", "cancelled", "expired", "completed", "failed", "conflict", "limited" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "sourceLocale": { "type": "string" }, "options": { "anyOf": [ { "type": "object", "properties": { "connectionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "context": { "type": "object", "properties": { "description": { "default": true, "type": "boolean" }, "notes": { "default": true, "type": "boolean" }, "glossary": { "default": true, "type": "boolean" }, "memory": { "default": true, "type": "boolean" } }, "additionalProperties": false }, "sourceLocale": { "type": "string", "minLength": 1, "maxLength": 100 }, "targetLocales": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "keyIds": { "maxItems": 10000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "q": { "default": "", "type": "string", "maxLength": 200 }, "includeTags": { "default": [], "maxItems": 100, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "excludeTags": { "default": [], "maxItems": 100, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "timeField": { "type": "string", "enum": [ "key_created", "source_changed" ] }, "from": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "until": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "timeZone": { "default": "UTC", "type": "string", "maxLength": 100 } }, "required": [ "connectionId", "sourceLocale", "targetLocales" ], "additionalProperties": false }, { "type": "null" } ] }, "summary": { "type": "object", "properties": { "keys": { "type": "number" }, "cells": { "type": "number" }, "filled": { "type": "number" }, "missingSource": { "type": "number" }, "unknownDate": { "type": "number" }, "incompatible": { "type": "number" }, "estimatedUnits": { "type": "number" } }, "required": [ "keys", "cells", "filled", "missingSource", "unknownDate", "incompatible", "estimatedUnits" ] }, "errorCode": { "type": [ "string", "null" ] }, "reservedUnits": { "type": "number" }, "actualUnits": { "type": "number" }, "unknownUnits": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "workspaceId", "projectId", "branchId", "actorId", "connectionId", "connectionVersion", "secretVersion", "provider", "model", "kind", "state", "version", "sourceLocale", "options", "summary", "errorCode", "reservedUnits", "actualUnits", "unknownUnits", "createdAt", "expiresAt" ]}ASuggestion
Section titled “ASuggestion”| Field | Type | Required | Constraints / description |
|---|---|---|---|
context |
Array of object | Yes | maxItems: 161 |
id |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
jobId |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
keyId |
See schema | Yes | — |
definition |
object | Yes | — |
keyVersion |
number | Yes | — |
sourceVersion |
number | Yes | — |
targetVersion |
number | Yes | — |
source |
string | Yes | — |
sourceLocale |
string | Yes | — |
locale |
string | Yes | — |
suggestion |
string or null | Yes | — |
state |
pending, sending, ready, invalid, unknown, applied |
Yes | — |
issue |
string or null | Yes | — |
version |
integer | Yes | maximum: 9007199254740991 |
current |
See schema | No | — |
{ "type": "object", "properties": { "context": { "maxItems": 161, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 220 }, "kind": { "type": "string", "enum": [ "description", "note", "glossary", "memory", "image" ] }, "selected": { "type": "boolean" }, "text": { "type": "string", "maxLength": 1000000 }, "image": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "size": { "type": "integer", "exclusiveMinimum": 0, "maximum": 10485760 }, "hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "width": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "height": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "resolution": { "type": "string", "const": "high" } }, "required": [ "id", "size", "hash", "width", "height", "resolution" ], "additionalProperties": false }, "reference": { "anyOf": [ { "type": "object", "properties": { "entryId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "entryVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "resourceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "resourceVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "linksVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "entryId", "entryVersion", "resourceId", "resourceVersion", "linksVersion" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "kind", "selected", "text", "reference" ], "additionalProperties": false } }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "jobId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "keyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "definition": { "type": "object", "properties": { "name": { "type": "string" }, "format": { "type": "string", "enum": [ "plain", "icu" ] }, "parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "number" ] } }, "required": [ "name", "type" ] } } }, "required": [ "name", "format", "parameters" ] }, "keyVersion": { "type": "number" }, "sourceVersion": { "type": "number" }, "targetVersion": { "type": "number" }, "source": { "type": "string" }, "sourceLocale": { "type": "string" }, "locale": { "type": "string" }, "suggestion": { "type": [ "string", "null" ] }, "state": { "type": "string", "enum": [ "pending", "sending", "ready", "invalid", "unknown", "applied" ] }, "issue": { "type": [ "string", "null" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "current": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" }, "keyVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": [ "string", "null" ] }, "target": { "type": [ "string", "null" ] }, "sourceVersion": { "type": "number" }, "targetVersion": { "type": "number" }, "editable": { "type": "boolean" } }, "required": [ "name", "keyVersion", "source", "target", "sourceVersion", "targetVersion", "editable" ] }, { "type": "null" } ] } }, "required": [ "context", "id", "jobId", "keyId", "definition", "keyVersion", "sourceVersion", "targetVersion", "source", "sourceLocale", "locale", "suggestion", "state", "issue", "version" ]}ASuggestionPage
Section titled “ASuggestionPage”| Field | Type | Required | Constraints / description |
|---|---|---|---|
items |
Array of object | Yes | — |
page |
integer | Yes | maximum: 9007199254740991 |
pageSize |
integer | Yes | minimum: 1; maximum: 100 |
hasMore |
boolean | Yes | — |
{ "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "context": { "maxItems": 161, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 220 }, "kind": { "type": "string", "enum": [ "description", "note", "glossary", "memory", "image" ] }, "selected": { "type": "boolean" }, "text": { "type": "string", "maxLength": 1000000 }, "image": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "size": { "type": "integer", "exclusiveMinimum": 0, "maximum": 10485760 }, "hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "width": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "height": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "resolution": { "type": "string", "const": "high" } }, "required": [ "id", "size", "hash", "width", "height", "resolution" ], "additionalProperties": false }, "reference": { "anyOf": [ { "type": "object", "properties": { "entryId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "entryVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "resourceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "resourceVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "linksVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "entryId", "entryVersion", "resourceId", "resourceVersion", "linksVersion" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "kind", "selected", "text", "reference" ], "additionalProperties": false } }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "jobId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "keyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "definition": { "type": "object", "properties": { "name": { "type": "string" }, "format": { "type": "string", "enum": [ "plain", "icu" ] }, "parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "number" ] } }, "required": [ "name", "type" ] } } }, "required": [ "name", "format", "parameters" ] }, "keyVersion": { "type": "number" }, "sourceVersion": { "type": "number" }, "targetVersion": { "type": "number" }, "source": { "type": "string" }, "sourceLocale": { "type": "string" }, "locale": { "type": "string" }, "suggestion": { "type": [ "string", "null" ] }, "state": { "type": "string", "enum": [ "pending", "sending", "ready", "invalid", "unknown", "applied" ] }, "issue": { "type": [ "string", "null" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "current": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" }, "keyVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "source": { "type": [ "string", "null" ] }, "target": { "type": [ "string", "null" ] }, "sourceVersion": { "type": "number" }, "targetVersion": { "type": "number" }, "editable": { "type": "boolean" } }, "required": [ "name", "keyVersion", "source", "target", "sourceVersion", "targetVersion", "editable" ] }, { "type": "null" } ] } }, "required": [ "context", "id", "jobId", "keyId", "definition", "keyVersion", "sourceVersion", "targetVersion", "source", "sourceLocale", "locale", "suggestion", "state", "issue", "version" ] } }, "page": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100 }, "hasMore": { "type": "boolean" } }, "required": [ "items", "page", "pageSize", "hasMore" ]}AApplyResult
Section titled “AApplyResult”| Field | Type | Required | Constraints / description |
|---|---|---|---|
job |
object | Yes | — |
applied |
integer | Yes | maximum: 9007199254740991 |
{ "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "workspaceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "branchId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "actorId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "connectionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "connectionVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "secretVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "provider": { "type": "string", "enum": [ "openai", "gemini", "google", "deepl" ] }, "model": { "type": "string" }, "kind": { "type": "string", "enum": [ "test", "translation" ] }, "state": { "type": "string", "enum": [ "preview", "queued", "generating", "review", "partial", "outcome_unknown", "cancelled", "expired", "completed", "failed", "conflict", "limited" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "sourceLocale": { "type": "string" }, "options": { "anyOf": [ { "type": "object", "properties": { "connectionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "context": { "type": "object", "properties": { "description": { "default": true, "type": "boolean" }, "notes": { "default": true, "type": "boolean" }, "glossary": { "default": true, "type": "boolean" }, "memory": { "default": true, "type": "boolean" } }, "additionalProperties": false }, "sourceLocale": { "type": "string", "minLength": 1, "maxLength": 100 }, "targetLocales": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "keyIds": { "maxItems": 10000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "q": { "default": "", "type": "string", "maxLength": 200 }, "includeTags": { "default": [], "maxItems": 100, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "excludeTags": { "default": [], "maxItems": 100, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "timeField": { "type": "string", "enum": [ "key_created", "source_changed" ] }, "from": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "until": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "timeZone": { "default": "UTC", "type": "string", "maxLength": 100 } }, "required": [ "connectionId", "sourceLocale", "targetLocales" ], "additionalProperties": false }, { "type": "null" } ] }, "summary": { "type": "object", "properties": { "keys": { "type": "number" }, "cells": { "type": "number" }, "filled": { "type": "number" }, "missingSource": { "type": "number" }, "unknownDate": { "type": "number" }, "incompatible": { "type": "number" }, "estimatedUnits": { "type": "number" } }, "required": [ "keys", "cells", "filled", "missingSource", "unknownDate", "incompatible", "estimatedUnits" ] }, "errorCode": { "type": [ "string", "null" ] }, "reservedUnits": { "type": "number" }, "actualUnits": { "type": "number" }, "unknownUnits": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "workspaceId", "projectId", "branchId", "actorId", "connectionId", "connectionVersion", "secretVersion", "provider", "model", "kind", "state", "version", "sourceLocale", "options", "summary", "errorCode", "reservedUnits", "actualUnits", "unknownUnits", "createdAt", "expiresAt" ] }, "applied": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "job", "applied" ]}PProject
Section titled “PProject”| Field | Type | Required | Constraints / description |
|---|---|---|---|
id |
string | Yes | format: "uuid" |
workspaceId |
string | Yes | format: "uuid" |
name |
string | Yes | Trimmed; control characters are rejected. Names need not be unique.; minLength: 1; maxLength: 100 |
sourceLocale |
string | Yes | minLength: 2; maxLength: 255 |
version |
integer | Yes | minimum: 1 |
archivedAt |
string or null | Yes | format: "date-time" |
createdAt |
string | Yes | format: "date-time" |
mainBranchId |
string | Yes | format: "uuid" |
{ "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 100, "description": "Trimmed; control characters are rejected. Names need not be unique." }, "sourceLocale": { "type": "string", "minLength": 2, "maxLength": 255 }, "version": { "type": "integer", "minimum": 1 }, "archivedAt": { "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "mainBranchId": { "type": "string", "format": "uuid" } }, "required": [ "id", "workspaceId", "name", "sourceLocale", "version", "archivedAt", "createdAt", "mainBranchId" ]}PLanguage
Section titled “PLanguage”| Field | Type | Required | Constraints / description |
|---|---|---|---|
locale |
string | Yes | minLength: 2; maxLength: 255 |
name |
string | Yes | — |
active |
boolean | Yes | — |
source |
boolean | Yes | — |
fallbackLocale |
string or null | Yes | — |
{ "type": "object", "additionalProperties": false, "properties": { "locale": { "type": "string", "minLength": 2, "maxLength": 255 }, "name": { "type": "string" }, "active": { "type": "boolean" }, "source": { "type": "boolean" }, "fallbackLocale": { "type": [ "string", "null" ] } }, "required": [ "locale", "name", "active", "source", "fallbackLocale" ]}PLanguagesPage
Section titled “PLanguagesPage”Schema reference: PLanguage.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
items |
Array of PLanguage | Yes | — |
page |
integer | Yes | minimum: 1 |
pageSize |
integer | Yes | minimum: 1; maximum: 100 |
hasMore |
boolean | Yes | — |
version |
integer | Yes | minimum: 1 |
{ "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PLanguage" } }, "page": { "type": "integer", "minimum": 1 }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100 }, "hasMore": { "type": "boolean" }, "version": { "type": "integer", "minimum": 1 } }, "required": [ "items", "page", "pageSize", "hasMore", "version" ]}NamedScope
Section titled “NamedScope”| Field | Type | Required | Constraints / description |
|---|---|---|---|
id |
string | Yes | format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" |
name |
string | Yes | — |
{ "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false}Schema reference: Connection, PProject, PLanguagesPage, NamedScope.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
connection |
Connection | Yes | — |
project |
PProject | Yes | — |
languages |
PLanguagesPage | Yes | — |
workspace |
NamedScope | Yes | — |
branch |
NamedScope | Yes | — |
{ "type": "object", "required": [ "connection", "project", "languages", "workspace", "branch" ], "properties": { "connection": { "$ref": "#/components/schemas/Connection" }, "project": { "$ref": "#/components/schemas/PProject" }, "languages": { "$ref": "#/components/schemas/PLanguagesPage" }, "workspace": { "$ref": "#/components/schemas/NamedScope" }, "branch": { "$ref": "#/components/schemas/NamedScope" } }}Snapshot
Section titled “Snapshot”Schema reference: TTranslationKey, TTranslationValue, Binding.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
keys |
Array of TTranslationKey | Yes | — |
values |
Array of TTranslationValue | Yes | — |
bindings |
Array of Binding | Yes | — |
languages |
Array of object | Yes | — |
permissions |
Array of object | Yes | — |
reviews |
Array of object | Yes | — |
canEditShared |
boolean | Yes | — |
{ "type": "object", "required": [ "keys", "values", "bindings", "languages", "permissions", "reviews", "canEditShared" ], "properties": { "keys": { "type": "array", "items": { "$ref": "#/components/schemas/TTranslationKey" } }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/TTranslationValue" } }, "bindings": { "type": "array", "items": { "$ref": "#/components/schemas/Binding" } }, "languages": { "type": "array", "items": { "type": "object", "required": [ "locale", "active" ], "properties": { "locale": { "type": "string" }, "active": { "type": "boolean" } } } }, "permissions": { "type": "array", "items": { "type": "object", "required": [ "locale", "write", "review" ], "properties": { "locale": { "type": "string" }, "write": { "type": "boolean" }, "review": { "type": "boolean" } } } }, "reviews": { "type": "array", "items": { "type": "object", "required": [ "keyId", "locale", "evidenceId" ], "properties": { "keyId": { "type": "string", "format": "uuid" }, "locale": { "type": "string" }, "evidenceId": { "type": "string", "format": "uuid" } } } }, "canEditShared": { "type": "boolean" } }}OperationResult
Section titled “OperationResult”Schema reference: Scope, TTablePage, Snapshot, Preview, TTranslationKey, TValuesPage, TTranslationValue, WReviewResult, THistoryPage, WContext, WSuggestions, Mentions, WDiscussionThreads, WDiscussionThread, WDiscussionComments, WDiscussionComment, WDiscussionHistory, WImages, WImage, SafeProviders, AUsage, AJob, ASuggestionPage, ASuggestion, AApplyResult.
{ "anyOf": [ { "$ref": "#/components/schemas/Scope" }, { "$ref": "#/components/schemas/TTablePage" }, { "$ref": "#/components/schemas/Snapshot" }, { "$ref": "#/components/schemas/Preview" }, { "$ref": "#/components/schemas/TTranslationKey" }, { "$ref": "#/components/schemas/TValuesPage" }, { "$ref": "#/components/schemas/TTranslationValue" }, { "$ref": "#/components/schemas/WReviewResult" }, { "$ref": "#/components/schemas/THistoryPage" }, { "$ref": "#/components/schemas/WContext" }, { "$ref": "#/components/schemas/WSuggestions" }, { "$ref": "#/components/schemas/Mentions" }, { "$ref": "#/components/schemas/WDiscussionThreads" }, { "$ref": "#/components/schemas/WDiscussionThread" }, { "$ref": "#/components/schemas/WDiscussionComments" }, { "$ref": "#/components/schemas/WDiscussionComment" }, { "$ref": "#/components/schemas/WDiscussionHistory" }, { "$ref": "#/components/schemas/WImages" }, { "$ref": "#/components/schemas/WImage" }, { "$ref": "#/components/schemas/SafeProviders" }, { "$ref": "#/components/schemas/AUsage" }, { "$ref": "#/components/schemas/AJob" }, { "$ref": "#/components/schemas/ASuggestionPage" }, { "$ref": "#/components/schemas/ASuggestion" }, { "$ref": "#/components/schemas/AApplyResult" } ]}
Your privacy, your choice
Choose whether we remember appearance preferences and use Google Analytics on Localisync and its documentation. Optional storage stays off until you accept.
Read our cookie policy