{ "$id": "resource-model-common", "description": "A repository of definitions used throughout resource models.", "definitions": { "name": { "type": "string", "description": "The name of the resource model", "examples": [ "VLAN Service", "EC2 Instance", "ServiceNow Ticket" ] }, "description": { "type": "string", "description": "Free-form text describing the resource model", "default": "", "examples": [ "This resource model represents something we use on a day-to-day basis.", "We use this to model one of the devices in our system.", "This model tracks one of the elements of our cloud infrastructure." ] }, "schema": { "description": "A draft-07 JSON Schema which defines the validation applied to instances of the resource model", "$ref": "draft-07-metaschema-strict-extended-formats" }, "action-name": { "description": "The name of the action", "type": "string", "examples": [ "Create", "Update", "Suspend", "Reboot" ] }, "action-identifier": { "description": "The identifier of an action", "$ref": "common#/definitions/hex-id" }, "action-type": { "description": "The type of the action", "enum": [ "import", "create", "update", "delete" ] }, "action-preTransformation": { "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/ObjectId" } ] }, "action-workflow": { "description": "The _id of the workflow to use as the implementation of this action.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/workflow-identifier" } ] }, "action-postTransformation": { "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/ObjectId" } ] }, "action": { "type": "object", "required": [ "_id", "name", "workflow", "preWorkflowJst", "postWorkflowJst", "type" ], "additionalProperties": false, "properties": { "_id": { "$ref": "#/definitions/action-identifier" }, "name": { "$ref": "#/definitions/action-name" }, "type": { "$ref": "#/definitions/action-type" }, "preWorkflowJst": { "$ref": "#/definitions/action-preTransformation" }, "workflow": { "$ref": "#/definitions/action-preTransformation" }, "postWorkflowJst": { "$ref": "#/definitions/action-postTransformation" } } }, "action-with-states-INACTIVE-FEATURE": { "type": "object", "required": [ "_id", "name", "workflow", "preWorkflowJst", "postWorkflowJst", "initialState", "exitStates", "type" ], "additionalProperties": false, "properties": { "_id": { "$ref": "#/definitions/action-identifier" }, "name": { "description": "The name of the action", "type": "string", "examples": [ "Create", "Update", "Suspend", "Reboot" ] }, "type": { "description": "The type of the action", "enum": [ "create", "update", "delete" ] }, "preWorkflowJst": { "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/ObjectId" } ] }, "postWorkflowJst": { "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/ObjectId" } ] }, "workflow": { "description": "The _id of the workflow to use as the implementation of this action.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/workflow-identifier" } ] }, "initialState": { "description": "The state that this action is valid from.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/state-identifier" } ] }, "exitStates": { "description": "A list of states which this action is permitted to transition an instance to. The actual exit state will be selected by the workflow at runtime.", "type": "array", "items": { "$ref": "common#/definitions/state-identifier" } } } }, "actionWithDereferencedSchemas": { "type": "object", "required": [ "_id", "name", "workflow", "preWorkflowJst", "postWorkflowJst", "type" ], "additionalProperties": false, "properties": { "_id": { "$ref": "#/definitions/action-identifier" }, "name": { "description": "The name of the action", "type": "string", "examples": [ "Create", "Update", "Suspend", "Reboot" ] }, "type": { "description": "The type of the action", "enum": [ "create", "update", "delete" ] }, "preWorkflowJst": { "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/ObjectId" } ] }, "postWorkflowJst": { "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/ObjectId" } ] }, "workflow": { "description": "The _id of the workflow to use as the implementation of this action.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/workflow-identifier" } ] }, "inputSchema": { "description": "The schema describing inputs to this action", "type": "object" }, "outputSchema": { "description": "The schema describing inputs to this action", "type": "object" } } }, "actionWithDereferencedSchemas-with-states-INACTIVE-FEATURE": { "type": "object", "required": [ "_id", "name", "workflow", "preWorkflowJst", "postWorkflowJst", "initialState", "exitStates", "type" ], "additionalProperties": false, "properties": { "_id": { "$ref": "#/definitions/action-identifier" }, "name": { "description": "The name of the action", "type": "string", "examples": [ "Create", "Update", "Suspend", "Reboot" ] }, "type": { "description": "The type of the action", "enum": [ "create", "update", "delete" ] }, "preWorkflowJst": { "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/ObjectId" } ] }, "postWorkflowJst": { "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/ObjectId" } ] }, "workflow": { "description": "The _id of the workflow to use as the implementation of this action.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/workflow-identifier" } ] }, "initialState": { "description": "The state that this action is valid from.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/state-identifier" } ] }, "exitStates": { "description": "A list of states which this action is permitted to transition an instance to. The actual exit state will be selected by the workflow at runtime.", "type": "array", "items": { "$ref": "common#/definitions/state-identifier" } }, "inputSchema": { "description": "The schema describing inputs to this action", "type": "object" }, "outputSchema": { "description": "The schema describing inputs to this action", "type": "object" } } }, "actionCreateData": { "type": "object", "required": [ "name", "workflow", "preWorkflowJst", "postWorkflowJst", "type" ], "additionalProperties": false, "properties": { "_id": { "$ref": "#/definitions/action-identifier" }, "name": { "description": "The name of the action", "type": "string", "examples": [ "Create", "Update", "Suspend", "Reboot" ] }, "type": { "description": "The type of the action", "enum": [ "create", "update", "delete" ] }, "preWorkflowJst": { "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/ObjectId" } ] }, "postWorkflowJst": { "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/ObjectId" } ] }, "workflow": { "description": "The _id of the workflow to use as the implementation of this action.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/workflow-identifier" } ] } } }, "actionCreateData-with-states-INACTIVE-FEATURE": { "type": "object", "required": [ "name", "workflow", "preWorkflowJst", "postWorkflowJst", "initialState", "exitStates", "type" ], "additionalProperties": false, "properties": { "_id": { "$ref": "#/definitions/action-identifier" }, "name": { "description": "The name of the action", "type": "string", "examples": [ "Create", "Update", "Suspend", "Reboot" ] }, "type": { "description": "The type of the action", "enum": [ "create", "update", "delete" ] }, "preWorkflowJst": { "description": "Optional transformation to be applied to incoming parameters before providing them to the workflow.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/ObjectId" } ] }, "postWorkflowJst": { "description": "Optional transformation to be applied to the workflow's outputs before updating the instance.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/ObjectId" } ] }, "workflow": { "description": "The _id of the workflow to use as the implementation of this action.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/workflow-identifier" } ] }, "initialState": { "description": "The state that this action is valid from.", "oneOf": [ { "type": "null" }, { "$ref": "common#/definitions/state-identifier" } ] }, "exitStates": { "description": "A list of states which this action is permitted to transition an instance to. The actual exit state will be selected by the workflow at runtime.", "type": "array", "minItems": 1, "items": { "$ref": "common#/definitions/state-identifier" } } } }, "actionsCreateData": { "type": "array", "items": { "$ref": "#/definitions/actionCreateData" } }, "actions": { "type": "array", "items": { "$ref": "#/definitions/action" } }, "actionsWithDereferencedSchemas": { "type": "array", "items": { "$ref": "#/definitions/actionWithDereferencedSchemas" } }, "state": { "type": "object", "required": [ "_id", "name", "type" ], "additionalProperties": false, "properties": { "_id": { "description": "State identifier. Must be a 4-digit hexadecimal string", "$ref": "common#/definitions/state-identifier" }, "name": { "description": "State name", "type": "string" }, "type": { "description": "State type. Determines how an instance may behave when in this state.", "enum": [ "active", "inactive", "error", "final" ] } } }, "states": { "description": "A list of states that apply to instances of this resource type.", "type": "array", "items": { "$ref": "#/definitions/state" } }, "schemaStringified": { "description": "A draft-07 JSON Schema which defines the validation applied to instances of the resource model, represented as a string", "type": "string" }, "created": { "description": "An ISO date string denoting when this resource model was created", "$ref": "common#/definitions/iso-date-string" }, "createdBy": { "description": "The account identifier of the user who created this resource model", "$ref": "common#/definitions/account-identifier" }, "createdByDereferenced": { "description": "The account identifier of the user who created this resource model", "$ref": "common-http#/definitions/dereferenced-account" }, "lastUpdated": { "description": "An ISO date string denoting when this resource model was last updated", "$ref": "common#/definitions/iso-date-string" }, "lastUpdatedBy": { "description": "The account identifier of the user who last updated this resource model", "$ref": "common#/definitions/account-identifier" }, "lastUpdatedByDereferenced": { "description": "The account identifier of the user who last updated this resource model", "$ref": "common-http#/definitions/dereferenced-account" } } }
2023.2 (latest)