Git synchronization schemas
These definitions are generated from the downloadable OpenAPI contract. Required fields, validation constraints and additional-property policies are preserved.
Catalog
Section titled “Catalog”{ "type": "array", "items": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "github", "gitlab", "bitbucket" ] }, "enabled": { "type": "boolean" }, "permissions": { "type": "string" } }, "required": [ "provider", "enabled", "permissions" ] }}Connections
Section titled “Connections”{ "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)$" }, "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)$" }, "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)$" }, "provider": { "type": "string", "enum": [ "github", "gitlab", "bitbucket" ] }, "name": { "type": "string" }, "state": { "type": "string", "enum": [ "pending", "connected", "reconnect", "disabled" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "workspaceId", "actorId", "provider", "name", "state", "version" ] }}Mapping
Section titled “Mapping”| Field | Type | Required | Constraints / description |
|---|---|---|---|
name |
string | Yes | minLength: 1; maxLength: 100 |
grantId |
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)$" |
repository |
string | Yes | minLength: 1; maxLength: 300 |
repositoryId |
string | Yes | minLength: 1; maxLength: 100 |
gitBranch |
string | Yes | minLength: 1; maxLength: 250 |
files |
Array of object | Yes | minItems: 1; maxItems: 20 |
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)$" |
enabled |
boolean | Yes | — |
version |
integer | Yes | maximum: 9007199254740991 |
openJobId |
See schema | Yes | — |
{ "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "grantId": { "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)$" }, "repository": { "type": "string", "minLength": 1, "maxLength": 300 }, "repositoryId": { "type": "string", "minLength": 1, "maxLength": 100 }, "gitBranch": { "type": "string", "minLength": 1, "maxLength": 250 }, "files": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 500 }, "locale": { "type": "string", "minLength": 2, "maxLength": 40 }, "group": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[\\w.-]+$" }, "format": { "type": "string", "enum": [ "arb", "json" ] }, "messageFormat": { "type": "string", "enum": [ "plain", "icu" ] }, "nested": { "type": "boolean" } }, "required": [ "path", "locale", "group", "format", "messageFormat", "nested" ], "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)$" }, "enabled": { "type": "boolean" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "openJobId": { "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": [ "name", "grantId", "repository", "repositoryId", "gitBranch", "files", "id", "enabled", "version", "openJobId" ], "additionalProperties": false}Mappings
Section titled “Mappings”{ "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "grantId": { "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)$" }, "repository": { "type": "string", "minLength": 1, "maxLength": 300 }, "repositoryId": { "type": "string", "minLength": 1, "maxLength": 100 }, "gitBranch": { "type": "string", "minLength": 1, "maxLength": 250 }, "files": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 500 }, "locale": { "type": "string", "minLength": 2, "maxLength": 40 }, "group": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[\\w.-]+$" }, "format": { "type": "string", "enum": [ "arb", "json" ] }, "messageFormat": { "type": "string", "enum": [ "plain", "icu" ] }, "nested": { "type": "boolean" } }, "required": [ "path", "locale", "group", "format", "messageFormat", "nested" ], "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)$" }, "enabled": { "type": "boolean" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "openJobId": { "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": [ "name", "grantId", "repository", "repositoryId", "gitBranch", "files", "id", "enabled", "version", "openJobId" ], "additionalProperties": false }}MappingInput
Section titled “MappingInput”| Field | Type | Required | Constraints / description |
|---|---|---|---|
name |
string | Yes | minLength: 1; maxLength: 100 |
grantId |
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)$" |
repository |
string | Yes | minLength: 1; maxLength: 300 |
repositoryId |
string | Yes | minLength: 1; maxLength: 100 |
gitBranch |
string | Yes | minLength: 1; maxLength: 250 |
files |
Array of object | Yes | minItems: 1; maxItems: 20 |
{ "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "grantId": { "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)$" }, "repository": { "type": "string", "minLength": 1, "maxLength": 300 }, "repositoryId": { "type": "string", "minLength": 1, "maxLength": 100 }, "gitBranch": { "type": "string", "minLength": 1, "maxLength": 250 }, "files": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 500 }, "locale": { "type": "string", "minLength": 2, "maxLength": 40 }, "group": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[\\w.-]+$" }, "format": { "type": "string", "enum": [ "arb", "json" ] }, "messageFormat": { "type": "string", "enum": [ "plain", "icu" ] }, "nested": { "type": "boolean" } }, "required": [ "path", "locale", "group", "format", "messageFormat", "nested" ], "additionalProperties": false } } }, "required": [ "name", "grantId", "repository", "repositoryId", "gitBranch", "files" ], "additionalProperties": false}Authorization
Section titled “Authorization”| Field | Type | Required | Constraints / description |
|---|---|---|---|
provider |
github, gitlab, bitbucket |
Yes | — |
existing |
object | No | — |
{ "type": "object", "properties": { "provider": { "type": "string", "enum": [ "github", "gitlab", "bitbucket" ] }, "existing": { "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": 9007199254740991 } }, "required": [ "id", "version" ], "additionalProperties": false } }, "required": [ "provider" ], "additionalProperties": false}AuthorizationResult
Section titled “AuthorizationResult”| 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)$" |
url |
string | Yes | format: "uri" |
{ "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)$" }, "url": { "type": "string", "format": "uri" } }, "required": [ "id", "url" ]}Disabled
Section titled “Disabled”| Field | Type | Required | Constraints / description |
|---|---|---|---|
disabled |
boolean | Yes | — |
{ "type": "object", "properties": { "disabled": { "type": "boolean", "const": true } }, "required": [ "disabled" ]}DiscoveryInput
Section titled “DiscoveryInput”| Field | Type | Required | Constraints / description |
|---|---|---|---|
grantId |
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)$" |
kind |
repositories, branches, files |
Yes | — |
repository |
string | No | maxLength: 300; default: "" |
branch |
string | No | maxLength: 250; default: "" |
{ "type": "object", "properties": { "grantId": { "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)$" }, "kind": { "type": "string", "enum": [ "repositories", "branches", "files" ] }, "repository": { "default": "", "type": "string", "maxLength": 300 }, "branch": { "default": "", "type": "string", "maxLength": 250 } }, "required": [ "grantId", "kind" ], "additionalProperties": false}Discovery
Section titled “Discovery”| 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)$" |
grantId |
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)$" |
kind |
repositories, branches, files |
Yes | — |
repository |
string | Yes | — |
branch |
string | Yes | — |
state |
queued, completed, failed |
Yes | — |
result |
Array of object | Yes | — |
error |
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)$" }, "grantId": { "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)$" }, "kind": { "type": "string", "enum": [ "repositories", "branches", "files" ] }, "repository": { "type": "string" }, "branch": { "type": "string" }, "state": { "type": "string", "enum": [ "queued", "completed", "failed" ] }, "result": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "stableId": { "type": "string" } }, "required": [ "id", "name" ] } }, "error": { "type": [ "string", "null" ] } }, "required": [ "id", "grantId", "kind", "repository", "branch", "state", "result", "error" ]}Binding
Section titled “Binding”| Field | Type | Required | Constraints / description |
|---|---|---|---|
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)$" |
group |
string | Yes | minLength: 1; maxLength: 100 |
externalName |
string | Yes | minLength: 1; maxLength: 200 |
{ "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)$" }, "group": { "type": "string", "minLength": 1, "maxLength": 100 }, "externalName": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "keyId", "group", "externalName" ], "additionalProperties": false}Bindings
Section titled “Bindings”{ "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)$" }, "group": { "type": "string", "minLength": 1, "maxLength": 100 }, "externalName": { "type": "string", "minLength": 1, "maxLength": 200 }, "name": { "type": "string" } }, "required": [ "keyId", "group", "externalName", "name" ], "additionalProperties": false }}Rename
Section titled “Rename”| Field | Type | Required | Constraints / description |
|---|---|---|---|
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)$" |
group |
string | Yes | minLength: 1; maxLength: 100 |
externalName |
string | Yes | minLength: 1; maxLength: 200 |
oldName |
string | Yes | minLength: 1; maxLength: 200 |
approved |
boolean | Yes | — |
{ "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)$" }, "group": { "type": "string", "minLength": 1, "maxLength": 100 }, "externalName": { "type": "string", "minLength": 1, "maxLength": 200 }, "oldName": { "type": "string", "minLength": 1, "maxLength": 200 }, "approved": { "type": "boolean", "const": true } }, "required": [ "keyId", "group", "externalName", "oldName", "approved" ], "additionalProperties": false}Assigned
Section titled “Assigned”| Field | Type | Required | Constraints / description |
|---|---|---|---|
assigned |
boolean | Yes | — |
{ "type": "object", "properties": { "assigned": { "type": "boolean", "const": true } }, "required": [ "assigned" ]}Unassigned
Section titled “Unassigned”{ "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)$" }, "name": { "type": "string" } }, "required": [ "keyId", "name" ] }}Enable
Section titled “Enable”| Field | Type | Required | Constraints / description |
|---|---|---|---|
version |
integer | Yes | maximum: 9007199254740991 |
enabled |
boolean | Yes | — |
{ "type": "object", "properties": { "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "enabled": { "type": "boolean" } }, "required": [ "version", "enabled" ], "additionalProperties": false}MappingFiles
Section titled “MappingFiles”| Field | Type | Required | Constraints / description |
|---|---|---|---|
version |
integer | Yes | maximum: 9007199254740991 |
approved |
boolean | Yes | — |
files |
Array of object | Yes | minItems: 1; maxItems: 20 |
{ "type": "object", "properties": { "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "approved": { "type": "boolean", "const": true }, "files": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 500 }, "locale": { "type": "string", "minLength": 2, "maxLength": 40 }, "group": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[\\w.-]+$" }, "format": { "type": "string", "enum": [ "arb", "json" ] }, "messageFormat": { "type": "string", "enum": [ "plain", "icu" ] }, "nested": { "type": "boolean" } }, "required": [ "path", "locale", "group", "format", "messageFormat", "nested" ], "additionalProperties": false } } }, "required": [ "version", "approved", "files" ], "additionalProperties": false}Preview
Section titled “Preview”| Field | Type | Required | Constraints / description |
|---|---|---|---|
direction |
import, export |
Yes | — |
{ "type": "object", "properties": { "direction": { "type": "string", "enum": [ "import", "export" ] } }, "required": [ "direction" ], "additionalProperties": false}| 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)$" |
mappingId |
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)$" |
direction |
import, export |
Yes | — |
state |
queued, processing, ready, approved, sending, open, completed, failed, outcome_unknown, cancelled, expired |
Yes | — |
version |
integer | Yes | maximum: 9007199254740991 |
error |
string or null | 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))$" |
request |
See schema | Yes | — |
preview |
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)$" }, "mappingId": { "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)$" }, "direction": { "type": "string", "enum": [ "import", "export" ] }, "state": { "type": "string", "enum": [ "queued", "processing", "ready", "approved", "sending", "open", "completed", "failed", "outcome_unknown", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "error": { "type": [ "string", "null" ] }, "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))$" }, "request": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "branch": { "type": "string" }, "targetBranch": { "type": "string" }, "head": { "type": "string" }, "state": { "type": "string", "enum": [ "open", "closed", "merged" ] } }, "required": [ "id", "url", "branch", "targetBranch", "head", "state" ] }, { "type": "null" } ] }, "preview": { "anyOf": [ { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "import", "export" ] }, "commit": { "type": "string" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "page": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "changes": { "type": "array", "items": { "type": "object", "properties": { "identity": { "type": "string" }, "field": { "type": "string", "enum": [ "definition", "value", "archived", "notes" ] }, "locale": { "type": [ "string", "null" ] }, "base": { "anyOf": [ { "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 } }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "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": [ "name", "format", "parameters" ], "additionalProperties": false }, { "type": "object", "properties": { "present": { "type": "boolean" }, "value": { "type": [ "string", "null" ] } }, "required": [ "present", "value" ], "additionalProperties": false }, { "type": "boolean" }, { "type": "null" } ] }, "local": { "anyOf": [ { "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 } }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "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": [ "name", "format", "parameters" ], "additionalProperties": false }, { "type": "object", "properties": { "present": { "type": "boolean" }, "value": { "type": [ "string", "null" ] } }, "required": [ "present", "value" ], "additionalProperties": false }, { "type": "boolean" }, { "type": "null" } ] }, "remote": { "anyOf": [ { "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 } }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "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": [ "name", "format", "parameters" ], "additionalProperties": false }, { "type": "object", "properties": { "present": { "type": "boolean" }, "value": { "type": [ "string", "null" ] } }, "required": [ "present", "value" ], "additionalProperties": false }, { "type": "boolean" }, { "type": "null" } ] }, "conflict": { "type": "boolean" }, "removal": { "type": "boolean" }, "notes": { "type": [ "string", "null" ] } }, "required": [ "identity", "field", "locale", "base", "local", "remote", "conflict", "removal", "notes" ] } } }, "required": [ "direction", "commit", "total", "page", "changes" ] }, { "type": "null" } ] } }, "required": [ "id", "mappingId", "direction", "state", "version", "error", "expiresAt", "request", "preview" ]}{ "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)$" }, "mappingId": { "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)$" }, "direction": { "type": "string", "enum": [ "import", "export" ] }, "state": { "type": "string", "enum": [ "queued", "processing", "ready", "approved", "sending", "open", "completed", "failed", "outcome_unknown", "cancelled", "expired" ] }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "error": { "type": [ "string", "null" ] }, "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))$" }, "request": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "branch": { "type": "string" }, "targetBranch": { "type": "string" }, "head": { "type": "string" }, "state": { "type": "string", "enum": [ "open", "closed", "merged" ] } }, "required": [ "id", "url", "branch", "targetBranch", "head", "state" ] }, { "type": "null" } ] }, "preview": { "anyOf": [ { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "import", "export" ] }, "commit": { "type": "string" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "page": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "changes": { "type": "array", "items": { "type": "object", "properties": { "identity": { "type": "string" }, "field": { "type": "string", "enum": [ "definition", "value", "archived", "notes" ] }, "locale": { "type": [ "string", "null" ] }, "base": { "anyOf": [ { "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 } }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "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": [ "name", "format", "parameters" ], "additionalProperties": false }, { "type": "object", "properties": { "present": { "type": "boolean" }, "value": { "type": [ "string", "null" ] } }, "required": [ "present", "value" ], "additionalProperties": false }, { "type": "boolean" }, { "type": "null" } ] }, "local": { "anyOf": [ { "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 } }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "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": [ "name", "format", "parameters" ], "additionalProperties": false }, { "type": "object", "properties": { "present": { "type": "boolean" }, "value": { "type": [ "string", "null" ] } }, "required": [ "present", "value" ], "additionalProperties": false }, { "type": "boolean" }, { "type": "null" } ] }, "remote": { "anyOf": [ { "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 } }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "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": [ "name", "format", "parameters" ], "additionalProperties": false }, { "type": "object", "properties": { "present": { "type": "boolean" }, "value": { "type": [ "string", "null" ] } }, "required": [ "present", "value" ], "additionalProperties": false }, { "type": "boolean" }, { "type": "null" } ] }, "conflict": { "type": "boolean" }, "removal": { "type": "boolean" }, "notes": { "type": [ "string", "null" ] } }, "required": [ "identity", "field", "locale", "base", "local", "remote", "conflict", "removal", "notes" ] } } }, "required": [ "direction", "commit", "total", "page", "changes" ] }, { "type": "null" } ] } }, "required": [ "id", "mappingId", "direction", "state", "version", "error", "expiresAt", "request", "preview" ] }}Approval
Section titled “Approval”| Field | Type | Required | Constraints / description |
|---|---|---|---|
version |
integer | Yes | maximum: 9007199254740991 |
approved |
boolean | Yes | — |
choices |
Array of object | Yes | maxItems: 70000 |
{ "type": "object", "properties": { "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "approved": { "type": "boolean", "const": true }, "choices": { "maxItems": 70000, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "choice": { "type": "string", "enum": [ "local", "remote", "custom" ] }, "value": { "anyOf": [ { "type": "object", "properties": { "present": { "type": "boolean" }, "value": { "type": [ "string", "null" ] } }, "required": [ "present", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "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": [ "name", "format", "parameters" ], "additionalProperties": false }, { "type": "boolean" }, { "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 } } ] }, "approveRemoval": { "default": false, "type": "boolean" } }, "required": [ "index", "choice" ], "additionalProperties": false } } }, "required": [ "version", "approved", "choices" ], "additionalProperties": false}Version
Section titled “Version”| Field | Type | Required | Constraints / description |
|---|---|---|---|
version |
integer | Yes | maximum: 9007199254740991 |
{ "type": "object", "properties": { "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "version" ], "additionalProperties": false}| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
requestId |
string | Yes | — |
{ "type": "object", "properties": { "error": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "error", "message", "requestId" ]}
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