rate-limiter/roadmap-schema.json at main · Maatify/rate-limiter · 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
89
90
91
92
93
94
95
96
97
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Maatify Roadmap Schema",
  "type": "object",

  "required": ["roadmap_version", "project", "phases"],

  "properties": {
    "roadmap_version": {
      "type": "string",
      "pattern": "^\\d+\\.\\d+\\.\\d+$"
    },

    "project": {
      "type": "string",
      "description": "The name of the project this roadmap describes."
    },

    "note": {
      "type": "string"
    },

    "core_dependencies": {
      "type": "object",
      "description": "Optional metadata describing required contracts/libraries for this project.",
      "additionalProperties": true
    },

    "phases": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "required": ["id", "title", "version", "status", "summary", "tasks", "outputs"],
        "properties": {
          "id": {
            "type": "string",
            "pattern": "^phase[0-9]+$"
          },

          "title": {
            "type": "string"
          },

          "version": {
            "type": "string",
            "pattern": "^\\d+\\.\\d+\\.\\d+$"
          },

          "status": {
            "type": "string",
            "enum": ["pending", "in_progress", "completed"]
          },

          "summary": {
            "type": "string"
          },

          "tasks": {
            "type": "array",
            "items": { "type": "string" },
            "minItems": 1
          },

          "tests": {
            "type": "array",
            "items": { "type": "string" }
          },

          "outputs": {
            "type": "array",
            "items": { "type": "string" },
            "minItems": 1
          },

          "depends_on": {
            "type": "array",
            "items": { "type": "string" }
          },

          "architecture": {
            "type": "array",
            "items": { "type": "string" }
          },

          "changes_needed": {
            "type": "array",
            "items": { "type": "string" }
          }
        },
        "additionalProperties": true
      }
    }
  },

  "additionalProperties": false
}