Open-Workflow-Library/schemas/workflow-metadata.schema.json at main · oxbshw/Open-Workflow-Library · 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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://open-workflow-library.dev/schemas/workflow-metadata.schema.json",
  "title": "Workflow Catalog Metadata",
  "description": "Indexed metadata for a single workflow in the catalog. Produced by the audit tool; consumed by the catalog, the wiki retrieval layer, and the future prompt-to-workflow generator.",
  "type": "object",
  "required": ["id", "title", "framework", "sourcePath", "status"],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "Stable identifier (typically derived from the source path).",
      "minLength": 1
    },
    "title": {
      "type": "string",
      "minLength": 1
    },
    "description": {
      "type": "string"
    },
    "framework": {
      "type": "string",
      "enum": [
        "n8n",
        "dify",
        "langgraph",
        "node-red",
        "make",
        "zapier",
        "pipedream",
        "airflow",
        "temporal",
        "unknown"
      ]
    },
    "category": {
      "type": "string",
      "description": "Subfolder or logical grouping the workflow belongs to."
    },
    "useCase": {
      "type": "string",
      "description": "Short, human-readable use-case label."
    },
    "integrations": {
      "type": "array",
      "items": { "type": "string" },
      "description": "Detected integrations / node types / service names."
    },
    "triggerType": {
      "type": "string",
      "enum": ["webhook", "cron", "manual", "event", "interval", "email", "unknown"]
    },
    "credentialsRequired": {
      "type": "array",
      "items": { "type": "string" },
      "description": "Symbolic names or detected categories of credentials. Never values."
    },
    "hasCodeNode": {
      "type": "boolean",
      "description": "Workflow contains an inline-code / function node."
    },
    "hasWebhook": {
      "type": "boolean",
      "description": "Workflow exposes a webhook endpoint."
    },
    "riskLevel": {
      "type": "string",
      "enum": ["low", "medium", "high", "unknown"]
    },
    "status": {
      "type": "string",
      "enum": ["raw", "indexed", "needs-review", "validated", "broken", "repaired", "deprecated"]
    },
    "sourcePath": {
      "type": "string",
      "description": "Path to the workflow file, relative to repository root."
    },
    "testedWith": {
      "type": "array",
      "items": { "type": "string" },
      "description": "Versions / environments the workflow has been confirmed against."
    },
    "notes": {
      "type": "string"
    }
  }
}