opencmd-specification/opencmd.schema.json at main · opencommand/opencmd-specification · 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
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "OpenCmd Specification",
    "type": "object",
    "required": [
        "name",
        "version",
        "vendor"
    ],
    "properties": {
        "name": {
            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9_-]*$",
            "description": "The command name"
        },
        "version": {
            "type": "string",
            "pattern": "^\\d+\\.\\d+\\.\\d+$",
            "description": "OpenCmd version (e.g., 1.0.0)"
        },
        "vendor": {
            "type": "string",
            "description": "The vendor or origin of the command"
        },
        "options": {
            "type": "array",
            "items": {
                "type": "object",
                "required": [
                    "name",
                    "type"
                ],
                "properties": {
                    "name": {
                        "type": "string",
                        "description": "Long-form option name (e.g., --output)"
                    },
                    "short": {
                        "type": "string",
                        "pattern": "^-[a-zA-Z]$",
                        "description": "Short option (e.g., -o)"
                    },
                    "type": {
                        "type": "string",
                        "enum": [
                            "str",
                            "num",
                            "bool",
                            "enum",
                            "list",
                            "date",
                            "map",
                            "object",
                            "command"
                        ],
                        "description": "The data type of the option"
                    },
                    "description": {
                        "type": "string"
                    }
                }
            }
        }
    }
}