app-directory/schemas/app.schema.json at caf16791dd66a313fd39f566dad73ca4c06e22f8 · LizardByte/app-directory · 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
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Featured App Schema",
  "description": "Schema for featured applications in the LizardByte app directory",
  "type": "object",
  "required": ["id", "name", "category", "description", "platforms"],
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (e.g., 'moonlight-qt')",
      "pattern": "^[a-z0-9-]+$"
    },
    "name": {
      "type": "string",
      "description": "Display name of the application"
    },
    "tagline": {
      "type": "string",
      "description": "Short one-liner description"
    },
    "description": {
      "type": "string",
      "description": "Full description of the application"
    },
    "category": {
      "type": "string",
      "description": "Category of the application (must match a category ID in the project's categories.json)"
    },
    "platforms": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": ["windows", "macos", "linux", "android", "ios", "web"]
      },
      "minItems": 1
    },
    "icon": {
      "type": "string",
      "format": "uri",
      "description": "URL to app icon (PNG, 512x512 recommended)"
    },
    "screenshots": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      },
      "description": "URLs to screenshots"
    },
    "links": {
      "type": "object",
      "properties": {
        "website": {
          "type": "string",
          "format": "uri"
        },
        "github": {
          "type": "string",
          "format": "uri"
        },
        "download": {
          "type": "string",
          "format": "uri"
        },
        "documentation": {
          "type": "string",
          "format": "uri"
        }
      }
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Searchable tags"
    },
    "featured": {
      "type": "boolean",
      "description": "Whether to highlight this app"
    },
    "compatibility": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "sunshine": {
          "type": "string",
          "description": "Compatible Sunshine versions (semver range)"
        }
      }
    }
  }
}