summaryrefslogtreecommitdiff
path: root/data/schemas/keycodes.jsonschema
blob: df6ce95a83beb2876c9644be23daa8a618bebc8c (plain)
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
{
    "$schema": "https://json-schema.org/draft/2020-12/schema#",
    "$id": "qmk.keycodes.v1",
    "title": "Keycode Information",
    "type": "object",
    "definitions": {
        "define": {
            "type": "string",
            "minLength": 2,
            "maxLength": 50,
            "pattern": "^[A-Z][A-Zs_0-9]*$"
        }
    },
    "properties": {
        "ranges": {
            "type": "object",
            "propertyNames": {
                "type": "string"
            },
            "additionalProperties": {
                "type": "object",
                "required": [
                    "define"
                ],
                "properties": {
                    "define": {"$ref": "#/definitions/define"}
                }
            }
        },
        "keycodes": {
            "type": "object",
            "propertyNames": {
                "$ref": "qmk.definitions.v1#/hex_number_4d"
            },
            "additionalProperties": {
                "type": "object", // use 'qmk.definitions.v1#/keycode_decl' when problem keycodes are removed
                "required": [
                    "key"
                ],
                "properties": {
                    "key": {"$ref": "#/definitions/define"},
                    "aliases": {
                        "type": "array",
                        "minItems": 1,
                        "items": {
                            "type": "string"
                        }
                    }
                }
            }
        }
    }
}