application.schema.json

{
  "$id": "/2-0-3/application.schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "YAML Application Description",
  "description": "An AICA application graph description using YAML syntax.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "schema": {
      "title": "Schema",
      "description": "The schema version of the application syntax",
      "examples": [
        "1-4-1",
        "draft/2-0-0",
        "2-1-0"
      ],
      "type": "string",
      "pattern": "^(draft/)?[0-9]+-[0-9]+-[0-9]+$"
    },
    "dependencies": {
      "title": "Dependencies",
      "description": "The application dependencies, including the version of AICA Core and any required packages",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "core": {
          "title": "Core Version",
          "description": "The version of the AICA Core image",
          "examples": [
            "v3.1.1",
            "v4.0.0"
          ],
          "type": "string",
          "pattern": "^v[0-9]+\\.[0-9]+\\.[0-9]+$"
        },
        "packages": {
          "title": "Application Packages",
          "description": "A list of packages required by the application",
          "type": "array",
          "uniqueItems": true,
          "items": {
            "title": "Package Details",
            "description": "The specification of a package name and version with optional version constraints",
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "package": {
                "title": "Package Name",
                "description": "The name of the package",
                "examples": [
                  "@aica/components/pose-detection",
                  "@aica/collections/ur-collection"
                ],
                "type": "string"
              },
              "version": {
                "title": "Package Version",
                "description": "The specific version of the package used by the author of the application",
                "examples": [
                  "v1.2.3",
                  "docker-image://ghcr.io/aica-technology/custom-package:v0.1.0"
                ],
                "type": "string",
                "pattern": "^(v[0-9]+\\.[0-9]+\\.[0-9]+)|(docker-image://.*)$"
              },
              "constraints": {
                "title": "Package Version Constraint",
                "description": "A range of acceptable package versions that are supported by the application defined by constraints. For more details on syntax, see https://developer.hashicorp.com/terraform/language/expressions/version-constraints",
                "examples": [
                  "1.0.0",
                  "= 1.0.1",
                  "> 1.0.2",
                  ">= 1.0.3",
                  "~> 1.0.4",
                  "~> 1.1",
                  ">= 1.1.0, < 2.0.0",
                  ">= 2.0.0, != 2.0.1, <= 2.0.2"
                ],
                "type": "string",
                "pattern": "^(\\s*(=|!=|<|<=|>|>=|~>)?\\s*([0-9]+\\.[0-9]+(\\.[0-9]+)?)\\s*,?\\s*)+$"
              }
            },
            "required": [
              "package",
              "version"
            ]
          }
        }
      },
      "required": [
        "core"
      ]
    },
    "metadata": {
      "title": "Application Metadata",
      "description": "Metadata used to describe the application for user convenience. This information may be used by parsers to search or sort database applications",
      "type": "object",
      "properties": {
        "name": {
          "title": "Application Name",
          "description": "The name of the application",
          "type": "string"
        },
        "description": {
          "title": "Application Description",
          "description": "A brief description of the application",
          "type": "string"
        },
        "tags": {
          "title": "Application Tags",
          "description": "A collection of user-defined tags that provide additional context for categorizing the application",
          "type": "array",
          "uniqueItems": true,
          "items": {
            "type": "string",
            "example": [
              "motion",
              "optimization",
              "assembly",
              "force control"
            ]
          }
        }
      }
    },
    "userdata": {
      "title": "User Data",
      "description": "This property accepts any data structure and will be ignored by the syntax parser. It can be used to store additional metadata or context about the application for user convenience."
    },
    "on_start": {
      "$ref": "on_start.schema.json"
    },
    "hardware": {
      "$ref": "hardware.schema.json"
    },
    "components": {
      "$ref": "components.schema.json"
    },
    "conditions": {
      "$ref": "conditions.schema.json"
    },
    "sequences": {
      "$ref": "sequences.schema.json"
    },
    "frames": {
      "$ref": "frames.schema.json"
    },
    "joint_positions": {
      "$ref": "joint_positions.schema.json"
    },
    "graph": {
      "$ref": "graph.schema.json"
    }
  },
  "required": [
    "schema",
    "dependencies"
  ],
  "$defs": {
    "events": {
      "$ref": "events.schema.json"
    },
    "identifier": {
      "$ref": "common/identifier.schema.json"
    },
    "log_level": {
      "$ref": "common/log_level.schema.json"
    },
    "parameters": {
      "$ref": "common/parameters.schema.json"
    },
    "signals": {
      "$ref": "common/signals.schema.json"
    }
  }
}