Skip to content
localisyncDocs
Open panel

Branches & merge schemas

These definitions are generated from the downloadable OpenAPI contract. Required fields, validation constraints and additional-property policies are preserved.

Branch

Section titled “Branch”
Field Type Required Constraints / description
id string Yes format: "uuid"
workspaceId string Yes format: "uuid"
projectId string Yes format: "uuid"
name string Yes —
isMain boolean Yes —
createdBy string Yes format: "uuid"
creatorEmail string Yes —
sourceBranchId See schema Yes —
sourceBranchName See schema Yes —
version integer Yes minimum: 1; maximum: 2147483646
archivedAt See schema Yes —
createdAt string Yes format: "date-time"
headId See schema Yes —
token string Yes pattern: "^[0-9]+$"
blockers object No Detail responses include deletion blockers. Lists contain up to 25 operations. Assistance jobs are visible to their creator or workspace managers; counts include all unfinished operations and active calls. 
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid"
    },
    "projectId": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string"
    },
    "isMain": {
      "type": "boolean"
    },
    "createdBy": {
      "type": "string",
      "format": "uuid"
    },
    "creatorEmail": {
      "type": "string"
    },
    "sourceBranchId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ]
    },
    "sourceBranchName": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "version": {
      "type": "integer",
      "minimum": 1,
      "maximum": 2147483646
    },
    "archivedAt": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "headId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ]
    },
    "token": {
      "type": "string",
      "pattern": "^[0-9]+$"
    },
    "blockers": {
      "type": "object",
      "description": "Detail responses include deletion blockers. Lists contain up to 25 operations. Assistance jobs are visible to their creator or workspace managers; counts include all unfinished operations and active calls.",
      "properties": {
        "branchCount": {
          "type": "integer"
        },
        "transferCount": {
          "type": "integer"
        },
        "branchJobs": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "format": "uuid"
              },
              "kind": {
                "type": "string"
              },
              "state": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "kind",
              "state"
            ]
          }
        },
        "transferJobs": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "format": "uuid"
              },
              "kind": {
                "type": "string"
              },
              "state": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "kind",
              "state"
            ]
          }
        },
        "assistanceCount": {
          "type": "integer",
          "minimum": 0
        },
        "assistanceJobs": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "format": "uuid"
              },
              "state": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "state"
            ]
          }
        }
      },
      "required": [
        "branchCount",
        "transferCount",
        "branchJobs",
        "transferJobs",
        "assistanceCount",
        "assistanceJobs"
      ]
    }
  },
  "required": [
    "id",
    "workspaceId",
    "projectId",
    "name",
    "isMain",
    "createdBy",
    "creatorEmail",
    "sourceBranchId",
    "sourceBranchName",
    "version",
    "archivedAt",
    "createdAt",
    "headId",
    "token"
  ]
}

BranchJob

Section titled “BranchJob”
Field Type Required Constraints / description
id string Yes format: "uuid"
workspaceId string Yes format: "uuid"
projectId string Yes format: "uuid"
kind fork, compare, merge, delete Yes —
state queued, processing, ready, completed, failed, conflict, cancelled, expired Yes —
version integer Yes minimum: 1; maximum: 2147483646
summary object Yes —
resultBranchId See schema Yes —
appliedJobId See schema Yes —
errorCode See schema Yes —
createdAt string Yes format: "date-time"
expiresAt string Yes format: "date-time"
sourceBranchId See schema Yes —
targetBranchId See schema Yes —
actorId string Yes format: "uuid" 
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid"
    },
    "projectId": {
      "type": "string",
      "format": "uuid"
    },
    "kind": {
      "enum": [
        "fork",
        "compare",
        "merge",
        "delete"
      ]
    },
    "state": {
      "enum": [
        "queued",
        "processing",
        "ready",
        "completed",
        "failed",
        "conflict",
        "cancelled",
        "expired"
      ]
    },
    "version": {
      "type": "integer",
      "minimum": 1,
      "maximum": 2147483646
    },
    "summary": {
      "type": "object",
      "additionalProperties": {
        "type": "integer",
        "minimum": 0
      }
    },
    "resultBranchId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ]
    },
    "appliedJobId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ]
    },
    "errorCode": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    },
    "sourceBranchId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ]
    },
    "targetBranchId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ]
    },
    "actorId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "id",
    "workspaceId",
    "projectId",
    "kind",
    "state",
    "version",
    "summary",
    "resultBranchId",
    "appliedJobId",
    "errorCode",
    "createdAt",
    "expiresAt",
    "sourceBranchId",
    "targetBranchId",
    "actorId"
  ]
}

Cell

Section titled “Cell”
{
  "oneOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "present": {
          "const": false
        }
      },
      "required": [
        "present"
      ]
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "present": {
          "const": true
        },
        "value": {}
      },
      "required": [
        "present",
        "value"
      ]
    }
  ]
}

Change

Section titled “Change”

Schema reference: Cell.

Field Type Required Constraints / description
id string Yes —
kind language, tag, definition, archive, value, assignment, binding Yes —
keyId See schema Yes —
keyName See schema Yes —
locale See schema Yes —
tagId See schema Yes —
bases Array of Cell Yes minItems: 1
source Cell Yes —
target Cell Yes —
conflict boolean Yes —
result See schema Yes —
tagNames Array of string Yes — 
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "kind": {
      "enum": [
        "language",
        "tag",
        "definition",
        "archive",
        "value",
        "assignment",
        "binding"
      ]
    },
    "keyId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ]
    },
    "keyName": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "locale": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "tagId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ]
    },
    "bases": {
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "#/components/schemas/Cell"
      }
    },
    "source": {
      "$ref": "#/components/schemas/Cell"
    },
    "target": {
      "$ref": "#/components/schemas/Cell"
    },
    "conflict": {
      "type": "boolean"
    },
    "result": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/Cell"
        },
        {
          "type": "null"
        }
      ]
    },
    "tagNames": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "id",
    "kind",
    "keyId",
    "keyName",
    "locale",
    "tagId",
    "bases",
    "source",
    "target",
    "conflict",
    "result",
    "tagNames"
  ]
}

Issue

Section titled “Issue”
Field Type Required Constraints / description
code string Yes —
message string Yes —
keyId See schema Yes —
locale See schema Yes — 
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "keyId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ]
    },
    "locale": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "code",
    "message",
    "keyId",
    "locale"
  ]
}

Version

Section titled “Version”
Field Type Required Constraints / description
version integer Yes minimum: 1; maximum: 2147483646 
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "version": {
      "type": "integer",
      "minimum": 1,
      "maximum": 2147483646
    }
  },
  "required": [
    "version"
  ]
}

Branches

Section titled “Branches”

Schema reference: Branch.

Field Type Required Constraints / description
items Array of Branch Yes —
page integer Yes —
pageSize integer Yes —
hasMore boolean Yes — 
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Branch"
      }
    },
    "page": {
      "type": "integer"
    },
    "pageSize": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "page",
    "pageSize",
    "hasMore"
  ]
}

Jobs

Section titled “Jobs”

Schema reference: BranchJob.

Field Type Required Constraints / description
items Array of BranchJob Yes —
page integer Yes —
pageSize integer Yes —
hasMore boolean Yes — 
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BranchJob"
      }
    },
    "page": {
      "type": "integer"
    },
    "pageSize": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "page",
    "pageSize",
    "hasMore"
  ]
}

Changes

Section titled “Changes”

Schema reference: Change.

Field Type Required Constraints / description
items Array of Change Yes —
page integer Yes —
pageSize integer Yes —
hasMore boolean Yes —
version integer Yes minimum: 1; maximum: 2147483646 
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Change"
      }
    },
    "page": {
      "type": "integer"
    },
    "pageSize": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "version": {
      "type": "integer",
      "minimum": 1,
      "maximum": 2147483646
    }
  },
  "required": [
    "items",
    "page",
    "pageSize",
    "hasMore",
    "version"
  ]
}

Issues

Section titled “Issues”

Schema reference: Issue.

Field Type Required Constraints / description
items Array of Issue Yes —
page integer Yes —
pageSize integer Yes —
hasMore boolean Yes — 
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Issue"
      }
    },
    "page": {
      "type": "integer"
    },
    "pageSize": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "page",
    "pageSize",
    "hasMore"
  ]
}

Fork

Section titled “Fork”
Field Type Required Constraints / description
name string Yes minLength: 1; maxLength: 100
sourceId string Yes format: "uuid"
sourceToken string Yes pattern: "^[0-9]+$" 
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "sourceId": {
      "type": "string",
      "format": "uuid"
    },
    "sourceToken": {
      "type": "string",
      "pattern": "^[0-9]+$"
    }
  },
  "required": [
    "name",
    "sourceId",
    "sourceToken"
  ]
}

Rename

Section titled “Rename”
Field Type Required Constraints / description
name string Yes minLength: 1; maxLength: 100
version integer Yes minimum: 1; maximum: 2147483646 
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "version": {
      "type": "integer",
      "minimum": 1,
      "maximum": 2147483646
    }
  },
  "required": [
    "name",
    "version"
  ]
}

Compare

Section titled “Compare”
Field Type Required Constraints / description
sourceId string Yes format: "uuid"
targetId string Yes format: "uuid" 
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "sourceId": {
      "type": "string",
      "format": "uuid"
    },
    "targetId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "sourceId",
    "targetId"
  ]
}

Resolve

Section titled “Resolve”
Field Type Required Constraints / description
version integer Yes minimum: 1; maximum: 2147483646
resolutions Array of See schema Yes minItems: 1; maxItems: 100 
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "version": {
      "type": "integer",
      "minimum": 1,
      "maximum": 2147483646
    },
    "resolutions": {
      "type": "array",
      "minItems": 1,
      "maxItems": 100,
      "items": {
        "oneOf": [
          {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "choice": {
                "enum": [
                  "source",
                  "target"
                ]
              }
            },
            "required": [
              "id",
              "choice"
            ]
          },
          {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "string"
              },
              "choice": {
                "const": "custom"
              },
              "value": {}
            },
            "required": [
              "id",
              "choice",
              "value"
            ]
          }
        ]
      }
    }
  },
  "required": [
    "version",
    "resolutions"
  ]
}

Error

Section titled “Error”
Field Type Required Constraints / description
error unauthorized, forbidden, invalid_request, not_found, conflict, rate_limited, unavailable Yes —
message string Yes —
requestId string No —
details object No — 
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "error": {
      "type": "string",
      "enum": [
        "unauthorized",
        "forbidden",
        "invalid_request",
        "not_found",
        "conflict",
        "rate_limited",
        "unavailable"
      ]
    },
    "message": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "dependentLocales": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 2,
            "maxLength": 255
          }
        }
      },
      "required": [
        "dependentLocales"
      ]
    }
  },
  "required": [
    "error",
    "message"
  ]
}
Localisync byWetus

Cookie preferences

Your choice applies to localisync.com and docs.localisync.com. You can change it at any time using Cookie settings.

Cookie policyWebsite privacy