noflo/graph-schema.json

Flow-Based Programming environment for JavaScript

{
  "name": "graph",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "properties": {
      "type": "object",
      "description": "User-defined properties attached to the graph.",
      "additionalProperties": true,
      "properties": {
        "name": {
          "type": "string"
        }
      }
    },
    "inports": {
      "type": "object",
      "description": "Exported inports of the graph",
      "additionalProperties": false,
      "patternProperties": {
        "[a-z0-9]+": {
          "type": "object",
          "properties": {
            "process": {
              "type": "string"
            },
            "port": {
              "type": "string"
            },
            "metadata": {
              "type": "object",
              "additionalProperties": true
            }
          }
        }
      }
    },
    "outports": {
      "type": "object",
      "description": "Exported outports of the graph",
      "additionalProperties": false,
      "patternProperties": {
        "[a-z0-9]+": {
          "type": "object",
          "properties": {
            "process": {
              "type": "string"
            },
            "port": {
              "type": "string"
            },
            "metadata": {
              "type": "object",
              "additionalProperties": true
            }
          }
        }
      }
    },
    "groups": {
      "type": "array",
      "description": "List of groups of processes",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string"
          },
          "nodes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "metadata": {
            "additionalProperties": true
          }
        }
      }
    },
    "processes": {
      "type": "object",
      "description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.",
      "additionalProperties": false,
      "patternProperties": {
        "[a-zA-Z0-9_]+": {
          "type": "object",
          "properties": {
            "component": {
              "type": "string"
            },
            "metadata": {
              "type": "object",
              "additionalProperties": true
            }
          }
        }
      }
    },
    "connections": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "src": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "process": { "type": "string" },
              "port": { "type": "string" }
            }
          },
          "tgt": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "process": { "type": "string" },
              "port": { "type": "string" }
            }
          },
          "data": {},
          "metadata": {
            "type": "object",
            "additionalProperties": true
          }
        }
      }
    }
  }
}