schema.json

{
	"$id": "https://msstack.grydtech.com/schema",
	"$schema": "http://json-schema.org/draft-07/schema",
	"title": "MSstack Model Specification",
	"description": "Model specification for MSstack. This schema is the standard followed by the model for generating business processes and creating microservices.",
	"type": "object",
	"required": ["entities", "requests", "responses", "events", "contracts", "version"],
	"properties": {
		"version": {
			"title": "Version",
			"description": "The veresion of the schema",
			"type": "string"
		},
		"entities": {
			"title": "Entities",
			"description": "The entities involved in a business process",
			"type": "array",
			"items": { "$ref": "#/definitions/entity" }
		},
		"events": {
			"title": "Events",
			"description": "The events that propagate the business processes.",
			"type": "array",
			"items": { "$ref": "#/definitions/event" }
		},
		"requests": {
			"title": "Requests",
			"description": "The types of requests that the application can accept",
			"type": "array",
			"items": { "$ref": "#/definitions/request" }
		},
		"responses": {
			"title": "Responses",
			"description": "The types of responses that the application can provide",
			"type": "array",
			"items": { "$ref": "#/definitions/response" }
		},
		"contracts": {
			"title": "Contracts",
			"description": "The types of contracts that the application can execute within a business process",
			"type": "array",
			"items": { "$ref": "#/definitions/contract" }
		}
	},
	"definitions": {
		"field": {
			"title": "Field",
			"description": "The schema for a field in MSstack",
			"type": "object",
			"required": ["name", "type", "constraints"],
			"propertyNames": true,
			"properties": {
				"name": {
					"title": "Name",
					"description": "Name of the field",
					"type": "string"
				},
				"type": {
					"title": "Type",
					"description": "The type of the field",
					"anyOf": [
						{ "enum": ["array", "boolean", "integer", "null", "number", "object", "string"] },
						{
							"type": "string",
							"format": "uri-reference"
						}
					]
				},
				"constraints": {
					"title": "Constraints",
					"description": "The behavior of the field as defined by the set of constraints",
					"type": "array",
					"items": {
						"enum": ["NOT_NULL", "UNIQUE", "PRIMARY_KEY"]
					}
				}
			}
		},
		"entity": {
			"title": "Entity",
			"description": "The schema for an entity in MSstack",
			"type": "object",
			"propertyNames": true,
			"properties": {
				"name": {
					"title": "Name",
					"description": "The name of the Entity",
					"type": "string"
				},
				"fields": {
					"title": "Fields",
					"description": "The fields belonging to an entity",
					"type": "array",
					"items": { "$ref": "#/definitions/field" }
				}
			}
		},
		"event": {
			"title": "Event",
			"description": "The schema for an event in MSstack",
			"type": "object",
			"propertyNames": true,
			"properties": {
				"name": {
					"title": "Name",
					"description": "The name of the event",
					"type": "string"
				},
				"entity": {
					"title": "Entity",
					"description": "A reference to the entity that this event is applicable to",
					"type": "string",
					"format": "uri-reference"
				},
				"fields": {
					"title": "Fields",
					"description": "The fields belonging to an event",
					"type": "array",
					"items": { "$ref": "#/definitions/field" }
				}
			}
		},
		"request": {
			"title": "Request",
			"description": "The schema for a request in MSstack",
			"type": "object",
			"propertyNames": true,
			"properties": {
				"name": {
					"title": "Name",
					"description": "The name of the request",
					"type": "string"
				},
				"entity": {
					"title": "Entity",
					"description": "A reference to the primary entity that this request applies to",
					"type": "string",
					"format": "uri-reference"
				},
				"fields": {
					"title": "Fields",
					"description": "The fields belonging to a request",
					"type": "array",
					"items": { "$ref": "#/definitions/field" }
				}
			}
		},
		"response": {
			"title": "Response",
			"description": "The schema for a response in MSstack",
			"type": "object",
			"propertyNames": true,
			"properties": {
				"name": {
					"title": "Name",
					"description": "The name of the response",
					"type": "string"
				},
				"entity": {
					"title": "Entity",
					"description": "A reference to the primary entity that this response provides information about",
					"type": "string",
					"format": "uri-reference"
				},
				"fields": {
					"title": "Fields",
					"description": "The fields belonging to this response",
					"type": "array",
					"items": {
						"$ref": "#/definitions/field"
					}
				}
			}
		},
		"contract": {
			"title": "Contract",
			"description": "The schema for a contract in MSstack",
			"type": "object",
			"propertyNames": true,
			"properties": {
				"name": {
					"title": "Name",
					"description": "The name of the contract",
					"type": "string"
				},
				"description": {
					"title": "Description",
					"description": "A long description of the contract. This description is rendered into a comment in the code generated using this model",
					"type": "string"
				},
				"entity": {
					"title": "Entity",
					"description": "A reference to the entity that this contract applies to. A contract can only have one entity that it is applied to",
					"type": "string",
					"format": "uri-reference"
				},
				"type": {
					"title": "Type",
					"description": "The type of the contract. A contract can be of either COMMAND or an EVENT",
					"enum": ["COMMAND", "EVENT"]
				},
				"consumes": {
					"title": "Consumes",
					"description": "The type of requests or events that this contract consumes",
					"type": "string",
					"format": "uri-reference"
				},
				"produces": {
					"title": "Produces",
					"description": "The types of events or responses that this contract produces. They are categorized into two states, on success or on failure.",
					"type": "object",
					"properties": {
						"on_success": {
							"title": "On Success",
							"description": "The outputs that the contract produces on success",
							"type": "array",
							"items": [{ "type": "string", "format": "uri-reference" }]
						},
						"on_failure": {
							"title": "On Failure",
							"description": "The outputs that the contract produces on failure",
							"type": "array",
							"items": [
								{
									"type": "string",
									"format": "uri-reference"
								}
							]
						}
					}
				}
			}
		}
	}
}