zaraz_base-mc

APIs.ioEngineeringPlatform
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-zaraz-base-mc-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/zaraz_base-mc",
  "title": "zaraz_base-mc",
  "allOf": [
    {
      "$ref": "#/components/schemas/zaraz_base-tool"
    },
    {
      "properties": {
        "actions": {
          "additionalProperties": {
            "properties": {
              "actionType": {
                "description": "Tool event type",
                "type": "string"
              },
              "blockingTriggers": {
                "description": "List of blocking triggers IDs",
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "data": {
                "description": "Event payload",
                "type": "object"
              },
              "firingTriggers": {
                "description": "List of firing triggers IDs",
                "items": {
                  "type": "string"
                },
                "minItems": 1,
                "type": "array"
              }
            },
            "required": [
              "actionType",
              "blockingTriggers",
              "firingTriggers",
              "data"
            ],
            "type": "object"
          },
          "description": "Actions configured on a tool. Either this or neoEvents field is required.",
          "type": "object"
        },
        "component": {
          "description": "Tool's internal name",
          "type": "string"
        },
        "neoEvents": {
          "description": "DEPRECATED - List of actions configured on a tool. Either this or actions field is required. If both are present, actions field will take precedence.",
          "items": {
            "properties": {
              "actionType": {
                "description": "Tool event type",
                "type": "string"
              },
              "blockingTriggers": {
                "description": "List of blocking triggers IDs",
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "data": {
                "description": "Event payload",
                "type": "object"
              },
              "firingTriggers": {
                "description": "List of firing triggers IDs",
                "items": {
                  "type": "string"
                },
                "minItems": 1,
                "type": "array"
              }
            },
            "required": [
              "actionType",
              "blockingTriggers",
              "firingTriggers",
              "data"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "permissions": {
          "description": "List of permissions granted to the component",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "settings": {
          "additionalProperties": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "boolean"
              }
            ]
          },
          "description": "Tool's settings",
          "type": "object"
        }
      },
      "required": [
        "component",
        "settings",
        "permissions"
      ]
    }
  ]
}