Skip to content
localisyncDocs
Open panel

Translation keys & values schemas

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

KeyDefinition

Section titled “KeyDefinition”
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 No default: "plain"
parameters Array of object No maxItems: 32; default: [] 
{
  "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": []
    }
  },
  "required": [
    "name"
  ]
}

TranslationKey

Section titled “TranslationKey”
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"
  ]
}

TranslationValue

Section titled “TranslationValue”
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"
  ]
}

ValueEdit

Section titled “ValueEdit”
Field Type Required Constraints / description
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 minimum: 0; maximum: 2147483646 
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "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,
      "maximum": 2147483646
    }
  },
  "required": [
    "locale",
    "value",
    "version"
  ]
}

SaveValue

Section titled “SaveValue”
Field Type Required Constraints / description
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 minimum: 0; maximum: 2147483646
keyVersion integer Yes minimum: 1; maximum: 2147483646 
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "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,
      "maximum": 2147483646
    },
    "keyVersion": {
      "type": "integer",
      "minimum": 1,
      "maximum": 2147483646
    }
  },
  "required": [
    "value",
    "version",
    "keyVersion"
  ]
}

UpdateKey

Section titled “UpdateKey”

Schema reference: ValueEdit.

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 —
parameters Array of object Yes maxItems: 32
version integer Yes minimum: 1; maximum: 2147483646
values Array of ValueEdit No maxItems: 1000; default: [] 
{
  "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"
      ]
    },
    "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"
        ]
      }
    },
    "version": {
      "type": "integer",
      "minimum": 1,
      "maximum": 2147483646
    },
    "values": {
      "type": "array",
      "maxItems": 1000,
      "default": [],
      "items": {
        "$ref": "#/components/schemas/ValueEdit"
      }
    }
  },
  "required": [
    "name",
    "format",
    "parameters",
    "version"
  ]
}

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

TablePage

Section titled “TablePage”

Schema reference: TranslationValue.

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/TranslationValue"
            }
          },
          "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"
  ]
}

ValuesPage

Section titled “ValuesPage”
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"
  ]
}

HistoryPage

Section titled “HistoryPage”
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"
  ]
}

Error

Section titled “Error”
Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string No —
details object No —
statusCode integer No May be included by HTTP-level request limits. 
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "issues": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "field": {
                "type": "string"
              },
              "locale": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            },
            "required": [
              "field",
              "message"
            ]
          }
        }
      },
      "required": [
        "issues"
      ]
    },
    "statusCode": {
      "type": "integer",
      "description": "May be included by HTTP-level request limits."
    }
  },
  "required": [
    "error",
    "message"
  ]
}

CreateKey

Section titled “CreateKey”
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 No default: "plain"
parameters Array of object No maxItems: 32; default: []
gitTarget object No — 
{
  "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": []
    },
    "gitTarget": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "mappingId",
        "group",
        "externalName"
      ],
      "properties": {
        "mappingId": {
          "type": "string",
          "format": "uuid"
        },
        "group": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "externalName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        }
      }
    }
  },
  "required": [
    "name"
  ]
}
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