automations-export-schema

Copied to Clipboard

{ "$id": "automations-export-schema", "title": "Automation Schema Document", "description": "an automation catalog document", "type": "object", "properties": { "_id": { "$ref": "common-ops-schema#/definitions/ObjectId" }, "name": { "$ref": "common-ops-schema#/definitions/name" }, "description": { "$ref": "#/definitions/description" }, "componentType": { "description": "The type of component.", "oneOf": [ { "const": "workflows" }, { "type": "null" } ] }, "componentName": { "description": "The unique name for the component type", "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "triggers": { "type": "array", "items": { "oneOf": [ { "$ref": "endpoint-schema-export" }, { "$ref": "eventSystem-schema-export" }, { "$ref": "manual-schema-export" }, { "$ref": "schedule-schema-export" } ] } }, "gbac": { "type": "object", "description": "Object containing lists of unique levels of group based access. By default these lists are empty.", "properties": { "write": { "type": "array", "description": "An array of groups that have write access to the document.", "items": { "$ref": "#/definitions/dereferencedGroup" } }, "read": { "type": "array", "description": "An array of groups that have read access to the document.", "items": { "$ref": "#/definitions/dereferencedGroup" } } }, "required": [ "write", "read" ], "additionalProperties": false }, "created": { "$ref": "common-ops-schema#/definitions/ISODate" }, "createdBy": { "type": "string" }, "lastUpdated": { "$ref": "common-ops-schema#/definitions/ISODate" }, "lastUpdatedBy": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false, "definitions": { "description": { "type": "string", "examples": [ "A description about an Automation" ] }, "dereferencedGroup": { "type": "object", "properties": { "provenance": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "provenance", "name", "description" ] } } }