/
plugin.schema.json
194 lines (194 loc) · 5.09 KB
/
plugin.schema.json
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
{
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"type": "object",
"properties": {
"history": {
"description": "Definition of the document history.",
"type": "array",
"items": {
"description": "Definition of a changelog entry.",
"type": "object",
"properties": {
"version": {
"description": "Spec version",
"type": "string"
},
"date": {
"description": "Spec date.",
"type": "string"
},
"comment": {
"description": "Comment on the changes.",
"type": "string"
}
},
"required": [
"version",
"date",
"comment"
]
}
},
"info": {
"description": "Meta information about the plugin.",
"type": "object",
"properties": {
"title": {
"description": "Name of the plugin.",
"type": "string"
},
"callsign": {
"description": "Plugin callsign.",
"type": "string"
},
"locator": {
"description": "Name of the plugin SO.",
"type": "string"
},
"class": {
"description": "Name of the plugin class.",
"type": "string"
},
"version": {
"description": "Current version of the plugin API.",
"type": "string"
},
"scope": {
"description": "Description of scope of the spec.",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"terms": {
"description": "Definition of terms used in the spec.",
"type": "array",
"items": {
"description": "Definition of a term.",
"type": "object",
"properties": {
"term": {
"description": "Term.",
"type": "string"
},
"comment": {
"description": "Comment.",
"type": "string"
}
},
"required": [
"name",
"comment"
]
}
},
"acronyms": {
"description": "Definition of acronyms/abbreviations used in the spec.",
"type": "array",
"items": {
"description": "Definition of an acronym or abbreviation.",
"type": "object",
"properties": {
"name": {
"description": "Acronym.",
"type": "string"
},
"comment": {
"description": "Comment.",
"type": "string"
}
},
"required": [
"name",
"comment"
]
}
},
"standards": {
"description": "Description of standards referred in the documentation.",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"description": {
"description": "Detailed description of the the plugin.",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"required": [
"title",
"version"
]
},
"configuration": {
"description": "Definitions of configurations.",
"type": "object",
"patternProperties": {
"^.*$": {
"description": "Definition of a configuration.",
"type": "object",
"properties": {
"summary": {
"description": "Short summary of the configuration.",
"type": "string"
},
"description": {
"description": "Longer description of the configuration.",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"params": {
"description": "JSON-Schema of the configuration properties.",
"type": "object",
"$ref": "https://json-schema.org/draft/2020-12/schema#"
}
},
"required": [
"summary"
]
}
}
},
"interface": {
"description": "The plugins JSON-RPC interface",
"$ref": "interface.schema.json#"
}
},
"required": [
"info"
]
}