Projects & languages schemas

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

Project

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"
  ]
}

Language

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"
  ]
}

Locale

Field	Type	Required	Constraints / description
code	string	Yes	minLength: 2; maxLength: 255
name	string	Yes	—

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "code": {
      "type": "string",
      "minLength": 2,
      "maxLength": 255
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "code",
    "name"
  ]
}

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"
  ]
}

Version

Field	Type	Required	Constraints / description
version	integer	Yes	minimum: 1

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "version": {
      "type": "integer",
      "minimum": 1
    }
  },
  "required": [
    "version"
  ]
}

CreateProject

Field	Type	Required	Constraints / description
name	string	Yes	Trimmed; control characters are rejected. Names need not be unique.; minLength: 1; maxLength: 100
sourceLocale	string	Yes	minLength: 2; maxLength: 255
targetLocales	Array of string	No	default: []

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "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
    },
    "targetLocales": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 2,
        "maxLength": 255
      },
      "default": []
    }
  },
  "required": [
    "name",
    "sourceLocale"
  ]
}

RenameProject

Field	Type	Required	Constraints / description
version	integer	Yes	minimum: 1
name	string	Yes	Trimmed; control characters are rejected. Names need not be unique.; minLength: 1; maxLength: 100

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "version": {
      "type": "integer",
      "minimum": 1
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "Trimmed; control characters are rejected. Names need not be unique."
    }
  },
  "required": [
    "version",
    "name"
  ]
}

AddLanguage

Field	Type	Required	Constraints / description
version	integer	Yes	minimum: 1
locale	string	Yes	minLength: 2; maxLength: 255

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "version": {
      "type": "integer",
      "minimum": 1
    },
    "locale": {
      "type": "string",
      "minLength": 2,
      "maxLength": 255
    }
  },
  "required": [
    "version",
    "locale"
  ]
}

ChangeFallback

Field	Type	Required	Constraints / description
version	integer	Yes	minimum: 1
fallbackLocale	string	Yes	minLength: 2; maxLength: 255

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "version": {
      "type": "integer",
      "minimum": 1
    },
    "fallbackLocale": {
      "type": "string",
      "minLength": 2,
      "maxLength": 255
    }
  },
  "required": [
    "version",
    "fallbackLocale"
  ]
}

ProjectsPage

Schema reference: Project.

Field	Type	Required	Constraints / description
items	Array of Project	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": {
        "$ref": "#/components/schemas/Project"
      }
    },
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "pageSize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "page",
    "pageSize",
    "hasMore"
  ]
}

LanguagesPage

Schema reference: Language.

Field	Type	Required	Constraints / description
items	Array of Language	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/Language"
      }
    },
    "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"
  ]
}

LocalesPage

Schema reference: Locale.

Field	Type	Required	Constraints / description
items	Array of Locale	Yes	—
page	integer	Yes	minimum: 1
pageSize	integer	Yes	minimum: 1; maximum: 100
hasMore	boolean	Yes	—
registryDate	string	Yes	format: "date"

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Locale"
      }
    },
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "pageSize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "hasMore": {
      "type": "boolean"
    },
    "registryDate": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "items",
    "page",
    "pageSize",
    "hasMore",
    "registryDate"
  ]
}

FallbackChain

Field	Type	Required	Constraints / description
locale	string	Yes	minLength: 2; maxLength: 255
active	boolean	Yes	—
chain	Array of string	Yes	—
version	integer	Yes	minimum: 1

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "locale": {
      "type": "string",
      "minLength": 2,
      "maxLength": 255
    },
    "active": {
      "type": "boolean"
    },
    "chain": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 2,
        "maxLength": 255
      }
    },
    "version": {
      "type": "integer",
      "minimum": 1
    }
  },
  "required": [
    "locale",
    "active",
    "chain",
    "version"
  ]
}