JSON Schema

Task definition schema

JSON Schema for the static task descriptor exported by a task module.

Source included with this website build. Run ansight workspace init . for files matching your installed CLI. Read the guide.

ansight/schema/task-definition.v1.schema.json 1,892 bytes
Raw file Download
SHA-256 c8df1e429196c5c228ede61aad064ed4a54545674a53733bc706457085c0fdc1 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://ansight.dev/schemas/repository-task.v1.schema.json",
  "title": "Ansight Repository Task Definition",
  "type": "object",
  "properties": {
    "schemaVersion": {
      "type": "integer",
      "const": 1,
      "default": 1
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether this task may be executed.",
      "default": true
    },
    "appId": {
      "type": "string",
      "minLength": 1
    },
    "title": {
      "type": "string",
      "minLength": 1
    },
    "description": {
      "type": "string",
      "minLength": 1
    },
    "feature": {
      "type": "string",
      "minLength": 1
    },
    "keywords": {
      "type": "array",
      "description": "App-specific discovery terms and synonyms.",
      "maxItems": 32,
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "inputSchema": {
      "type": "object",
      "description": "JSON Schema for the object passed to invocation.input.",
      "properties": {
        "type": { "const": "object" }
      }
    },
    "outputSchema": {
      "type": "object",
      "description": "JSON Schema for the value returned by the task function."
    },
    "hostTools": {
      "type": "array",
      "description": "Extra registered host tool names used through ansight.callTool. Standard typed APIs, including ansight.keyboard, do not need to be declared.",
      "maxItems": 32,
      "uniqueItems": true,
      "items": { "type": "string", "minLength": 1 }
    },
    "timeoutSeconds": {
      "type": "integer",
      "minimum": 1,
      "maximum": 300,
      "default": 120
    },
    "maximumActions": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 64
    }
  },
  "required": ["title", "description"],
  "additionalProperties": false
}