-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
component.schema
306 lines (306 loc) · 10.8 KB
/
component.schema
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://schemas.botframework.com/schemas/component/v1.0/component.schema",
"title": "JSON Schema definition for Bot Framework dialog schemas.",
"description": "In order to create a component for Bot Framework .dialog files you need to create a schema file describing your configuration that meets this definition. This extends http://json-schema.org/draft-07/schema#.",
"allOf": [
{
"$ref": "http://json-schema.org/draft-07/schema#"
},
{
"properties": {
"$policies": {
"type": "object",
"properties": {
"interactive": {
"title": "Interactive",
"description": "Dialog will wait for input.",
"type": "boolean",
"default": false
},
"nonInteractive": {
"title": "Non-interactive",
"description": "No child dialogs can wait for input.",
"type": "boolean",
"default": false
},
"lastAction": {
"title": "Last Action",
"description": "Dialog must be the last action in a list of actions.",
"type": "boolean",
"default": false
},
"requiresKind": {
"title": "Requires Kind",
"description": "There must be a child dialog of one of the included kinds or an extension of those kinds.",
"type": "array",
"items": {
"type": "string"
},
"default": []
}
}
},
"$role": {
"title": "$role",
"description": "Defines the roles played in the dialog schema one of [expression|interface|implements($kind)|extends($kind)].",
"oneOf": [
{
"$ref": "#/definitions/role"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/role"
}
}
]
},
"$kind": {
"title": "$kind",
"description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)",
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9.]*$"
}
}
}
],
"definitions": {
"role": {
"title": "$role",
"description": "Defines the role played in the dialog schema from [expression|interface|implements($kind)|extends($kind)].",
"type": "string",
"pattern": "^((expression)|(interface)|(implements\\([a-zA-Z][a-zA-Z0-9.]*\\))|(extends\\([a-zA-Z][a-zA-Z0-9.]*\\)))$"
},
"component": {
"properties": {
"$kind": {
"title": "Kind of dialog object",
"description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)",
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9.]*$"
},
"$designer": {
"title": "Designer information",
"type": "object",
"description": "Extra information for the Bot Framework Composer."
}
},
"required": [
"$kind"
],
"additionalProperties": false,
"patternProperties": {
"^\\$": {
"title": "Tooling property",
"description": "Open ended property for tooling."
}
}
},
"expression": {
"$role": "expression",
"type": "string",
"title": "Expression",
"description": "Expression to evaluate.",
"pattern": "^.*\\S.*",
"examples": [
"user.age > 13"
]
},
"equalsExpression": {
"$role": "expression",
"type": "string",
"title": "Expression",
"description": "Expression starting with =.",
"pattern": "^=.*\\S.*",
"examples": [
"=user.name"
]
},
"condition": {
"$role": "expression",
"title": "Boolean condition",
"description": "Boolean constant or expression to evaluate.",
"oneOf": [
{
"$ref": "#/definitions/expression"
},
{
"type": "boolean",
"title": "Boolean",
"description": "Boolean value.",
"default": true,
"examples": [
false
]
}
]
},
"booleanExpression": {
"$role": "expression",
"title": "Boolean or expression",
"description": "Boolean constant or expression to evaluate.",
"oneOf": [
{
"type": "boolean",
"title": "Boolean",
"description": "Boolean constant.",
"default": false,
"examples": [
false
]
},
{
"$ref": "#/definitions/equalsExpression",
"examples": [
"=user.isVip"
]
}
]
},
"numberExpression": {
"$role": "expression",
"title": "Number or expression",
"description": "Number constant or expression to evaluate.",
"oneOf": [
{
"type": "number",
"title": "Number",
"description": "Number constant.",
"default": 0,
"examples": [
15.5
]
},
{
"$ref": "#/definitions/equalsExpression",
"examples": [
"=dialog.quantity"
]
}
]
},
"integerExpression": {
"$role": "expression",
"title": "Integer or expression",
"description": "Integer constant or expression to evaluate.",
"oneOf": [
{
"type": "integer",
"title": "Integer",
"description": "Integer constant.",
"default": 0,
"examples": [
15
]
},
{
"$ref": "#/definitions/equalsExpression",
"examples": [
"=user.age"
]
}
]
},
"stringExpression": {
"$role": "expression",
"title": "String or expression",
"description": "Interpolated string or expression to evaluate.",
"oneOf": [
{
"type": "string",
"title": "String",
"description": "Interpolated string",
"pattern": "^(?!(=)).*",
"examples": [
"Hello ${user.name}"
]
},
{
"$ref": "#/definitions/equalsExpression",
"examples": [
"=concat('x','y','z')"
]
}
]
},
"arrayExpression": {
"$role": "expression",
"title": "Array or expression",
"description": "Array or expression to evaluate.",
"oneOf": [
{
"type": "array",
"title": "Array",
"description": "Array constant."
},
{
"$ref": "#/definitions/equalsExpression"
}
]
},
"objectExpression": {
"$role": "expression",
"title": "Object or expression",
"description": "Object or expression to evaluate.",
"oneOf": [
{
"type": "object",
"title": "Object",
"description": "Object constant."
},
{
"$ref": "#/definitions/equalsExpression"
}
]
},
"valueExpression": {
"$role": "expression",
"title": "Any or expression",
"description": "Any constant or expression to evaluate.",
"oneOf": [
{
"type": "object",
"title": "Object",
"description": "Object constant."
},
{
"type": "array",
"title": "Array",
"description": "Array constant."
},
{
"type": "string",
"title": "String",
"description": "Interpolated string.",
"pattern": "^(?!(=)).*",
"examples": [
"Hello ${user.name}"
]
},
{
"type": "boolean",
"title": "Boolean",
"description": "Boolean constant",
"examples": [
false
]
},
{
"type": "number",
"title": "Number",
"description": "Number constant.",
"examples": [
15.5
]
},
{
"$ref": "#/definitions/equalsExpression",
"examples": [
"=..."
]
}
]
}
}
}