docsight-modules/registry.schema.json at main · itsDNNS/docsight-modules · 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
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "required": ["modules"],
  "properties": {
    "modules": {
      "type": "array",
      "items": {
        "type": "object",
        "required": ["id", "name", "description", "author", "repo", "version", "min_app_version", "type", "download_url"],
        "properties": {
          "id": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_.]+$",
            "description": "Unique module ID (e.g., community.pingtest)"
          },
          "name": {
            "type": "string",
            "description": "Human-readable module name"
          },
          "description": {
            "type": "string",
            "description": "Short description of what the module does"
          },
          "author": {
            "type": "string",
            "description": "GitHub username of the module author"
          },
          "repo": {
            "type": "string",
            "format": "uri",
            "description": "URL of the module's GitHub repository"
          },
          "version": {
            "type": "string",
            "pattern": "^\\d+\\.\\d+\\.\\d+$",
            "description": "Semantic version (e.g., 1.0.0)"
          },
          "min_app_version": {
            "type": "string",
            "description": "Minimum DOCSight version required (e.g., 2026.2)"
          },
          "type": {
            "type": "string",
            "enum": ["integration", "analysis", "theme"],
            "description": "Module type"
          },
          "download_url": {
            "type": "string",
            "format": "uri",
            "description": "GitHub Contents API URL for downloading the module directory"
          },
          "verified": {
            "type": "boolean",
            "default": false,
            "description": "Whether the module has been reviewed by the DOCSight team"
          }
        },
        "additionalProperties": false
      }
    }
  }
}