repository-schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "type": "array",
  "title": "The repository definition",
  "description": "The list containing all add-ons included in the repository.",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "title": "Add-on ID",
        "description": "The add-on identifier as in addon.xml"
      },
      "username": {
        "type": "string",
        "title": "Repository username",
        "description": "The github repository username"
      },
      "branch": {
        "type": "string",
        "title": "Repository branch",
        "description": "The github repository branch. If not defined, it will be the commit of the latest release or, in case there are no releases, master branch."
      },
      "assets": {
        "type": "object",
        "title": "Repository assets",
        "description": "Dictionary containing string/string key-value pairs, where the key corresponds to the relative asset location and the value corresponds to the real asset location. One can also set \"zip\" asset, which is a special case for the add-on zip. If an asset is not defined, its location will be automatically evaluated.\nNote: assets are treated as \"new style\" format strings with the following keywords - id, username, repository, branch, system and arch.",
        "additionalProperties": {
          "type": "string",
          "title": "Asset location",
          "description": "The real asset location"
        }
      },
      "asset_prefix": {
        "type": "string",
        "title": "Asset prefix",
        "description": "Prefix to use on the real asset location when it is automatically evaluated."
      },
      "repository": {
        "type": "string",
        "title": "Github repository",
        "description": "GitHub repository name. If not set, it is assumed to be the same as the add-on id."
      },
      "platforms": {
        "type": "array",
        "title": "Supported platforms",
        "description": "Platforms where the add-on is supported. If not set, it is assumed all platforms are supported.",
        "items": {
          "type": "string"
        }
      }
    },
    "required": [
      "id",
      "username"
    ],
    "additionalProperties": false
  }
}