source-watcher-api/pipeline.schema.json at master · SourceWatcher/source-watcher-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/TheCocoTeam/source-watcher-api/master/pipeline.schema.json",
  "title": "Source Watcher Pipeline",
  "description": "A Source Watcher pipeline definition: an ordered list of extractor, transformer, and loader steps.",
  "type": "object",
  "required": ["steps"],
  "additionalProperties": false,
  "properties": {
    "$schema": {
      "type": "string",
      "description": "JSON Schema reference for this file."
    },
    "steps": {
      "type": "array",
      "description": "Ordered list of pipeline steps. Must contain at least one extractor and one loader.",
      "minItems": 1,
      "items": {
        "$ref": "#/definitions/step"
      }
    }
  },
  "definitions": {
    "step": {
      "type": "object",
      "required": ["type", "name"],
      "additionalProperties": false,
      "properties": {
        "type": {
          "type": "string",
          "enum": ["extractor", "execution-extractor", "transformer", "loader"],
          "description": "The role of this step in the pipeline."
        },
        "name": {
          "type": "string",
          "minLength": 1,
          "description": "The core step name (e.g. Csv, Json, ConvertCase, Database)."
        },
        "options": {
          "type": "object",
          "description": "Step-specific configuration options.",
          "additionalProperties": true
        },
        "x": {
          "type": "number",
          "description": "Canvas X position (used by the board UI, ignored by the API)."
        },
        "y": {
          "type": "number",
          "description": "Canvas Y position (used by the board UI, ignored by the API)."
        }
      }
    }
  }
}