MOSDEXSchemaV2-0.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "$id": "https://github.com/JeremyBloom/Optimization-Data-Exchange/blob/master/MOSDEX-2.0/MOSDEXSchemaV2-0.json",
  
  "definitions": {
    
    "Module": {
      "title": "Module",
      "description": "The syntax of a MOSDEX Module",
      "type": "object",
      "properties": {
        "NAME": {"type": "string"},
        "CLASS": {"type": "string"},
        "KIND": {"type": "string"},
        "STAGE": {"type": "integer", "minimum": 0},
        "HEADING": {"$ref": "#/definitions/Heading"},
        "SOLVER_PARAMETERS": {"$ref": "#/definitions/SolverParameters"},
        "PATHS": {"type": "object", "additionalProperties": {"$ref": "#/definitions/ArrayOfStrings"}},
        "FOR_EACH": {"$ref": "#/definitions/ForEach"},
        "TABLES": {"type": "array", "items": {"$ref": "#/definitions/Table"}, "minItems": 1}
      },
      "additionalProperties": true,
      "required": ["NAME","CLASS", "HEADING", "TABLES"]
    },
  
    "ArrayOfStrings": {
      "title": "ArrayOfStrings",
      "oneOf": [
        {"type": "string"},
        {"type": "array", "items": {"type": "string"}}
      ]
    },
    
    "Heading": {
      "title": "Heading",
      "type": "object",
      "properties": {
        "DESCRIPTION": {"$ref": "#/definitions/ArrayOfStrings"},
        "VERSION": {"$ref": "#/definitions/ArrayOfStrings"},
        "REFERENCE": {"$ref": "#/definitions/ArrayOfStrings"},
        "AUTHOR": {"$ref": "#/definitions/ArrayOfStrings"},
        "NOTICES": {"$ref": "#/definitions/ArrayOfStrings"},
        "MATH": {"$ref": "#/definitions/ArrayOfStrings"}
      },
      "required": ["DESCRIPTION"],
      "additionalProperties": {"$ref": "#/definitions/ArrayOfStrings"}
    },

    "SolverParameters": {
      "title": "SolverParameters",
      "type": "object",
      "additionalProperties": {"type": "object"}
    },
    
    "ForEach": {
      "title": "ForEach",
      "description": "For each record with field name in table",
      "type": "object",
      "additionalProperties": {"type": "string"}
    },
    
    "Table": {
      "title": "Table",
      "description": "The syntax of a MOSDEX general table object",
      "type": "object",
      "properties": {
        "NAME": {"type": "string"},
        "CLASS": {"type": "string"},
        "KIND" : {"type": "string"},
        "HEADING": {"$ref": "#/definitions/Heading"},
        "SCHEMA": {"$ref": "#/definitions/Schema"},
        "INSTANCE": {"$ref": "#/definitions/Instance"},
        "QUERY": {"$ref": "#/definitions/Query"},
        "INITIALIZE": {"$ref": "#/definitions/Query"},
        "APPEND": {"$ref": "#/definitions/Query"},
        "REVISE": {"$ref": "#/definitions/Query"}
      },
      "required": ["NAME","CLASS", "KIND"],
      "oneOf": [
        {"required": ["INSTANCE"]},
        {"required": ["QUERY"]},
        {"required": ["INITIALIZE", "APPEND"]},
        {"required": ["INITIALIZE", "REVISE"]}
      ],
      "dependencies": {
        "INSTANCE": ["SCHEMA"]
      },
      "additionalProperties": true
    },
    
    "Schema": {
      "title": "Schema",
      "type": "object",
      "properties": {
        "FIELDS": {"type": "array", "items": {"type": "string"}, "uniqueItmes": true},
        "TYPES": {"type":  "array", "items": {"type": "string"}}
      },
      "required": ["FIELDS", "TYPES"],
      "additionalProperties": {"$ref": "#/definitions/ArrayOfStrings"}
    },
    
    "Instance": {
      "title": "Instance",
      "type": "array",
      "items": {"$ref": "#/definitions/Record"}
    },
    
    "Record": {
      "title": "Record",
      "type": "array",
      "items": {"type": ["string","number", "null"]}
    },
    
    "Query": {
      "title": "Query",
      "type": "object",
      "additionalProperties": {"$ref": "#/definitions/Predicate"}
    },
    
    "Predicate": {
      "title": "Predicate",
      "oneOf": [
        {"$ref": "#/definitions/ArrayOfStrings"},
        {"$ref": "#/definitions/Query"}
      ]
    }
  },

  "title": "MOSDEXFile",
  "description": "The syntax of MOSDEX: Mathematical Optimization Solver Data EXchange, v 2-0. Copyright © 2022 Jeremy A. Bloom",
  "type": "object",
  "properties": {
    "SYNTAX": {"type": "string", "format": "uri"},
    "MODULES": {"type": "array","items": {"$ref": "#/definitions/Module" }, "minItems": 1}
  },
  "required": ["SYNTAX", "MODULES"],
  "additionalProperties": true
  
}