at.locale.project

locale.at

Documentation

main record

No description available.

Record Key any Any valid record key

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 6000 bytesmaxGraphemes: 2000 graphemes
name string Required

Display name.

maxLength: 1000 bytesminLength: 1 bytesmaxGraphemes: 200 graphemes
permissions ref #permissions Optional

Default access policy for the project.

slug string Required

Stable, URL-safe slug used to address the project.

maxLength: 128 bytesminLength: 1 bytes
source ref #source Required

No description available.

sourceLocale string Required

BCP-47 language tag of the source strings, e.g. "en-US".

maxLength: 35 bytesminLength: 2 bytes
targetLocales array of string Optional

BCP-47 tags the project is translated into.

maxLength: 1000 items
View raw schema 
{
  "key": "any",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "slug",
      "sourceLocale",
      "source",
      "createdAt"
    ],
    "properties": {
      "name": {
        "type": "string",
        "maxLength": 1000,
        "minLength": 1,
        "description": "Display name.",
        "maxGraphemes": 200
      },
      "slug": {
        "type": "string",
        "maxLength": 128,
        "minLength": 1,
        "description": "Stable, URL-safe slug used to address the project."
      },
      "source": {
        "ref": "#source",
        "type": "ref"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "description": {
        "type": "string",
        "maxLength": 6000,
        "maxGraphemes": 2000
      },
      "permissions": {
        "ref": "#permissions",
        "type": "ref",
        "description": "Default access policy for the project."
      },
      "sourceLocale": {
        "type": "string",
        "maxLength": 35,
        "minLength": 2,
        "description": "BCP-47 language tag of the source strings, e.g. \"en-US\"."
      },
      "targetLocales": {
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 35,
          "minLength": 2
        },
        "maxLength": 1000,
        "description": "BCP-47 tags the project is translated into."
      }
    }
  }
}
permissions object

Default access policy for the project.

Properties

defaultRole string Optional

Role assigned to authenticated users in open projects.

Known values: viewer, translator, reviewer
policy string Optional

Who can contribute translations.

Known values: closed, open
View raw schema 
{
  "type": "object",
  "properties": {
    "policy": {
      "type": "string",
      "default": "closed",
      "description": "Who can contribute translations.",
      "knownValues": [
        "closed",
        "open"
      ]
    },
    "defaultRole": {
      "type": "string",
      "default": "translator",
      "description": "Role assigned to authenticated users in open projects.",
      "knownValues": [
        "viewer",
        "translator",
        "reviewer"
      ]
    }
  },
  "description": "Default access policy for the project."
}
source object

Where the source strings live and how to read them — the content host (the "knot").

Properties

branch string Optional

No description available.

maxLength: 255 bytes
format string Required

No description available.

Known values: json, yaml, po, xliff, arb, strings, properties, androidxml, csv, ini
paths array of string Optional

Glob(s) matching the translation files inside the repo.

maxLength: 100 items
type string Required

No description available.

Known values: git
url string uri Required

A valid URI.

maxLength: 2048 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "url",
    "format"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048
    },
    "type": {
      "type": "string",
      "default": "git",
      "knownValues": [
        "git"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 1024
      },
      "maxLength": 100,
      "description": "Glob(s) matching the translation files inside the repo."
    },
    "branch": {
      "type": "string",
      "default": "main",
      "maxLength": 255
    },
    "format": {
      "type": "string",
      "knownValues": [
        "json",
        "yaml",
        "po",
        "xliff",
        "arb",
        "strings",
        "properties",
        "androidxml",
        "csv",
        "ini"
      ]
    }
  },
  "description": "Where the source strings live and how to read them — the content host (the \"knot\")."
}

Lexicon Garden

@