openquest-content-db/schema.json at main · CreatorOS/openquest-content-db · 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
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Schema for the metadata of the quests on different protocols",
  "properties": {
    "build-on-<name-of-protocol>": {
      "type": "object",
      "properties": {
        "trackName": {
          "type": "string",
          "description": "Name of the track"
        },
        "protocol": {
          "type": "string",
          "description": "Name of the protocol"
        },
        "cardThumbnail": {
          "type": "string",
          "description": "Thumbnail image name stored in assets/thumbs e.g. eth.png"
        },
        "desc": {
          "type": "string",
          "description": "Short one-line description of the protocol"
        },
        "quests": {
          "type": "array",
          "items": [
            {
              "type": "object",
              "properties": {
                "slug": {
                  "type": "string",
                  "description": "This shows up in url path. Same as questName but all lowercase and joined using dashes -"
                },
                "questName": {
                  "type": "string",
                  "description": "Name of the quest"
                },
                "github_url": {
                  "type": "string",
                  "description": "Raw github url of the branch where the quest content resides"
                },
                "level": {
                  "type": "string",
                  "description": "The difficulty level of the quest either Beginner, Intermediate or Advanced"
                },
                "desc": {
                  "type": "string",
                  "description": "Short description of what the learner should expect to learn from this quest"
                }
              },
              "required": [
                "slug",
                "questName",
                "github_url",
                "level",
                "desc"
              ]
            }
          ]
        }
      },
      "required": [
        "trackName",
        "protocol",
        "cardThumbnail",
        "desc",
        "quests"
      ]
    }
  },
  "required": [
    "build-on-<name-of-protocol>"
  ]
}