slashparse/schema.json at master · ericjaystevens/slashparse · 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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
{
  "$id": "https://example.com/person.schema.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SlashCommand",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The Name of the Slash Command."
    },
    "description": {
      "type": "string",
      "description": "A description of what the slash command does"
    },
    "arguments": {
      "type": "array",
      "description": "Pass these to your slash command",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of argument of Slash command"
        },
        "argtype": {
          "type": "string",
          "description": "SlashParse built-in argument types",
          "enum": ["word", "number", "quoted text", "date", "time", "remaining text"]
        },
        "description": {
          "type": "string",
          "description": "Description of the argument being passed"
        },
        "errorMsg": {
          "type": "string",
          "description": "custom error message if argument does not meet requirements"
        },
        "position": {
          "type": "number",
          "description": "poition of the argument relative to the slash command"
        },
        "required": {
         "type": "boolean",
         "description": "If the arguemnt is required"
        }
      },
      "required": ["name", "argtype", "description"]
    },
    "subcommands": {
      "type": "array",
      "description": "A Sub command of the slash command, often a noun",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of sub command"
        },
        "description": {
          "type": "string",
          "description": "description of sub command"
        },
        "arguments": {
          "description": "Pass these to your slash sub command",
          "properties": {
            "name": {
              "type": "string",
              "description": "Name of argument of Slash sub command"
            },
            "argtype": {
              "type": "string",
              "description": "SlashParse built-in argument types",
              "enum": ["word", "number", "quoted text", "date", "time", "remaining text"]
            },
            "description": {
              "type": "string",
              "description": "Description of the argument being passed to the sub command"
            },
            "errorMsg": {
              "type": "string",
              "description": "custom error message if argument does not meet requirements"
            },
            "position": {
              "type": "number",
              "description": "poition of the argument relative to the slash sub command"
            },
            "required": {
            "type": "boolean",
            "description": "Is the arguemnt required?"
            }
          },
          "required": ["name", "argtype", "description"]
        },
        "subcommands": {
          "type": "array",
          "description": "a sub sub command",
          "properties": {
            "name": {
              "type": "string",
              "description": "Name of sub sub command, often an action word"
            },
            "description": {
              "type": "string",
              "description": "description of a sub sub command"
            },
            "arguments": {
              "description": "Pass these to your slash sub-sub command",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Name of argument of Slash sub-sub command"
                },
                "argtype": {
                  "type": "string",
                  "description": "SlashParse built-in argument types",
                  "enum": ["word", "number", "quoted text", "date", "time", "remaining text"]
                },
                "description": {
                  "type": "string",
                  "description": "Description of the argument being passed to the sub-sub command"
                },
                "errorMsg": {
                  "type": "string",
                  "description": "custom error message if argument does not meet requirements"
                },
                "position": {
                  "type": "number",
                  "description": "poition of the argument relative to the slash sub-sub command"
                },
                "required": {
                "type": "boolean",
                "description": "If the arguemnt is required"
                }
              },
              "required": ["name", "argtype", "description"]
            }
          },
          "required": ["name", "description"]
        }
      },
      "required": ["name", "description"]
    }
  },
  "required": ["name", "description"]
}