lua-scripts/scripts.schema.json at main · EdgeTX/lua-scripts · 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
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "EdgeTX Lua Scripts Gallery - scripts.json",
  "description": "Schema for scripts.json. Also the canonical source for the known 'category' and 'tags' vocabularies, read and written at runtime by tools/sync_issue_template_options.py to keep the Issue Form templates in sync with actual usage in scripts.json. 'category.examples' and 'tags.items.examples' are machine-generated - do not hand-edit them, they will be overwritten on the next sync. category.examples grows monotonically (never auto-pruned); tags.items.examples is a pure snapshot of current usage (shrinks when a tag falls out of use).",
  "type": "array",
  "items": {
    "type": "object",
    "title": "ScriptEntry",
    "required": [
      "name",
      "category",
      "description",
      "infourl",
      "tags"
    ],
    "properties": {
      "name": {
        "type": "string",
        "minLength": 1,
        "description": "Display name as shown in the gallery."
      },
      "category": {
        "type": "string",
        "minLength": 1,
        "description": "Gallery category - drives the site's top-level navigation tabs. Machine-generated examples list below (monotonic add-only, see tools/sync_issue_template_options.py).",
        "examples": [
          "Audio & Media",
          "Flight Controller Config",
          "Games & Fun",
          "GPS & Mapping",
          "Logging & Analysis",
          "Radio Tools",
          "Telemetry & Widgets"
        ]
      },
      "description": {
        "type": "string",
        "minLength": 1,
        "description": "Short 1-3 sentence description of the script."
      },
      "infourl": {
        "type": "string",
        "format": "uri",
        "description": "Link to the project page, GitHub repo, or documentation. Must start with http:// or https:// (enforced by tools/validate_scripts.py and tools/issue_to_scripts.py, not by this schema)."
      },
      "images": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Screenshot references: local ASSETS/ paths or external image URLs."
      },
      "tags": {
        "type": "array",
        "minItems": 1,
        "items": {
          "type": "string",
          "minLength": 1,
          "description": "Machine-generated examples list below (current usage snapshot, see tools/sync_issue_template_options.py).",
          "examples": [
            "ardupilot",
            "battery",
            "betaflight",
            "black-and-white",
            "bluetooth",
            "color",
            "crawler",
            "crossfire",
            "expresslrs",
            "fixed-wing",
            "game",
            "ghost",
            "gps",
            "heli",
            "inav",
            "logging",
            "multi-protocol",
            "quad",
            "rotorflight",
            "script",
            "spektrum",
            "telemetry",
            "tool",
            "widget"
          ]
        }
      }
    },
    "additionalProperties": true
  }
}