ModuleDescriptor.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "ModuleDescriptor.json",
  "title": "ModuleDescriptor",
  "description": "A FOLIO Module",
  "type": "object",
  "additionalProperties" : false,
  "properties": {
    "id": {
      "description": "Module ID with format product-semver",
      "type": "string"
    },
    "name": {
      "description": "Short name for module (does not include version)",
      "type": "string"
    },
    "replaces": {
      "description": "List of modules that this replaces",
      "type": "array",
      "items": {
        "description": "Module name - without semantic version",
        "type": "string"
      }
    },
    "tags" : {
      "description": "Module tags",
      "type" : ["array", "null"],
      "items" : {
        "description": "Module tag",
        "type": "string"
      }
    },
    "requires": {
      "description": "Required interfaces",
      "type": ["array", "null"],
      "items": {
        "$ref": "InterfaceReference.json"
      }
    },
    "provides": {
      "description": "Provided interfaces",
      "type": ["array", "null"],
      "items": {
        "$ref": "InterfaceDescriptor.json"
      }
    },
    "optional": {
      "description": "Optional interfaces",
      "type": ["array", "null"],
      "items": {
        "$ref": "InterfaceReference.json"
      }
    },
    "filters": {
      "description": "Provided filters",
      "type": "array",
      "items": {
        "$ref": "RoutingEntry.json"
      }
    },
    "permissionSets": {
      "description": "Module Permission Sets",
      "type": ["array", "null"],
      "items": {
        "$ref": "Permission.json"
      }
    },
    "env" : {
      "description": "Supported environment variables",
      "$ref" : "EnvEntryList.json"
    },
    "metadata" : {
      "description": "Module Metadata (any object)",
      "type" : "object"
    },
    "uiDescriptor": {
      "description": "UI module descriptor",
      "$ref": "UiModuleDescriptor.json"
    },
    "launchDescriptor": {
      "description": "Default deployment for this module",
      "$ref": "LaunchDescriptor.json"
    }
  },
  "required": ["id"]
}