@takeshape/schema 8.144.4 → 8.146.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/builtin-schema.d.ts.map +1 -1
- package/dist/builtin-schema.js +17 -0
- package/dist/get-is-leaf.d.ts +1 -1
- package/dist/get-is-leaf.d.ts.map +1 -1
- package/dist/get-is-leaf.js +3 -1
- package/dist/migration/index.d.ts +1 -0
- package/dist/migration/index.d.ts.map +1 -1
- package/dist/migration/index.js +4 -1
- package/dist/migration/to/v3.0.0.d.ts.map +1 -1
- package/dist/migration/to/v3.18.0.d.ts +5 -0
- package/dist/migration/to/v3.18.0.d.ts.map +1 -0
- package/dist/migration/to/v3.18.0.js +85 -0
- package/dist/mocks.d.ts.map +1 -1
- package/dist/mocks.js +4 -2
- package/dist/project-schema/index.d.ts +4 -1
- package/dist/project-schema/index.d.ts.map +1 -1
- package/dist/project-schema/index.js +20 -3
- package/dist/project-schema/latest.d.ts +4 -139
- package/dist/project-schema/latest.d.ts.map +1 -1
- package/dist/project-schema/migrate.d.ts.map +1 -1
- package/dist/project-schema/migrate.js +4 -0
- package/dist/project-schema/v3.18.0.d.ts +1334 -0
- package/dist/project-schema/v3.18.0.d.ts.map +1 -0
- package/dist/project-schema/v3.18.0.js +5 -0
- package/dist/refs.d.ts +14 -2
- package/dist/refs.d.ts.map +1 -1
- package/dist/refs.js +26 -0
- package/dist/relationships.d.ts +28 -2
- package/dist/relationships.d.ts.map +1 -1
- package/dist/relationships.js +234 -19
- package/dist/rewrite.d.ts.map +1 -1
- package/dist/rewrite.js +10 -2
- package/dist/schema-util.d.ts +1 -18
- package/dist/schema-util.d.ts.map +1 -1
- package/dist/schema-util.js +36 -120
- package/dist/schemas/index.d.ts +2 -2
- package/dist/schemas/index.d.ts.map +1 -1
- package/dist/schemas/index.js +6 -4
- package/dist/schemas/index.ts +4 -2
- package/dist/schemas/project-schema/latest.json +2175 -2195
- package/dist/schemas/project-schema/v3.18.0.json +2350 -0
- package/dist/schemas/project-schema.json +3 -0
- package/dist/template-shapes/templates.d.ts +5 -0
- package/dist/template-shapes/templates.d.ts.map +1 -1
- package/dist/template-shapes/templates.js +59 -28
- package/dist/template-shapes/where.d.ts +3 -4
- package/dist/template-shapes/where.d.ts.map +1 -1
- package/dist/template-shapes/where.js +32 -26
- package/dist/types/types.d.ts +42 -2
- package/dist/types/types.d.ts.map +1 -1
- package/dist/types/utils.d.ts +2 -0
- package/dist/types/utils.d.ts.map +1 -1
- package/dist/types/utils.js +9 -1
- package/dist/unions.d.ts.map +1 -1
- package/dist/unions.js +3 -1
- package/dist/util/detect-cycles.d.ts +3 -1
- package/dist/util/detect-cycles.d.ts.map +1 -1
- package/dist/util/detect-cycles.js +37 -28
- package/dist/util/form-config.d.ts +9 -0
- package/dist/util/form-config.d.ts.map +1 -0
- package/dist/util/form-config.js +97 -0
- package/dist/util/index.d.ts +1 -0
- package/dist/util/index.d.ts.map +1 -1
- package/dist/util/index.js +13 -0
- package/dist/validate.d.ts.map +1 -1
- package/dist/validate.js +75 -45
- package/es/builtin-schema.js +17 -0
- package/es/get-is-leaf.js +2 -1
- package/es/migration/index.js +3 -1
- package/es/migration/to/v3.18.0.js +72 -0
- package/es/mocks.js +4 -2
- package/es/project-schema/index.js +3 -1
- package/es/project-schema/migrate.js +5 -1
- package/es/project-schema/v3.18.0.js +1 -0
- package/es/refs.js +22 -1
- package/es/relationships.js +215 -19
- package/es/rewrite.js +10 -2
- package/es/schema-util.js +38 -119
- package/es/schemas/index.js +4 -3
- package/es/schemas/index.ts +4 -2
- package/es/schemas/project-schema/latest.json +2175 -2195
- package/es/schemas/project-schema/v3.18.0.json +2350 -0
- package/es/schemas/project-schema.json +3 -0
- package/es/template-shapes/templates.js +55 -29
- package/es/template-shapes/where.js +29 -23
- package/es/types/utils.js +8 -2
- package/es/unions.js +2 -1
- package/es/util/detect-cycles.js +36 -28
- package/es/util/form-config.js +85 -0
- package/es/util/index.js +2 -1
- package/es/validate.js +74 -46
- package/examples/latest/betzino.json +12383 -6066
- package/examples/latest/blog-schema.json +46 -25
- package/examples/latest/brewery-schema.json +14 -9
- package/examples/latest/complex-project-schema.json +442 -244
- package/examples/latest/complex-schema.json +17205 -0
- package/examples/latest/fabric-ecommerce.json +2 -2
- package/examples/latest/frank-and-fred-schema.json +5141 -2391
- package/examples/latest/klirr-schema.json +35445 -0
- package/examples/latest/massive-schema.json +1205 -640
- package/examples/latest/mill-components-schema.json +241 -113
- package/examples/latest/one-earth.json +14429 -0
- package/examples/latest/pet-oneof-array.json +2 -2
- package/examples/latest/post-schema.json +18 -11
- package/examples/latest/pruned-shopify-product-schema.json +2 -2
- package/examples/latest/real-world-schema.json +81 -41
- package/examples/latest/recursive-repeater-schema.json +14 -9
- package/examples/latest/recursive-schema.json +14 -9
- package/examples/latest/rick-and-morty-ast.json +138 -80
- package/examples/latest/rick-and-morty-graphql.json +78 -45
- package/examples/latest/rick-and-morty-rest.json +2 -2
- package/examples/latest/schema-with-repeater-draftjs.json +38 -23
- package/examples/latest/shape-books-v3_2_0.json +138 -80
- package/examples/latest/shape-books.json +138 -80
- package/examples/latest/shopify-lookbook.json +30 -16
- package/examples/latest/shopify-namespace-schema.json +364 -0
- package/examples/latest/shopify-store-with-widget.json +2 -2
- package/examples/latest/stripe-starter-resolved.json +14 -8
- package/examples/latest/user-schema-no-required.json +2 -2
- package/examples/latest/user-schema-with-defaults.json +2 -2
- package/examples/source/complex-schema.json +12760 -0
- package/examples/source/klirr-schema.json +27716 -0
- package/examples/source/one-earth.json +11897 -0
- package/examples/source/post-schema.json +0 -1
- package/package.json +5 -4
|
@@ -1,2370 +1,2350 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"$id": "https://schema.takeshape.io/project-schema/v3.18.0#",
|
|
4
|
+
"title": "Project Schema",
|
|
5
|
+
"definitions": {
|
|
6
|
+
"schemaArray": {
|
|
7
|
+
"title": "Schema Array",
|
|
8
|
+
"type": "array",
|
|
9
|
+
"minItems": 1,
|
|
10
|
+
"items": {
|
|
11
|
+
"$ref": "#/definitions/propertySchema"
|
|
12
|
+
}
|
|
13
|
+
},
|
|
14
|
+
"nonNegativeInteger": {
|
|
15
|
+
"title": "Non Negative Integer",
|
|
16
|
+
"type": "integer",
|
|
17
|
+
"minimum": 0
|
|
18
|
+
},
|
|
19
|
+
"nonNegativeIntegerDefault0": {
|
|
20
|
+
"title": "Non Negative Integer Default 0",
|
|
21
|
+
"allOf": [
|
|
22
|
+
{
|
|
23
|
+
"$ref": "#/definitions/nonNegativeInteger"
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"default": 0
|
|
12
27
|
}
|
|
28
|
+
]
|
|
29
|
+
},
|
|
30
|
+
"simpleTypes": {
|
|
31
|
+
"title": "Simple Types",
|
|
32
|
+
"enum": ["array", "boolean", "integer", "null", "number", "object", "string"]
|
|
33
|
+
},
|
|
34
|
+
"stringArray": {
|
|
35
|
+
"title": "String Array",
|
|
36
|
+
"type": "array",
|
|
37
|
+
"items": {
|
|
38
|
+
"type": "string"
|
|
13
39
|
},
|
|
14
|
-
"
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
40
|
+
"uniqueItems": true,
|
|
41
|
+
"default": []
|
|
42
|
+
},
|
|
43
|
+
"backreference": {
|
|
44
|
+
"title": "Back Reference",
|
|
45
|
+
"description": "A configuration object for a reverse reference in a relationship.",
|
|
46
|
+
"type": "object",
|
|
47
|
+
"properties": {
|
|
48
|
+
"enabled": {
|
|
49
|
+
"type": "boolean"
|
|
50
|
+
},
|
|
51
|
+
"name": {
|
|
52
|
+
"type": "string",
|
|
53
|
+
"pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$"
|
|
54
|
+
}
|
|
18
55
|
},
|
|
19
|
-
"
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
56
|
+
"additionalProperties": false,
|
|
57
|
+
"required": ["enabled"]
|
|
58
|
+
},
|
|
59
|
+
"mappingString": {
|
|
60
|
+
"title": "Mapping String",
|
|
61
|
+
"type": "string",
|
|
62
|
+
"pattern": "^[\\w-]+(?::[\\w-]+)+(?:\\.[\\w-]+)+$"
|
|
63
|
+
},
|
|
64
|
+
"fieldMapping": {
|
|
65
|
+
"title": "Field Mapping",
|
|
66
|
+
"oneOf": [
|
|
67
|
+
{
|
|
68
|
+
"$ref": "#/definitions/mappingString"
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
"type": "array",
|
|
72
|
+
"items": {
|
|
73
|
+
"$ref": "#/definitions/mappingString"
|
|
27
74
|
}
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
75
|
+
}
|
|
76
|
+
]
|
|
77
|
+
},
|
|
78
|
+
"refSchema": {
|
|
79
|
+
"title": "Ref Schema",
|
|
80
|
+
"type": "object",
|
|
81
|
+
"properties": {
|
|
82
|
+
"@ref": {
|
|
83
|
+
"$ref": "#/definitions/ref"
|
|
84
|
+
}
|
|
33
85
|
},
|
|
34
|
-
"
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
"
|
|
41
|
-
|
|
86
|
+
"required": ["@ref"]
|
|
87
|
+
},
|
|
88
|
+
"refSchemaLegacy": {
|
|
89
|
+
"title": "Ref Schema Legacy",
|
|
90
|
+
"type": "object",
|
|
91
|
+
"properties": {
|
|
92
|
+
"$ref": {
|
|
93
|
+
"$ref": "#/definitions/ref"
|
|
94
|
+
}
|
|
42
95
|
},
|
|
43
|
-
"
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
"minItems": 1
|
|
53
|
-
},
|
|
54
|
-
"type": {
|
|
96
|
+
"required": ["$ref"]
|
|
97
|
+
},
|
|
98
|
+
"shapeSchemaEnum": {
|
|
99
|
+
"title": "Shape Schema Enum",
|
|
100
|
+
"type": "object",
|
|
101
|
+
"properties": {
|
|
102
|
+
"enum": {
|
|
103
|
+
"type": "array",
|
|
104
|
+
"items": {
|
|
55
105
|
"type": "string"
|
|
56
106
|
},
|
|
57
|
-
"
|
|
58
|
-
|
|
59
|
-
"pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$"
|
|
60
|
-
}
|
|
61
|
-
},
|
|
62
|
-
"required": ["shapeIds"],
|
|
63
|
-
"additionalProperties": false
|
|
107
|
+
"minItems": 1
|
|
108
|
+
}
|
|
64
109
|
},
|
|
65
|
-
"
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
110
|
+
"additionalProperties": false,
|
|
111
|
+
"required": ["enum"]
|
|
112
|
+
},
|
|
113
|
+
"objectSchema": {
|
|
114
|
+
"title": "Object Schema",
|
|
115
|
+
"type": "object",
|
|
116
|
+
"allOf": [
|
|
117
|
+
{
|
|
118
|
+
"$ref": "#/definitions/propertySchema"
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
"properties": {
|
|
122
|
+
"type": {
|
|
123
|
+
"type": "string",
|
|
124
|
+
"const": "object"
|
|
125
|
+
},
|
|
126
|
+
"properties": {
|
|
127
|
+
"type": "object",
|
|
128
|
+
"additionalProperties": {
|
|
129
|
+
"$ref": "#/definitions/propertySchema"
|
|
130
|
+
}
|
|
131
|
+
}
|
|
72
132
|
},
|
|
73
|
-
"
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
133
|
+
"required": ["type", "properties"]
|
|
134
|
+
}
|
|
135
|
+
]
|
|
136
|
+
},
|
|
137
|
+
"returnShapeArraySchema": {
|
|
138
|
+
"title": "Return Shape Array Schema",
|
|
139
|
+
"type": "object",
|
|
140
|
+
"allOf": [
|
|
141
|
+
{
|
|
142
|
+
"$ref": "#/definitions/propertySchema"
|
|
77
143
|
},
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
144
|
+
{
|
|
145
|
+
"properties": {
|
|
146
|
+
"type": {
|
|
147
|
+
"type": "string",
|
|
148
|
+
"const": "array"
|
|
149
|
+
},
|
|
150
|
+
"items": {
|
|
151
|
+
"oneOf": [
|
|
152
|
+
{"$ref": "#/definitions/refSchema"},
|
|
153
|
+
{
|
|
154
|
+
"type": "object",
|
|
155
|
+
"properties": {
|
|
156
|
+
"type": {
|
|
157
|
+
"enum": ["boolean", "integer", "number", "string"]
|
|
158
|
+
}
|
|
159
|
+
},
|
|
160
|
+
"required": ["type"]
|
|
161
|
+
}
|
|
162
|
+
]
|
|
163
|
+
}
|
|
164
|
+
},
|
|
165
|
+
"required": ["type", "items"]
|
|
166
|
+
}
|
|
167
|
+
]
|
|
168
|
+
},
|
|
169
|
+
"objectOrRefArray": {
|
|
170
|
+
"title": "ObjectOrRefArray",
|
|
171
|
+
"type": "array",
|
|
172
|
+
"items": {
|
|
93
173
|
"oneOf": [
|
|
94
174
|
{
|
|
95
|
-
"$ref": "#/definitions/
|
|
175
|
+
"$ref": "#/definitions/refSchema"
|
|
96
176
|
},
|
|
97
177
|
{
|
|
98
|
-
"
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
178
|
+
"$ref": "#/definitions/refSchemaLegacy"
|
|
179
|
+
},
|
|
180
|
+
{
|
|
181
|
+
"$ref": "#/definitions/objectSchema"
|
|
102
182
|
}
|
|
103
|
-
]
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
183
|
+
],
|
|
184
|
+
"unevaluatedProperties": true
|
|
185
|
+
}
|
|
186
|
+
},
|
|
187
|
+
"shapeSchemaAllOf": {
|
|
188
|
+
"title": "Shape Schema All Of",
|
|
189
|
+
"type": "object",
|
|
190
|
+
"properties": {
|
|
191
|
+
"allOf": {"$ref": "#/definitions/objectOrRefArray"}
|
|
192
|
+
},
|
|
193
|
+
"required": ["allOf"],
|
|
194
|
+
"additionalProperties": false
|
|
195
|
+
},
|
|
196
|
+
"allOfSchema": {
|
|
197
|
+
"title": "AllOfSchema",
|
|
198
|
+
"allOf": [
|
|
199
|
+
{"$ref": "#/definitions/propertySchema"},
|
|
200
|
+
{
|
|
201
|
+
"type": "object",
|
|
202
|
+
"properties": {
|
|
203
|
+
"allOf": {"$ref": "#/definitions/objectOrRefArray"}
|
|
204
|
+
},
|
|
205
|
+
"required": ["allOf"]
|
|
206
|
+
}
|
|
207
|
+
]
|
|
208
|
+
},
|
|
209
|
+
"shapeSchemaExtends": {
|
|
210
|
+
"title": "ShapeSchemaExtends",
|
|
211
|
+
"type": "object",
|
|
212
|
+
"properties": {
|
|
213
|
+
"extends": {"$ref": "#/definitions/objectOrRefArray"}
|
|
214
|
+
},
|
|
215
|
+
"required": ["extends"],
|
|
216
|
+
"additionalProperties": false
|
|
217
|
+
},
|
|
218
|
+
"extendsSchema": {
|
|
219
|
+
"title": "ExtendsSchema",
|
|
220
|
+
"allOf": [
|
|
221
|
+
{"$ref": "#/definitions/propertySchema"},
|
|
222
|
+
{
|
|
223
|
+
"type": "object",
|
|
224
|
+
"properties": {
|
|
225
|
+
"extends": {"$ref": "#/definitions/objectOrRefArray"}
|
|
226
|
+
},
|
|
227
|
+
"required": ["extends"]
|
|
228
|
+
}
|
|
229
|
+
]
|
|
230
|
+
},
|
|
231
|
+
"shapeSchemaOneOf": {
|
|
232
|
+
"title": "Shape Schema One Of",
|
|
233
|
+
"type": "object",
|
|
234
|
+
"properties": {
|
|
235
|
+
"oneOf": {"$ref": "#/definitions/objectOrRefArray"}
|
|
236
|
+
},
|
|
237
|
+
"required": ["oneOf"],
|
|
238
|
+
"additionalProperties": false
|
|
239
|
+
},
|
|
240
|
+
"oneOfSchema": {
|
|
241
|
+
"title": "OneOfSchema",
|
|
242
|
+
"allOf": [
|
|
243
|
+
{"$ref": "#/definitions/propertySchema"},
|
|
244
|
+
{
|
|
245
|
+
"type": "object",
|
|
246
|
+
"properties": {
|
|
247
|
+
"oneOf": {"$ref": "#/definitions/objectOrRefArray"}
|
|
248
|
+
},
|
|
249
|
+
"required": ["oneOf"],
|
|
250
|
+
"additionalProperties": false
|
|
251
|
+
}
|
|
252
|
+
]
|
|
253
|
+
},
|
|
254
|
+
"shapeSchema": {
|
|
255
|
+
"title": "Shape Schema",
|
|
256
|
+
"type": "object",
|
|
257
|
+
"oneOf": [
|
|
258
|
+
{"$ref": "#/definitions/shapeSchemaAllOf"},
|
|
259
|
+
{"$ref": "#/definitions/shapeSchemaExtends"},
|
|
260
|
+
{"$ref": "#/definitions/shapeSchemaOneOf"},
|
|
261
|
+
{"$ref": "#/definitions/shapeSchemaEnum"},
|
|
262
|
+
{"$ref": "#/definitions/objectSchema"}
|
|
263
|
+
]
|
|
264
|
+
},
|
|
265
|
+
"queryMap": {
|
|
266
|
+
"title": "Query Map",
|
|
267
|
+
"type": "object",
|
|
268
|
+
"patternProperties": {
|
|
269
|
+
"[0-9A-Za-z_-]+": {
|
|
270
|
+
"$ref": "#/definitions/query"
|
|
271
|
+
}
|
|
272
|
+
}
|
|
273
|
+
},
|
|
274
|
+
"args": {
|
|
275
|
+
"title": "Args",
|
|
276
|
+
"oneOf": [{"type": "string"}, {"$ref": "#/definitions/objectSchema"}]
|
|
277
|
+
},
|
|
278
|
+
"returnShape": {
|
|
279
|
+
"title": "Return Shape",
|
|
280
|
+
"oneOf": [{"type": "string"}, {"$ref": "#/definitions/returnShapeArraySchema"}]
|
|
281
|
+
},
|
|
282
|
+
"directiveConfigItem": {
|
|
283
|
+
"title": "Directive Config Item",
|
|
284
|
+
"description": "A tuple with a string directive name, and options to pass to the directive",
|
|
285
|
+
"type": "array",
|
|
286
|
+
"items": [
|
|
287
|
+
{
|
|
288
|
+
"title": "Directive Name",
|
|
289
|
+
"type": "string"
|
|
290
|
+
},
|
|
291
|
+
{
|
|
292
|
+
"title": "Directive Options",
|
|
293
|
+
"type": "object",
|
|
294
|
+
"propertyNames": {
|
|
295
|
+
"pattern": "[0-9A-Za-z_-]+"
|
|
111
296
|
}
|
|
297
|
+
}
|
|
298
|
+
]
|
|
299
|
+
},
|
|
300
|
+
"parameterSerializeStyleOptions": {
|
|
301
|
+
"title": "Parameter Serialize Style Options",
|
|
302
|
+
"description": "All possible options for the more specific ParameterSerializeStyleOptions types.",
|
|
303
|
+
"type": "object",
|
|
304
|
+
"properties": {
|
|
305
|
+
"style": {
|
|
306
|
+
"type": "string",
|
|
307
|
+
"enum": ["simple", "label", "matrix", "form", "spaceDelimited", "pipeDelimited", "deepObject", "none"]
|
|
112
308
|
},
|
|
113
|
-
"
|
|
309
|
+
"explode": {
|
|
310
|
+
"type": "boolean"
|
|
311
|
+
},
|
|
312
|
+
"allowEmptyValue": {
|
|
313
|
+
"type": "boolean"
|
|
314
|
+
},
|
|
315
|
+
"allowReserved": {
|
|
316
|
+
"description": "The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.",
|
|
317
|
+
"type": "boolean"
|
|
318
|
+
},
|
|
319
|
+
"skipEncoding": {
|
|
320
|
+
"type": "boolean"
|
|
321
|
+
}
|
|
114
322
|
},
|
|
115
|
-
"
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
323
|
+
"required": ["style"],
|
|
324
|
+
"additionalProperties": false
|
|
325
|
+
},
|
|
326
|
+
"parameterSerializeStyleOptionsForPathParams": {
|
|
327
|
+
"title": "Parameter Serialize Style Options For Path Params",
|
|
328
|
+
"description": "Options to be passed to the serialization routine.",
|
|
329
|
+
"type": "object",
|
|
330
|
+
"properties": {
|
|
331
|
+
"style": {
|
|
332
|
+
"type": "string",
|
|
333
|
+
"enum": ["simple", "label", "matrix", "none"]
|
|
122
334
|
},
|
|
123
|
-
"
|
|
335
|
+
"explode": {
|
|
336
|
+
"type": "boolean"
|
|
337
|
+
},
|
|
338
|
+
"allowEmptyValue": {
|
|
339
|
+
"type": "boolean"
|
|
340
|
+
},
|
|
341
|
+
"allowReserved": {
|
|
342
|
+
"description": "The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.",
|
|
343
|
+
"type": "boolean"
|
|
344
|
+
},
|
|
345
|
+
"skipEncoding": {
|
|
346
|
+
"type": "boolean"
|
|
347
|
+
}
|
|
124
348
|
},
|
|
125
|
-
"
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
349
|
+
"required": ["style"],
|
|
350
|
+
"additionalProperties": false
|
|
351
|
+
},
|
|
352
|
+
"parameterSerializeStyleOptionsForSearchParams": {
|
|
353
|
+
"title": "Parameter Serialize Style Options For Search Params",
|
|
354
|
+
"description": "Options to be passed to the serialization routine.",
|
|
355
|
+
"type": "object",
|
|
356
|
+
"properties": {
|
|
357
|
+
"style": {
|
|
358
|
+
"type": "string",
|
|
359
|
+
"enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject", "none"]
|
|
360
|
+
},
|
|
361
|
+
"explode": {
|
|
362
|
+
"type": "boolean"
|
|
136
363
|
},
|
|
137
|
-
"
|
|
138
|
-
|
|
364
|
+
"allowEmptyValue": {
|
|
365
|
+
"type": "boolean"
|
|
366
|
+
},
|
|
367
|
+
"allowReserved": {
|
|
368
|
+
"description": "The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.",
|
|
369
|
+
"type": "boolean"
|
|
370
|
+
},
|
|
371
|
+
"skipEncoding": {
|
|
372
|
+
"type": "boolean"
|
|
373
|
+
}
|
|
139
374
|
},
|
|
140
|
-
"
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
375
|
+
"required": ["style"],
|
|
376
|
+
"additionalProperties": false
|
|
377
|
+
},
|
|
378
|
+
"parameterSerializeStyleOptionsForHeaders": {
|
|
379
|
+
"title": "Parameter Serialize Style Options For Headers",
|
|
380
|
+
"description": "Options to be passed to the serialization routine.",
|
|
381
|
+
"type": "object",
|
|
382
|
+
"properties": {
|
|
383
|
+
"style": {
|
|
384
|
+
"type": "string",
|
|
385
|
+
"enum": ["simple", "none"]
|
|
386
|
+
},
|
|
387
|
+
"explode": {
|
|
388
|
+
"type": "boolean"
|
|
389
|
+
}
|
|
390
|
+
},
|
|
391
|
+
"required": ["style"],
|
|
392
|
+
"additionalProperties": false
|
|
393
|
+
},
|
|
394
|
+
"parameterSerializeContentOptions": {
|
|
395
|
+
"title": "Parameter Serialize Content Options",
|
|
396
|
+
"description": "Options to be passed to the serialization routine.",
|
|
397
|
+
"type": "object",
|
|
398
|
+
"properties": {
|
|
399
|
+
"contentType": {
|
|
400
|
+
"type": "string"
|
|
401
|
+
},
|
|
402
|
+
"allowReserved": {
|
|
403
|
+
"description": "The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.",
|
|
404
|
+
"type": "boolean"
|
|
405
|
+
},
|
|
406
|
+
"skipEncoding": {
|
|
407
|
+
"type": "boolean"
|
|
408
|
+
},
|
|
409
|
+
"options": {
|
|
410
|
+
"description": "Options to be passed directly to the content serializer library. Valid options depend upon your contentType.",
|
|
411
|
+
"type": "object"
|
|
412
|
+
}
|
|
413
|
+
},
|
|
414
|
+
"required": ["contentType"],
|
|
415
|
+
"additionalProperties": false
|
|
416
|
+
},
|
|
417
|
+
"parameterSerializeOptions": {
|
|
418
|
+
"title": "Parameter Serialize Options",
|
|
419
|
+
"description": "Options to be passed to the serialization routine.",
|
|
420
|
+
"type": "object",
|
|
421
|
+
"oneOf": [
|
|
422
|
+
{
|
|
423
|
+
"$ref": "#/definitions/parameterSerializeStyleOptions"
|
|
424
|
+
},
|
|
425
|
+
{
|
|
426
|
+
"$ref": "#/definitions/parameterSerializeContentOptions"
|
|
427
|
+
}
|
|
428
|
+
]
|
|
429
|
+
},
|
|
430
|
+
"parameterSerializeConfig": {
|
|
431
|
+
"title": "Parameter Serialize Config",
|
|
432
|
+
"description": "All possible options for the more specific ParameterSerializeConfig types.",
|
|
433
|
+
"type": "object",
|
|
434
|
+
"properties": {
|
|
435
|
+
"content": {
|
|
436
|
+
"$ref": "#/definitions/parameterSerializeContentOptions"
|
|
437
|
+
},
|
|
438
|
+
"defaults": {
|
|
439
|
+
"$ref": "#/definitions/parameterSerializeOptions"
|
|
440
|
+
},
|
|
441
|
+
"paths": {
|
|
442
|
+
"type": "object",
|
|
443
|
+
"patternProperties": {
|
|
444
|
+
"^[^\\n\\r]*$": {"$ref": "#/definitions/parameterSerializeOptions"}
|
|
161
445
|
}
|
|
162
|
-
|
|
446
|
+
}
|
|
163
447
|
},
|
|
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
|
-
}
|
|
448
|
+
"additionalProperties": false
|
|
449
|
+
},
|
|
450
|
+
"parameterSerializeConfigForBody": {
|
|
451
|
+
"title": "Parameter Serialize Config For Body",
|
|
452
|
+
"description": "Top-level paths to use serialization options for.",
|
|
453
|
+
"type": "object",
|
|
454
|
+
"properties": {
|
|
455
|
+
"content": {
|
|
456
|
+
"$ref": "#/definitions/parameterSerializeContentOptions"
|
|
457
|
+
}
|
|
458
|
+
},
|
|
459
|
+
"additionalProperties": false
|
|
460
|
+
},
|
|
461
|
+
"parameterSerializeConfigForPathParams": {
|
|
462
|
+
"title": "Parameter Serialize Config For Path Params",
|
|
463
|
+
"description": "Top-level paths to use path params serialization options for.",
|
|
464
|
+
"type": "object",
|
|
465
|
+
"properties": {
|
|
466
|
+
"template": {
|
|
467
|
+
"description": "For generating the path using tokens frpm the ParameterOps, e.g., '/products/{productId}'",
|
|
468
|
+
"type": "string"
|
|
469
|
+
},
|
|
470
|
+
"defaults": {
|
|
471
|
+
"oneOf": [
|
|
472
|
+
{
|
|
473
|
+
"$ref": "#/definitions/parameterSerializeStyleOptionsForPathParams"
|
|
191
474
|
},
|
|
192
|
-
|
|
475
|
+
{
|
|
476
|
+
"$ref": "#/definitions/parameterSerializeContentOptions"
|
|
477
|
+
}
|
|
478
|
+
]
|
|
479
|
+
},
|
|
480
|
+
"paths": {
|
|
481
|
+
"type": "object",
|
|
482
|
+
"patternProperties": {
|
|
483
|
+
"^[^\\n\\r]*$": {
|
|
484
|
+
"oneOf": [
|
|
485
|
+
{
|
|
486
|
+
"$ref": "#/definitions/parameterSerializeStyleOptionsForPathParams"
|
|
487
|
+
},
|
|
488
|
+
{
|
|
489
|
+
"$ref": "#/definitions/parameterSerializeContentOptions"
|
|
490
|
+
}
|
|
491
|
+
]
|
|
492
|
+
}
|
|
193
493
|
}
|
|
194
|
-
|
|
494
|
+
}
|
|
195
495
|
},
|
|
196
|
-
"
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
496
|
+
"required": ["template"],
|
|
497
|
+
"additionalProperties": false
|
|
498
|
+
},
|
|
499
|
+
"parameterSerializeConfigForSearchParams": {
|
|
500
|
+
"title": "Parameter Serialize Config For Search Params",
|
|
501
|
+
"description": "Top-level paths to use search params serialization options for.",
|
|
502
|
+
"type": "object",
|
|
503
|
+
"properties": {
|
|
504
|
+
"defaults": {
|
|
200
505
|
"oneOf": [
|
|
201
506
|
{
|
|
202
|
-
"$ref": "#/definitions/
|
|
507
|
+
"$ref": "#/definitions/parameterSerializeStyleOptionsForSearchParams"
|
|
203
508
|
},
|
|
204
509
|
{
|
|
205
|
-
"$ref": "#/definitions/
|
|
510
|
+
"$ref": "#/definitions/parameterSerializeContentOptions"
|
|
511
|
+
}
|
|
512
|
+
]
|
|
513
|
+
},
|
|
514
|
+
"paths": {
|
|
515
|
+
"type": "object",
|
|
516
|
+
"patternProperties": {
|
|
517
|
+
"^[^\\n\\r]*$": {
|
|
518
|
+
"oneOf": [
|
|
519
|
+
{
|
|
520
|
+
"$ref": "#/definitions/parameterSerializeStyleOptionsForSearchParams"
|
|
521
|
+
},
|
|
522
|
+
{
|
|
523
|
+
"$ref": "#/definitions/parameterSerializeContentOptions"
|
|
524
|
+
}
|
|
525
|
+
]
|
|
526
|
+
}
|
|
527
|
+
}
|
|
528
|
+
}
|
|
529
|
+
},
|
|
530
|
+
"additionalProperties": false
|
|
531
|
+
},
|
|
532
|
+
"parameterSerializeConfigForHeaders": {
|
|
533
|
+
"title": "Parameter Serialize Config For Headers",
|
|
534
|
+
"description": "Top-level paths to use headers serialization options for.",
|
|
535
|
+
"type": "object",
|
|
536
|
+
"properties": {
|
|
537
|
+
"defaults": {
|
|
538
|
+
"oneOf": [
|
|
539
|
+
{
|
|
540
|
+
"$ref": "#/definitions/parameterSerializeStyleOptionsForHeaders"
|
|
206
541
|
},
|
|
207
542
|
{
|
|
208
|
-
"$ref": "#/definitions/
|
|
543
|
+
"$ref": "#/definitions/parameterSerializeContentOptions"
|
|
544
|
+
}
|
|
545
|
+
]
|
|
546
|
+
},
|
|
547
|
+
"paths": {
|
|
548
|
+
"type": "object",
|
|
549
|
+
"patternProperties": {
|
|
550
|
+
"^[^\\n\\r]*$": {
|
|
551
|
+
"oneOf": [
|
|
552
|
+
{
|
|
553
|
+
"$ref": "#/definitions/parameterSerializeStyleOptionsForHeaders"
|
|
554
|
+
},
|
|
555
|
+
{
|
|
556
|
+
"$ref": "#/definitions/parameterSerializeContentOptions"
|
|
557
|
+
}
|
|
558
|
+
]
|
|
209
559
|
}
|
|
210
|
-
|
|
211
|
-
"unevaluatedProperties": true
|
|
560
|
+
}
|
|
212
561
|
}
|
|
213
562
|
},
|
|
214
|
-
"
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
563
|
+
"additionalProperties": false
|
|
564
|
+
},
|
|
565
|
+
"parameterOpNested": {
|
|
566
|
+
"title": "Parameter Op Nested",
|
|
567
|
+
"description": "An object describing an operation to generate a parameter, using a nested OpList.",
|
|
568
|
+
"type": "object",
|
|
569
|
+
"properties": {
|
|
570
|
+
"path": {
|
|
571
|
+
"description": "A path to the parameter for this operation.",
|
|
572
|
+
"type": "string",
|
|
573
|
+
"minLength": 1,
|
|
574
|
+
"pattern": "^[^\\n\\r]*$"
|
|
219
575
|
},
|
|
220
|
-
"
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
"
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
"properties": {
|
|
230
|
-
"allOf": {"$ref": "#/definitions/objectOrRefArray"}
|
|
231
|
-
},
|
|
232
|
-
"required": ["allOf"]
|
|
233
|
-
}
|
|
234
|
-
]
|
|
576
|
+
"op": {
|
|
577
|
+
"description": "A mode for this parameter's operation.",
|
|
578
|
+
"type": "string",
|
|
579
|
+
"enum": ["set", "concat", "extend", "remove"]
|
|
580
|
+
},
|
|
581
|
+
"ops": {
|
|
582
|
+
"description": "A nested op list.",
|
|
583
|
+
"$ref": "#/definitions/parameterOpList"
|
|
584
|
+
}
|
|
235
585
|
},
|
|
236
|
-
"
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
586
|
+
"required": ["path", "ops"],
|
|
587
|
+
"additionalProperties": false
|
|
588
|
+
},
|
|
589
|
+
"parameterOpValue": {
|
|
590
|
+
"title": "Parameter Op Value",
|
|
591
|
+
"description": "An object describing an operation to generate a parameter using a value.",
|
|
592
|
+
"type": "object",
|
|
593
|
+
"properties": {
|
|
594
|
+
"path": {
|
|
595
|
+
"description": "A path to the parameter for this operation.",
|
|
596
|
+
"type": "string",
|
|
597
|
+
"minLength": 1,
|
|
598
|
+
"pattern": "^[^\\n\\r]*$"
|
|
599
|
+
},
|
|
600
|
+
"op": {
|
|
601
|
+
"description": "A mode for this parameter's operation.",
|
|
602
|
+
"type": "string",
|
|
603
|
+
"enum": ["set", "concat", "extend", "remove"]
|
|
241
604
|
},
|
|
242
|
-
"
|
|
243
|
-
|
|
605
|
+
"value": {
|
|
606
|
+
"description": "A value to set directly at this path.",
|
|
607
|
+
"type": ["number", "string", "boolean", "object", "array", "null"]
|
|
608
|
+
}
|
|
244
609
|
},
|
|
245
|
-
"
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
610
|
+
"required": ["path", "value"],
|
|
611
|
+
"additionalProperties": false
|
|
612
|
+
},
|
|
613
|
+
"parameterOpMapping": {
|
|
614
|
+
"title": "Parameter Op Mapping",
|
|
615
|
+
"description": "An object describing an operation to generate a parameter using a mapping.",
|
|
616
|
+
"type": "object",
|
|
617
|
+
"properties": {
|
|
618
|
+
"path": {
|
|
619
|
+
"description": "A path to the parameter for this operation.",
|
|
620
|
+
"type": "string",
|
|
621
|
+
"minLength": 1,
|
|
622
|
+
"pattern": "^[^\\n\\r]*$"
|
|
623
|
+
},
|
|
624
|
+
"op": {
|
|
625
|
+
"description": "A mode for this parameter's operation.",
|
|
626
|
+
"type": "string",
|
|
627
|
+
"enum": ["set", "concat", "extend", "remove"]
|
|
628
|
+
},
|
|
629
|
+
"mapping": {
|
|
630
|
+
"description": "Either a valid JSONPath or a directive pipeline to evaluate against the query context.",
|
|
631
|
+
"oneOf": [
|
|
632
|
+
{
|
|
633
|
+
"type": "string",
|
|
634
|
+
"minLength": 1
|
|
253
635
|
},
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
636
|
+
{
|
|
637
|
+
"$ref": "#/definitions/directiveConfig"
|
|
638
|
+
}
|
|
639
|
+
]
|
|
640
|
+
}
|
|
257
641
|
},
|
|
258
|
-
"
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
642
|
+
"required": ["path", "mapping"],
|
|
643
|
+
"additionalProperties": false
|
|
644
|
+
},
|
|
645
|
+
"parameterOpOp": {
|
|
646
|
+
"title": "Parameter Op Op",
|
|
647
|
+
"description": "An object describing an operation to generate a parameter using a mapping.",
|
|
648
|
+
"type": "object",
|
|
649
|
+
"properties": {
|
|
650
|
+
"path": {
|
|
651
|
+
"description": "A path to the parameter for this operation.",
|
|
652
|
+
"type": "string",
|
|
653
|
+
"minLength": 1,
|
|
654
|
+
"pattern": "^[^\\n\\r]*$"
|
|
263
655
|
},
|
|
264
|
-
"
|
|
265
|
-
|
|
656
|
+
"op": {
|
|
657
|
+
"description": "A mode for this parameter's operation.",
|
|
658
|
+
"type": "string",
|
|
659
|
+
"enum": ["set", "concat", "extend", "remove"]
|
|
660
|
+
}
|
|
266
661
|
},
|
|
267
|
-
"
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
662
|
+
"required": ["path", "op"],
|
|
663
|
+
"additionalProperties": false
|
|
664
|
+
},
|
|
665
|
+
"parameterOp": {
|
|
666
|
+
"title": "Parameter Op",
|
|
667
|
+
"description": "An object describing an operation to generate a parameter.",
|
|
668
|
+
"oneOf": [
|
|
669
|
+
{
|
|
670
|
+
"$ref": "#/definitions/parameterOpNested"
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
"$ref": "#/definitions/parameterOpValue"
|
|
674
|
+
},
|
|
675
|
+
{
|
|
676
|
+
"$ref": "#/definitions/parameterOpMapping"
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
"$ref": "#/definitions/parameterOpOp"
|
|
680
|
+
}
|
|
681
|
+
]
|
|
682
|
+
},
|
|
683
|
+
"parameterOpList": {
|
|
684
|
+
"title": "Parameter Op List",
|
|
685
|
+
"type": "array",
|
|
686
|
+
"items": {
|
|
687
|
+
"$ref": "#/definitions/parameterOp"
|
|
280
688
|
},
|
|
281
|
-
"
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
"title": "Query Map",
|
|
294
|
-
"type": "object",
|
|
295
|
-
"patternProperties": {
|
|
296
|
-
"[0-9A-Za-z_-]+": {
|
|
297
|
-
"$ref": "#/definitions/query"
|
|
298
|
-
}
|
|
689
|
+
"minItems": 1
|
|
690
|
+
},
|
|
691
|
+
"parameterConfig": {
|
|
692
|
+
"title": "Parameter Config",
|
|
693
|
+
"description": "All possible options for the more specific ParameterConfig types.",
|
|
694
|
+
"type": "object",
|
|
695
|
+
"properties": {
|
|
696
|
+
"ops": {
|
|
697
|
+
"$ref": "#/definitions/parameterOpList"
|
|
698
|
+
},
|
|
699
|
+
"serialize": {
|
|
700
|
+
"$ref": "#/definitions/parameterSerializeConfig"
|
|
299
701
|
}
|
|
300
702
|
},
|
|
301
|
-
"
|
|
302
|
-
|
|
303
|
-
|
|
703
|
+
"required": ["ops"],
|
|
704
|
+
"additionalProperties": false
|
|
705
|
+
},
|
|
706
|
+
"parameterConfigForBody": {
|
|
707
|
+
"title": "Parameter Config For Body",
|
|
708
|
+
"type": "object",
|
|
709
|
+
"properties": {
|
|
710
|
+
"ops": {
|
|
711
|
+
"$ref": "#/definitions/parameterOpList"
|
|
712
|
+
},
|
|
713
|
+
"serialize": {
|
|
714
|
+
"$ref": "#/definitions/parameterSerializeConfigForBody"
|
|
715
|
+
}
|
|
304
716
|
},
|
|
305
|
-
"
|
|
306
|
-
|
|
307
|
-
|
|
717
|
+
"required": ["ops"],
|
|
718
|
+
"additionalProperties": false
|
|
719
|
+
},
|
|
720
|
+
"parameterConfigForPathParams": {
|
|
721
|
+
"title": "Parameter Config For Path Params",
|
|
722
|
+
"type": "object",
|
|
723
|
+
"properties": {
|
|
724
|
+
"ops": {
|
|
725
|
+
"$ref": "#/definitions/parameterOpList"
|
|
726
|
+
},
|
|
727
|
+
"serialize": {
|
|
728
|
+
"$ref": "#/definitions/parameterSerializeConfigForPathParams"
|
|
729
|
+
}
|
|
308
730
|
},
|
|
309
|
-
"
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
"pattern": "[0-9A-Za-z_-]+"
|
|
323
|
-
}
|
|
324
|
-
}
|
|
325
|
-
]
|
|
731
|
+
"required": ["ops", "serialize"],
|
|
732
|
+
"additionalProperties": false
|
|
733
|
+
},
|
|
734
|
+
"parameterConfigForAwsLambda": {
|
|
735
|
+
"title": "ParameterConfigForAwsLambda",
|
|
736
|
+
"type": "object",
|
|
737
|
+
"properties": {
|
|
738
|
+
"ops": {
|
|
739
|
+
"$ref": "#/definitions/parameterOpList"
|
|
740
|
+
},
|
|
741
|
+
"serialize": {
|
|
742
|
+
"$ref": "#/definitions/parameterSerializeConfigForPathParams"
|
|
743
|
+
}
|
|
326
744
|
},
|
|
327
|
-
"
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
"type": "boolean"
|
|
341
|
-
},
|
|
342
|
-
"allowReserved": {
|
|
343
|
-
"description": "The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.",
|
|
344
|
-
"type": "boolean"
|
|
345
|
-
},
|
|
346
|
-
"skipEncoding": {
|
|
347
|
-
"type": "boolean"
|
|
348
|
-
}
|
|
349
|
-
},
|
|
350
|
-
"required": ["style"],
|
|
351
|
-
"additionalProperties": false
|
|
745
|
+
"required": ["ops", "serialize"],
|
|
746
|
+
"additionalProperties": false
|
|
747
|
+
},
|
|
748
|
+
"parameterConfigForSearchParams": {
|
|
749
|
+
"title": "Parameter Config For Search Params",
|
|
750
|
+
"type": "object",
|
|
751
|
+
"properties": {
|
|
752
|
+
"ops": {
|
|
753
|
+
"$ref": "#/definitions/parameterOpList"
|
|
754
|
+
},
|
|
755
|
+
"serialize": {
|
|
756
|
+
"$ref": "#/definitions/parameterSerializeConfigForSearchParams"
|
|
757
|
+
}
|
|
352
758
|
},
|
|
353
|
-
"
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
"type": "boolean"
|
|
367
|
-
},
|
|
368
|
-
"allowReserved": {
|
|
369
|
-
"description": "The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.",
|
|
370
|
-
"type": "boolean"
|
|
371
|
-
},
|
|
372
|
-
"skipEncoding": {
|
|
373
|
-
"type": "boolean"
|
|
374
|
-
}
|
|
375
|
-
},
|
|
376
|
-
"required": ["style"],
|
|
377
|
-
"additionalProperties": false
|
|
759
|
+
"required": ["ops"],
|
|
760
|
+
"additionalProperties": false
|
|
761
|
+
},
|
|
762
|
+
"parameterConfigForHeaders": {
|
|
763
|
+
"title": "Parameter Config For Headers",
|
|
764
|
+
"type": "object",
|
|
765
|
+
"properties": {
|
|
766
|
+
"ops": {
|
|
767
|
+
"$ref": "#/definitions/parameterOpList"
|
|
768
|
+
},
|
|
769
|
+
"serialize": {
|
|
770
|
+
"$ref": "#/definitions/parameterSerializeConfigForHeaders"
|
|
771
|
+
}
|
|
378
772
|
},
|
|
379
|
-
"
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
"type": "boolean"
|
|
390
|
-
},
|
|
391
|
-
"allowEmptyValue": {
|
|
392
|
-
"type": "boolean"
|
|
393
|
-
},
|
|
394
|
-
"allowReserved": {
|
|
395
|
-
"description": "The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.",
|
|
396
|
-
"type": "boolean"
|
|
397
|
-
},
|
|
398
|
-
"skipEncoding": {
|
|
399
|
-
"type": "boolean"
|
|
400
|
-
}
|
|
401
|
-
},
|
|
402
|
-
"required": ["style"],
|
|
403
|
-
"additionalProperties": false
|
|
773
|
+
"required": ["ops"],
|
|
774
|
+
"additionalProperties": false
|
|
775
|
+
},
|
|
776
|
+
"parameterConfigForJson": {
|
|
777
|
+
"title": "Parameter Config For Json",
|
|
778
|
+
"type": "object",
|
|
779
|
+
"properties": {
|
|
780
|
+
"ops": {
|
|
781
|
+
"$ref": "#/definitions/parameterOpList"
|
|
782
|
+
}
|
|
404
783
|
},
|
|
405
|
-
"
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
784
|
+
"required": ["ops"],
|
|
785
|
+
"additionalProperties": false
|
|
786
|
+
},
|
|
787
|
+
"directiveConfig": {
|
|
788
|
+
"title": "Directive Config",
|
|
789
|
+
"description": "An array of individual directive config items to process in order",
|
|
790
|
+
"type": "array",
|
|
791
|
+
"items": {
|
|
792
|
+
"$ref": "#/definitions/directiveConfigItem"
|
|
793
|
+
},
|
|
794
|
+
"minItems": 1
|
|
795
|
+
},
|
|
796
|
+
"directiveMappingMap": {
|
|
797
|
+
"title": "Directive Mapping Map",
|
|
798
|
+
"description": "An map of object keys / key paths to directive configs",
|
|
799
|
+
"type": "object",
|
|
800
|
+
"patternProperties": {
|
|
801
|
+
"[0-9A-Za-z_-]+": {
|
|
802
|
+
"$ref": "#/definitions/directiveConfig"
|
|
803
|
+
}
|
|
804
|
+
}
|
|
805
|
+
},
|
|
806
|
+
"directiveMappingArrayItem": {
|
|
807
|
+
"title": "Directive Mapping Array Item",
|
|
808
|
+
"description": "A tuple with a string key and a directive config to evaluate",
|
|
809
|
+
"type": "array",
|
|
810
|
+
"items": [{"type": "string"}, {"$ref": "#/definitions/directiveConfig"}]
|
|
811
|
+
},
|
|
812
|
+
"directiveMappingArray": {
|
|
813
|
+
"title": "Directive Mapping Array",
|
|
814
|
+
"description": "An array of key / value or directive config tuples",
|
|
815
|
+
"type": "array",
|
|
816
|
+
"items": {"$ref": "#/definitions/directiveMappingArrayItem"}
|
|
817
|
+
},
|
|
818
|
+
"basicResolver": {
|
|
819
|
+
"title": "BasicResolver",
|
|
820
|
+
"description": "A single resolver, can be composed with the ComposeResolver.",
|
|
821
|
+
"oneOf": [
|
|
822
|
+
{
|
|
823
|
+
"$ref": "#/definitions/utilResolver"
|
|
417
824
|
},
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
},
|
|
421
|
-
"parameterSerializeContentOptions": {
|
|
422
|
-
"title": "Parameter Serialize Content Options",
|
|
423
|
-
"description": "Options to be passed to the serialization routine.",
|
|
424
|
-
"type": "object",
|
|
425
|
-
"properties": {
|
|
426
|
-
"contentType": {
|
|
427
|
-
"type": "string"
|
|
428
|
-
},
|
|
429
|
-
"allowReserved": {
|
|
430
|
-
"description": "The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.",
|
|
431
|
-
"type": "boolean"
|
|
432
|
-
},
|
|
433
|
-
"skipEncoding": {
|
|
434
|
-
"type": "boolean"
|
|
435
|
-
},
|
|
436
|
-
"options": {
|
|
437
|
-
"description": "Options to be passed directly to the content serializer library. Valid options depend upon your contentType.",
|
|
438
|
-
"type": "object"
|
|
439
|
-
}
|
|
825
|
+
{
|
|
826
|
+
"$ref": "#/definitions/takeshapeResolver"
|
|
440
827
|
},
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
"
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
828
|
+
{
|
|
829
|
+
"$ref": "#/definitions/internalTakeshapeResolver"
|
|
830
|
+
},
|
|
831
|
+
{
|
|
832
|
+
"$ref": "#/definitions/graphqlResolver"
|
|
833
|
+
},
|
|
834
|
+
{
|
|
835
|
+
"$ref": "#/definitions/restResolver"
|
|
836
|
+
},
|
|
837
|
+
{
|
|
838
|
+
"$ref": "#/definitions/awsLambdaResolver"
|
|
839
|
+
}
|
|
840
|
+
]
|
|
841
|
+
},
|
|
842
|
+
"argsMapping": {
|
|
843
|
+
"title": "ArgsMapping",
|
|
844
|
+
"description": "Maps a query's input args to the input expected by the service's endpoint.",
|
|
845
|
+
"oneOf": [
|
|
846
|
+
{
|
|
847
|
+
"$ref": "#/definitions/directiveMappingMap"
|
|
848
|
+
},
|
|
849
|
+
{
|
|
850
|
+
"$ref": "#/definitions/directiveConfig"
|
|
851
|
+
}
|
|
852
|
+
]
|
|
853
|
+
},
|
|
854
|
+
"searchParamsMapping": {
|
|
855
|
+
"title": "SearchParamsMapping",
|
|
856
|
+
"description": "Set or evaluate directives to generate searchParams for the service endpoint.",
|
|
857
|
+
"$ref": "#/definitions/directiveMappingArray"
|
|
858
|
+
},
|
|
859
|
+
"resultsMapping": {
|
|
860
|
+
"title": "ResultsMapping",
|
|
861
|
+
"description": "Maps a service endpoint's response results to the expected shape of the query's response.",
|
|
862
|
+
"oneOf": [
|
|
863
|
+
{
|
|
864
|
+
"$ref": "#/definitions/directiveMappingMap"
|
|
865
|
+
},
|
|
866
|
+
{
|
|
867
|
+
"$ref": "#/definitions/directiveConfig"
|
|
868
|
+
}
|
|
869
|
+
]
|
|
870
|
+
},
|
|
871
|
+
"utilResolver": {
|
|
872
|
+
"title": "UtilResolver",
|
|
873
|
+
"type": "object",
|
|
874
|
+
"properties": {
|
|
875
|
+
"if": {
|
|
876
|
+
"type": "string"
|
|
877
|
+
},
|
|
878
|
+
"id": {
|
|
879
|
+
"type": "string",
|
|
880
|
+
"pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
|
|
881
|
+
},
|
|
882
|
+
"name": {
|
|
883
|
+
"title": "UtilResolverName",
|
|
884
|
+
"type": "string",
|
|
885
|
+
"description": "Name of the resolver function.",
|
|
886
|
+
"enum": ["debug:noop", "util:wrap"]
|
|
887
|
+
},
|
|
888
|
+
"service": {
|
|
889
|
+
"type": "string",
|
|
890
|
+
"description": "Configuration for a service to use with this resolver."
|
|
891
|
+
},
|
|
892
|
+
"options": {
|
|
893
|
+
"title": "UtilResolverOptions",
|
|
894
|
+
"type": "object",
|
|
895
|
+
"additionalProperties": true
|
|
896
|
+
},
|
|
897
|
+
"args": {
|
|
898
|
+
"description": "Mapping and serialization configuration for args.",
|
|
899
|
+
"$ref": "#/definitions/parameterConfigForJson"
|
|
900
|
+
},
|
|
901
|
+
"results": {
|
|
902
|
+
"description": "Mapping configuration for the results of this resolver step.",
|
|
903
|
+
"$ref": "#/definitions/parameterConfigForJson"
|
|
474
904
|
},
|
|
475
|
-
"
|
|
905
|
+
"argsMapping": {
|
|
906
|
+
"$ref": "#/definitions/argsMapping"
|
|
907
|
+
},
|
|
908
|
+
"resultsMapping": {
|
|
909
|
+
"$ref": "#/definitions/resultsMapping"
|
|
910
|
+
}
|
|
476
911
|
},
|
|
477
|
-
"
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
912
|
+
"required": ["name", "service"],
|
|
913
|
+
"additionalProperties": false
|
|
914
|
+
},
|
|
915
|
+
"takeshapeResolver": {
|
|
916
|
+
"title": "TakeshapeResolver",
|
|
917
|
+
"type": "object",
|
|
918
|
+
"properties": {
|
|
919
|
+
"if": {"type": "string"},
|
|
920
|
+
"id": {
|
|
921
|
+
"type": "string",
|
|
922
|
+
"pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
|
|
923
|
+
},
|
|
924
|
+
"name": {
|
|
925
|
+
"title": "TakeshapeResolverName",
|
|
926
|
+
"type": "string",
|
|
927
|
+
"description": "Name of the resolver function.",
|
|
928
|
+
"enum": [
|
|
929
|
+
"takeshape:get",
|
|
930
|
+
"takeshape:create",
|
|
931
|
+
"takeshape:update",
|
|
932
|
+
"takeshape:delete",
|
|
933
|
+
"takeshape:duplicate",
|
|
934
|
+
"takeshape:find",
|
|
935
|
+
"takeshape:queryApiIndex"
|
|
936
|
+
]
|
|
937
|
+
},
|
|
938
|
+
"service": {
|
|
939
|
+
"type": "string",
|
|
940
|
+
"description": "Internal service identifier.",
|
|
941
|
+
"enum": ["takeshape:local"]
|
|
942
|
+
},
|
|
943
|
+
"options": {
|
|
944
|
+
"title": "TakeshapeResolverOptions",
|
|
945
|
+
"type": "object",
|
|
946
|
+
"additionalProperties": true
|
|
947
|
+
},
|
|
948
|
+
"argsMapping": {
|
|
949
|
+
"$ref": "#/definitions/argsMapping"
|
|
950
|
+
},
|
|
951
|
+
"resultsMapping": {
|
|
952
|
+
"$ref": "#/definitions/resultsMapping"
|
|
485
953
|
},
|
|
486
|
-
"
|
|
954
|
+
"shapeName": {
|
|
955
|
+
"description": "A Shape name for the resolver to use.",
|
|
956
|
+
"type": "string",
|
|
957
|
+
"minLength": 1
|
|
958
|
+
},
|
|
959
|
+
"args": {
|
|
960
|
+
"description": "Mapping and serialization configuration for args.",
|
|
961
|
+
"$ref": "#/definitions/parameterConfigForJson"
|
|
962
|
+
},
|
|
963
|
+
"results": {
|
|
964
|
+
"description": "Mapping configuration for the results of this resolver step.",
|
|
965
|
+
"$ref": "#/definitions/parameterConfigForJson"
|
|
966
|
+
}
|
|
487
967
|
},
|
|
488
|
-
"
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
"
|
|
509
|
-
"
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
968
|
+
"required": ["name", "service", "shapeName"],
|
|
969
|
+
"additionalProperties": false
|
|
970
|
+
},
|
|
971
|
+
"internalTakeshapeResolver": {
|
|
972
|
+
"title": "InternalTakeshapeResolver",
|
|
973
|
+
"type": "object",
|
|
974
|
+
"properties": {
|
|
975
|
+
"if": {
|
|
976
|
+
"type": "string"
|
|
977
|
+
},
|
|
978
|
+
"id": {
|
|
979
|
+
"type": "string",
|
|
980
|
+
"pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
|
|
981
|
+
},
|
|
982
|
+
"name": {
|
|
983
|
+
"title": "InternalTakeshapeResolverName",
|
|
984
|
+
"type": "string",
|
|
985
|
+
"description": "Name of the resolver function.",
|
|
986
|
+
"enum": [
|
|
987
|
+
"takeshape:getRelated",
|
|
988
|
+
"takeshape:getUser",
|
|
989
|
+
"takeshape:taxonomySuggest",
|
|
990
|
+
"takeshape:list",
|
|
991
|
+
"takeshape:search"
|
|
992
|
+
]
|
|
993
|
+
},
|
|
994
|
+
"service": {
|
|
995
|
+
"type": "string",
|
|
996
|
+
"description": "Internal service identifier.",
|
|
997
|
+
"enum": ["takeshape:local"]
|
|
998
|
+
},
|
|
999
|
+
"options": {
|
|
1000
|
+
"title": "TakeshapeResolverOptions",
|
|
1001
|
+
"type": "object",
|
|
1002
|
+
"additionalProperties": true
|
|
1003
|
+
},
|
|
1004
|
+
"shapeName": {
|
|
1005
|
+
"description": "An optional Shape name for the resolver.",
|
|
1006
|
+
"type": "string",
|
|
1007
|
+
"minLength": 1
|
|
522
1008
|
},
|
|
523
|
-
"
|
|
524
|
-
|
|
1009
|
+
"args": {
|
|
1010
|
+
"description": "Mapping and serialization configuration for args.",
|
|
1011
|
+
"$ref": "#/definitions/parameterConfigForJson"
|
|
1012
|
+
},
|
|
1013
|
+
"results": {
|
|
1014
|
+
"description": "Mapping configuration for the results of this resolver step.",
|
|
1015
|
+
"$ref": "#/definitions/parameterConfigForJson"
|
|
1016
|
+
},
|
|
1017
|
+
"argsMapping": {
|
|
1018
|
+
"$ref": "#/definitions/argsMapping"
|
|
1019
|
+
},
|
|
1020
|
+
"resultsMapping": {
|
|
1021
|
+
"$ref": "#/definitions/resultsMapping"
|
|
1022
|
+
}
|
|
525
1023
|
},
|
|
526
|
-
"
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
"
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
}
|
|
554
|
-
}
|
|
555
|
-
}
|
|
1024
|
+
"required": ["name", "service"],
|
|
1025
|
+
"additionalProperties": false
|
|
1026
|
+
},
|
|
1027
|
+
"graphqlResolver": {
|
|
1028
|
+
"title": "GraphqlResolver",
|
|
1029
|
+
"type": "object",
|
|
1030
|
+
"properties": {
|
|
1031
|
+
"if": {"type": "string"},
|
|
1032
|
+
"id": {
|
|
1033
|
+
"type": "string",
|
|
1034
|
+
"pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
|
|
1035
|
+
},
|
|
1036
|
+
"name": {
|
|
1037
|
+
"title": "GraphqlResolverName",
|
|
1038
|
+
"type": "string",
|
|
1039
|
+
"description": "Name of the resolver function.",
|
|
1040
|
+
"enum": ["graphql:query", "graphql:mutation"]
|
|
1041
|
+
},
|
|
1042
|
+
"service": {
|
|
1043
|
+
"type": "string",
|
|
1044
|
+
"description": "Configuration for a service to use with this resolver."
|
|
1045
|
+
},
|
|
1046
|
+
"argsMapping": {
|
|
1047
|
+
"$ref": "#/definitions/argsMapping"
|
|
1048
|
+
},
|
|
1049
|
+
"resultsMapping": {
|
|
1050
|
+
"$ref": "#/definitions/resultsMapping"
|
|
556
1051
|
},
|
|
557
|
-
"
|
|
1052
|
+
"options": {
|
|
1053
|
+
"title": "GraphqlResolverOptions",
|
|
1054
|
+
"type": "object",
|
|
1055
|
+
"properties": {
|
|
1056
|
+
"selectionSet": {"type": "string"},
|
|
1057
|
+
"unboxParentSelectionSet": {"type": "boolean"},
|
|
1058
|
+
"ignoreErrors": {"type": "boolean"},
|
|
1059
|
+
"skipWhenMissingArgs": {"type": "boolean"},
|
|
1060
|
+
"ttl": {"type": "number"},
|
|
1061
|
+
"timeout": {"type": "number"},
|
|
1062
|
+
"retry": {"oneOf": [{"type": "number"}, {"type": "object"}]}
|
|
1063
|
+
},
|
|
1064
|
+
"additionalProperties": true
|
|
1065
|
+
},
|
|
1066
|
+
"fieldName": {
|
|
1067
|
+
"description": "A fieldname to use in queries.",
|
|
1068
|
+
"type": "string"
|
|
1069
|
+
},
|
|
1070
|
+
"headers": {
|
|
1071
|
+
"description": "Mapping and serialization configuration for headers.",
|
|
1072
|
+
"$ref": "#/definitions/parameterConfigForHeaders"
|
|
1073
|
+
},
|
|
1074
|
+
"searchParams": {
|
|
1075
|
+
"description": "Mapping and serialization configuration for searchParams.",
|
|
1076
|
+
"$ref": "#/definitions/parameterConfigForSearchParams"
|
|
1077
|
+
},
|
|
1078
|
+
"args": {
|
|
1079
|
+
"description": "Mapping and serialization configuration for args.",
|
|
1080
|
+
"$ref": "#/definitions/parameterConfigForJson"
|
|
1081
|
+
},
|
|
1082
|
+
"results": {
|
|
1083
|
+
"description": "Mapping configuration for the results of this resolver step.",
|
|
1084
|
+
"$ref": "#/definitions/parameterConfigForJson"
|
|
1085
|
+
}
|
|
558
1086
|
},
|
|
559
|
-
"
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
1087
|
+
"required": ["name", "service", "fieldName"],
|
|
1088
|
+
"additionalProperties": false
|
|
1089
|
+
},
|
|
1090
|
+
"restResolver": {
|
|
1091
|
+
"title": "RestResolver",
|
|
1092
|
+
"type": "object",
|
|
1093
|
+
"properties": {
|
|
1094
|
+
"if": {"type": "string"},
|
|
1095
|
+
"id": {
|
|
1096
|
+
"type": "string",
|
|
1097
|
+
"pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
|
|
1098
|
+
},
|
|
1099
|
+
"name": {
|
|
1100
|
+
"title": "RestResolverName",
|
|
1101
|
+
"type": "string",
|
|
1102
|
+
"description": "Name of the resolver function.",
|
|
1103
|
+
"enum": ["rest:get", "rest:head", "rest:post", "rest:put", "rest:patch", "rest:delete"]
|
|
1104
|
+
},
|
|
1105
|
+
"service": {
|
|
1106
|
+
"type": "string",
|
|
1107
|
+
"description": "Configuration for a service to use with this resolver."
|
|
1108
|
+
},
|
|
1109
|
+
"argsMapping": {
|
|
1110
|
+
"$ref": "#/definitions/argsMapping"
|
|
1111
|
+
},
|
|
1112
|
+
"searchParamsMapping": {
|
|
1113
|
+
"$ref": "#/definitions/searchParamsMapping"
|
|
1114
|
+
},
|
|
1115
|
+
"resultsMapping": {
|
|
1116
|
+
"$ref": "#/definitions/resultsMapping"
|
|
1117
|
+
},
|
|
1118
|
+
"options": {
|
|
1119
|
+
"title": "RestResolverOptions",
|
|
1120
|
+
"type": "object",
|
|
1121
|
+
"properties": {
|
|
1122
|
+
"trailingSlash": {"type": "boolean"},
|
|
1123
|
+
"ttl": {"type": "number"},
|
|
1124
|
+
"timeout": {"type": "number"},
|
|
1125
|
+
"retry": {"oneOf": [{"type": "number"}, {"type": "object"}]}
|
|
573
1126
|
},
|
|
574
|
-
"
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
1127
|
+
"additionalProperties": true
|
|
1128
|
+
},
|
|
1129
|
+
"body": {
|
|
1130
|
+
"description": "Mapping and serialization configuration for a request body.",
|
|
1131
|
+
"$ref": "#/definitions/parameterConfigForBody"
|
|
1132
|
+
},
|
|
1133
|
+
"form": {
|
|
1134
|
+
"description": "Mapping and serialization configuration for form data.",
|
|
1135
|
+
"$ref": "#/definitions/parameterConfigForSearchParams"
|
|
1136
|
+
},
|
|
1137
|
+
"headers": {
|
|
1138
|
+
"description": "Mapping and serialization configuration for headers.",
|
|
1139
|
+
"$ref": "#/definitions/parameterConfigForHeaders"
|
|
1140
|
+
},
|
|
1141
|
+
"json": {
|
|
1142
|
+
"description": "Mapping and serialization configuration for a json request body.",
|
|
1143
|
+
"$ref": "#/definitions/parameterConfigForJson"
|
|
1144
|
+
},
|
|
1145
|
+
"path": {
|
|
1146
|
+
"description": "Mapping and serialization configuration for the path, or a simple string.",
|
|
1147
|
+
"oneOf": [
|
|
1148
|
+
{
|
|
1149
|
+
"$ref": "#/definitions/parameterConfigForPathParams"
|
|
1150
|
+
},
|
|
1151
|
+
{
|
|
1152
|
+
"type": "string"
|
|
587
1153
|
}
|
|
588
|
-
|
|
1154
|
+
]
|
|
589
1155
|
},
|
|
590
|
-
"
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
"title": "Parameter Op Nested",
|
|
594
|
-
"description": "An object describing an operation to generate a parameter, using a nested OpList.",
|
|
595
|
-
"type": "object",
|
|
596
|
-
"properties": {
|
|
597
|
-
"path": {
|
|
598
|
-
"description": "A path to the parameter for this operation.",
|
|
599
|
-
"type": "string",
|
|
600
|
-
"minLength": 1,
|
|
601
|
-
"pattern": "^[^\\n\\r]*$"
|
|
602
|
-
},
|
|
603
|
-
"op": {
|
|
604
|
-
"description": "A mode for this parameter's operation.",
|
|
605
|
-
"type": "string",
|
|
606
|
-
"enum": ["set", "concat", "extend", "remove"]
|
|
607
|
-
},
|
|
608
|
-
"ops": {
|
|
609
|
-
"description": "A nested op list.",
|
|
610
|
-
"$ref": "#/definitions/parameterOpList"
|
|
611
|
-
}
|
|
1156
|
+
"searchParams": {
|
|
1157
|
+
"description": "Mapping and serialization configuration for searchParams.",
|
|
1158
|
+
"$ref": "#/definitions/parameterConfigForSearchParams"
|
|
612
1159
|
},
|
|
613
|
-
"
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
"parameterOpValue": {
|
|
617
|
-
"title": "Parameter Op Value",
|
|
618
|
-
"description": "An object describing an operation to generate a parameter using a value.",
|
|
619
|
-
"type": "object",
|
|
620
|
-
"properties": {
|
|
621
|
-
"path": {
|
|
622
|
-
"description": "A path to the parameter for this operation.",
|
|
623
|
-
"type": "string",
|
|
624
|
-
"minLength": 1,
|
|
625
|
-
"pattern": "^[^\\n\\r]*$"
|
|
626
|
-
},
|
|
627
|
-
"op": {
|
|
628
|
-
"description": "A mode for this parameter's operation.",
|
|
629
|
-
"type": "string",
|
|
630
|
-
"enum": ["set", "concat", "extend", "remove"]
|
|
631
|
-
},
|
|
632
|
-
"value": {
|
|
633
|
-
"description": "A value to set directly at this path.",
|
|
634
|
-
"type": ["number", "string", "boolean", "object", "array", "null"]
|
|
635
|
-
}
|
|
1160
|
+
"args": {
|
|
1161
|
+
"description": "Mapping and serialization configuration for args.",
|
|
1162
|
+
"$ref": "#/definitions/parameterConfigForJson"
|
|
636
1163
|
},
|
|
637
|
-
"
|
|
638
|
-
|
|
1164
|
+
"results": {
|
|
1165
|
+
"description": "Mapping configuration for the results of this resolver step.",
|
|
1166
|
+
"$ref": "#/definitions/parameterConfigForJson"
|
|
1167
|
+
}
|
|
639
1168
|
},
|
|
640
|
-
"
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
"op": {
|
|
652
|
-
"description": "A mode for this parameter's operation.",
|
|
653
|
-
"type": "string",
|
|
654
|
-
"enum": ["set", "concat", "extend", "remove"]
|
|
655
|
-
},
|
|
656
|
-
"mapping": {
|
|
657
|
-
"description": "Either a valid JSONPath or a directive pipeline to evaluate against the query context.",
|
|
658
|
-
"oneOf": [
|
|
659
|
-
{
|
|
660
|
-
"type": "string",
|
|
661
|
-
"minLength": 1
|
|
662
|
-
},
|
|
663
|
-
{
|
|
664
|
-
"$ref": "#/definitions/directiveConfig"
|
|
665
|
-
}
|
|
666
|
-
]
|
|
667
|
-
}
|
|
1169
|
+
"required": ["name", "service", "path"],
|
|
1170
|
+
"additionalProperties": false
|
|
1171
|
+
},
|
|
1172
|
+
"awsLambdaResolver": {
|
|
1173
|
+
"title": "AwsLambdaResolver",
|
|
1174
|
+
"type": "object",
|
|
1175
|
+
"properties": {
|
|
1176
|
+
"if": {"type": "string"},
|
|
1177
|
+
"id": {
|
|
1178
|
+
"type": "string",
|
|
1179
|
+
"pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
|
|
668
1180
|
},
|
|
669
|
-
"
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
"description": "An object describing an operation to generate a parameter using a mapping.",
|
|
675
|
-
"type": "object",
|
|
676
|
-
"properties": {
|
|
677
|
-
"path": {
|
|
678
|
-
"description": "A path to the parameter for this operation.",
|
|
679
|
-
"type": "string",
|
|
680
|
-
"minLength": 1,
|
|
681
|
-
"pattern": "^[^\\n\\r]*$"
|
|
682
|
-
},
|
|
683
|
-
"op": {
|
|
684
|
-
"description": "A mode for this parameter's operation.",
|
|
685
|
-
"type": "string",
|
|
686
|
-
"enum": ["set", "concat", "extend", "remove"]
|
|
687
|
-
}
|
|
1181
|
+
"name": {
|
|
1182
|
+
"title": "AwsLambdaResolverName",
|
|
1183
|
+
"type": "string",
|
|
1184
|
+
"description": "Name of the resolver function.",
|
|
1185
|
+
"enum": ["awsLambda:invoke"]
|
|
688
1186
|
},
|
|
689
|
-
"
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
"parameterOp": {
|
|
693
|
-
"title": "Parameter Op",
|
|
694
|
-
"description": "An object describing an operation to generate a parameter.",
|
|
695
|
-
"oneOf": [
|
|
696
|
-
{
|
|
697
|
-
"$ref": "#/definitions/parameterOpNested"
|
|
698
|
-
},
|
|
699
|
-
{
|
|
700
|
-
"$ref": "#/definitions/parameterOpValue"
|
|
701
|
-
},
|
|
702
|
-
{
|
|
703
|
-
"$ref": "#/definitions/parameterOpMapping"
|
|
704
|
-
},
|
|
705
|
-
{
|
|
706
|
-
"$ref": "#/definitions/parameterOpOp"
|
|
707
|
-
}
|
|
708
|
-
]
|
|
709
|
-
},
|
|
710
|
-
"parameterOpList": {
|
|
711
|
-
"title": "Parameter Op List",
|
|
712
|
-
"type": "array",
|
|
713
|
-
"items": {
|
|
714
|
-
"$ref": "#/definitions/parameterOp"
|
|
1187
|
+
"service": {
|
|
1188
|
+
"type": "string",
|
|
1189
|
+
"description": "Configuration for a service to use with this resolver."
|
|
715
1190
|
},
|
|
716
|
-
"
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
"description": "All possible options for the more specific ParameterConfig types.",
|
|
721
|
-
"type": "object",
|
|
722
|
-
"properties": {
|
|
723
|
-
"ops": {
|
|
724
|
-
"$ref": "#/definitions/parameterOpList"
|
|
725
|
-
},
|
|
726
|
-
"serialize": {
|
|
727
|
-
"$ref": "#/definitions/parameterSerializeConfig"
|
|
728
|
-
}
|
|
1191
|
+
"options": {
|
|
1192
|
+
"title": "AwsLambdaResolverOptions",
|
|
1193
|
+
"type": "object",
|
|
1194
|
+
"additionalProperties": true
|
|
729
1195
|
},
|
|
730
|
-
"
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
"parameterConfigForBody": {
|
|
734
|
-
"title": "Parameter Config For Body",
|
|
735
|
-
"type": "object",
|
|
736
|
-
"properties": {
|
|
737
|
-
"ops": {
|
|
738
|
-
"$ref": "#/definitions/parameterOpList"
|
|
739
|
-
},
|
|
740
|
-
"serialize": {
|
|
741
|
-
"$ref": "#/definitions/parameterSerializeConfigForBody"
|
|
742
|
-
}
|
|
1196
|
+
"payload": {
|
|
1197
|
+
"description": "Mapping configuration the Payload.",
|
|
1198
|
+
"$ref": "#/definitions/parameterConfigForJson"
|
|
743
1199
|
},
|
|
744
|
-
"
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
"serialize": {
|
|
755
|
-
"$ref": "#/definitions/parameterSerializeConfigForPathParams"
|
|
756
|
-
}
|
|
1200
|
+
"functionName": {
|
|
1201
|
+
"description": "Mapping configuration for the FunctionName.",
|
|
1202
|
+
"oneOf": [
|
|
1203
|
+
{
|
|
1204
|
+
"type": "string"
|
|
1205
|
+
},
|
|
1206
|
+
{
|
|
1207
|
+
"$ref": "#/definitions/parameterConfigForAwsLambda"
|
|
1208
|
+
}
|
|
1209
|
+
]
|
|
757
1210
|
},
|
|
758
|
-
"
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
"parameterConfigForAwsLambda": {
|
|
762
|
-
"title": "ParameterConfigForAwsLambda",
|
|
763
|
-
"type": "object",
|
|
764
|
-
"properties": {
|
|
765
|
-
"ops": {
|
|
766
|
-
"$ref": "#/definitions/parameterOpList"
|
|
767
|
-
},
|
|
768
|
-
"serialize": {
|
|
769
|
-
"$ref": "#/definitions/parameterSerializeConfigForPathParams"
|
|
770
|
-
}
|
|
1211
|
+
"clientContext": {
|
|
1212
|
+
"description": "Mapping configuration for the ClientContext.",
|
|
1213
|
+
"$ref": "#/definitions/parameterConfigForJson"
|
|
771
1214
|
},
|
|
772
|
-
"
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
"parameterConfigForSearchParams": {
|
|
776
|
-
"title": "Parameter Config For Search Params",
|
|
777
|
-
"type": "object",
|
|
778
|
-
"properties": {
|
|
779
|
-
"ops": {
|
|
780
|
-
"$ref": "#/definitions/parameterOpList"
|
|
781
|
-
},
|
|
782
|
-
"serialize": {
|
|
783
|
-
"$ref": "#/definitions/parameterSerializeConfigForSearchParams"
|
|
784
|
-
}
|
|
1215
|
+
"args": {
|
|
1216
|
+
"description": "Mapping and serialization configuration for args.",
|
|
1217
|
+
"$ref": "#/definitions/parameterConfigForJson"
|
|
785
1218
|
},
|
|
786
|
-
"
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
"parameterConfigForHeaders": {
|
|
790
|
-
"title": "Parameter Config For Headers",
|
|
791
|
-
"type": "object",
|
|
792
|
-
"properties": {
|
|
793
|
-
"ops": {
|
|
794
|
-
"$ref": "#/definitions/parameterOpList"
|
|
795
|
-
},
|
|
796
|
-
"serialize": {
|
|
797
|
-
"$ref": "#/definitions/parameterSerializeConfigForHeaders"
|
|
798
|
-
}
|
|
1219
|
+
"results": {
|
|
1220
|
+
"description": "Mapping configuration for the results of this resolver step.",
|
|
1221
|
+
"$ref": "#/definitions/parameterConfigForJson"
|
|
799
1222
|
},
|
|
800
|
-
"
|
|
801
|
-
|
|
802
|
-
},
|
|
803
|
-
"parameterConfigForJson": {
|
|
804
|
-
"title": "Parameter Config For Json",
|
|
805
|
-
"type": "object",
|
|
806
|
-
"properties": {
|
|
807
|
-
"ops": {
|
|
808
|
-
"$ref": "#/definitions/parameterOpList"
|
|
809
|
-
}
|
|
1223
|
+
"argsMapping": {
|
|
1224
|
+
"$ref": "#/definitions/argsMapping"
|
|
810
1225
|
},
|
|
811
|
-
"
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
"directiveConfig": {
|
|
815
|
-
"title": "Directive Config",
|
|
816
|
-
"description": "An array of individual directive config items to process in order",
|
|
817
|
-
"type": "array",
|
|
818
|
-
"items": {
|
|
819
|
-
"$ref": "#/definitions/directiveConfigItem"
|
|
1226
|
+
"searchParamsMapping": {
|
|
1227
|
+
"description": "Set or evaluate directives to generate searchParams for the service endpoint.",
|
|
1228
|
+
"$ref": "#/definitions/searchParamsMapping"
|
|
820
1229
|
},
|
|
821
|
-
"
|
|
1230
|
+
"resultsMapping": {
|
|
1231
|
+
"$ref": "#/definitions/resultsMapping"
|
|
1232
|
+
}
|
|
822
1233
|
},
|
|
823
|
-
"
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
1234
|
+
"required": ["name", "service", "functionName"],
|
|
1235
|
+
"additionalProperties": false
|
|
1236
|
+
},
|
|
1237
|
+
"composeResolver": {
|
|
1238
|
+
"title": "ComposeResolver",
|
|
1239
|
+
"type": "object",
|
|
1240
|
+
"properties": {
|
|
1241
|
+
"compose": {
|
|
1242
|
+
"type": "array",
|
|
1243
|
+
"items": {
|
|
1244
|
+
"$ref": "#/definitions/basicResolver"
|
|
830
1245
|
}
|
|
1246
|
+
},
|
|
1247
|
+
"resultsMapping": {
|
|
1248
|
+
"oneOf": [
|
|
1249
|
+
{
|
|
1250
|
+
"$ref": "#/definitions/directiveMappingMap"
|
|
1251
|
+
},
|
|
1252
|
+
{
|
|
1253
|
+
"$ref": "#/definitions/directiveConfig"
|
|
1254
|
+
}
|
|
1255
|
+
]
|
|
1256
|
+
},
|
|
1257
|
+
"results": {
|
|
1258
|
+
"description": "Mapping configuration for final query results.",
|
|
1259
|
+
"$ref": "#/definitions/parameterConfigForJson"
|
|
831
1260
|
}
|
|
832
1261
|
},
|
|
833
|
-
"
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
},
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
1262
|
+
"required": ["compose"],
|
|
1263
|
+
"additionalProperties": false
|
|
1264
|
+
},
|
|
1265
|
+
"resolver": {
|
|
1266
|
+
"title": "Resolver",
|
|
1267
|
+
"oneOf": [{"$ref": "#/definitions/basicResolver"}, {"$ref": "#/definitions/composeResolver"}]
|
|
1268
|
+
},
|
|
1269
|
+
"ref": {
|
|
1270
|
+
"title": "Ref",
|
|
1271
|
+
"type": "string"
|
|
1272
|
+
},
|
|
1273
|
+
"query": {
|
|
1274
|
+
"title": "Query",
|
|
1275
|
+
"type": "object",
|
|
1276
|
+
"properties": {
|
|
1277
|
+
"args": {
|
|
1278
|
+
"description": "The args field specifies the name of a Shape for the input arguments required by your resolver.",
|
|
1279
|
+
"$ref": "#/definitions/args"
|
|
1280
|
+
},
|
|
1281
|
+
"resolver": {
|
|
1282
|
+
"description": "Configures the resolver for your query or mutation.",
|
|
1283
|
+
"$ref": "#/definitions/resolver"
|
|
1284
|
+
},
|
|
1285
|
+
"shape": {
|
|
1286
|
+
"$ref": "#/definitions/returnShape",
|
|
1287
|
+
"description": "Specifies which shape is returned by the query or mutation. The shape can refer to a shape in the schema's \"shapes\" object or a shape that's available on a service schema."
|
|
1288
|
+
},
|
|
1289
|
+
"description": {
|
|
1290
|
+
"type": "string",
|
|
1291
|
+
"description": "Provides more detail about what the query or mutation is for. This will be displayed in the automatically-generated GraphQL API docs."
|
|
1292
|
+
}
|
|
844
1293
|
},
|
|
845
|
-
"
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
},
|
|
855
|
-
{
|
|
856
|
-
"$ref": "#/definitions/internalTakeshapeResolver"
|
|
857
|
-
},
|
|
858
|
-
{
|
|
859
|
-
"$ref": "#/definitions/graphqlResolver"
|
|
860
|
-
},
|
|
861
|
-
{
|
|
862
|
-
"$ref": "#/definitions/restResolver"
|
|
863
|
-
},
|
|
864
|
-
{
|
|
865
|
-
"$ref": "#/definitions/awsLambdaResolver"
|
|
866
|
-
}
|
|
867
|
-
]
|
|
868
|
-
},
|
|
869
|
-
"argsMapping": {
|
|
870
|
-
"title": "ArgsMapping",
|
|
871
|
-
"description": "Maps a query's input args to the input expected by the service's endpoint.",
|
|
872
|
-
"oneOf": [
|
|
873
|
-
{
|
|
874
|
-
"$ref": "#/definitions/directiveMappingMap"
|
|
875
|
-
},
|
|
876
|
-
{
|
|
877
|
-
"$ref": "#/definitions/directiveConfig"
|
|
878
|
-
}
|
|
879
|
-
]
|
|
880
|
-
},
|
|
881
|
-
"searchParamsMapping": {
|
|
882
|
-
"title": "SearchParamsMapping",
|
|
883
|
-
"description": "Set or evaluate directives to generate searchParams for the service endpoint.",
|
|
884
|
-
"$ref": "#/definitions/directiveMappingArray"
|
|
885
|
-
},
|
|
886
|
-
"resultsMapping": {
|
|
887
|
-
"title": "ResultsMapping",
|
|
888
|
-
"description": "Maps a service endpoint's response results to the expected shape of the query's response.",
|
|
889
|
-
"oneOf": [
|
|
890
|
-
{
|
|
891
|
-
"$ref": "#/definitions/directiveMappingMap"
|
|
892
|
-
},
|
|
893
|
-
{
|
|
894
|
-
"$ref": "#/definitions/directiveConfig"
|
|
895
|
-
}
|
|
896
|
-
]
|
|
897
|
-
},
|
|
898
|
-
"utilResolver": {
|
|
899
|
-
"title": "UtilResolver",
|
|
900
|
-
"type": "object",
|
|
901
|
-
"properties": {
|
|
902
|
-
"if": {
|
|
903
|
-
"type": "string"
|
|
904
|
-
},
|
|
905
|
-
"id": {
|
|
906
|
-
"type": "string",
|
|
907
|
-
"pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
|
|
908
|
-
},
|
|
909
|
-
"name": {
|
|
910
|
-
"title": "UtilResolverName",
|
|
911
|
-
"type": "string",
|
|
912
|
-
"description": "Name of the resolver function.",
|
|
913
|
-
"enum": ["debug:noop", "util:wrap"]
|
|
914
|
-
},
|
|
915
|
-
"service": {
|
|
916
|
-
"type": "string",
|
|
917
|
-
"description": "Configuration for a service to use with this resolver."
|
|
918
|
-
},
|
|
919
|
-
"options": {
|
|
920
|
-
"title": "UtilResolverOptions",
|
|
921
|
-
"type": "object",
|
|
922
|
-
"additionalProperties": true
|
|
923
|
-
},
|
|
924
|
-
"args": {
|
|
925
|
-
"description": "Mapping and serialization configuration for args.",
|
|
926
|
-
"$ref": "#/definitions/parameterConfigForJson"
|
|
927
|
-
},
|
|
928
|
-
"results": {
|
|
929
|
-
"description": "Mapping configuration for the results of this resolver step.",
|
|
930
|
-
"$ref": "#/definitions/parameterConfigForJson"
|
|
931
|
-
},
|
|
932
|
-
"argsMapping": {
|
|
933
|
-
"$ref": "#/definitions/argsMapping"
|
|
934
|
-
},
|
|
935
|
-
"resultsMapping": {
|
|
936
|
-
"$ref": "#/definitions/resultsMapping"
|
|
937
|
-
}
|
|
1294
|
+
"required": ["resolver", "shape"]
|
|
1295
|
+
},
|
|
1296
|
+
"propertySchema": {
|
|
1297
|
+
"title": "PropertySchema",
|
|
1298
|
+
"type": "object",
|
|
1299
|
+
"properties": {
|
|
1300
|
+
"$ref": {
|
|
1301
|
+
"type": "string",
|
|
1302
|
+
"format": "uri-reference"
|
|
938
1303
|
},
|
|
939
|
-
"
|
|
940
|
-
|
|
941
|
-
},
|
|
942
|
-
"takeshapeResolver": {
|
|
943
|
-
"title": "TakeshapeResolver",
|
|
944
|
-
"type": "object",
|
|
945
|
-
"properties": {
|
|
946
|
-
"if": {"type": "string"},
|
|
947
|
-
"id": {
|
|
948
|
-
"type": "string",
|
|
949
|
-
"pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
|
|
950
|
-
},
|
|
951
|
-
"name": {
|
|
952
|
-
"title": "TakeshapeResolverName",
|
|
953
|
-
"type": "string",
|
|
954
|
-
"description": "Name of the resolver function.",
|
|
955
|
-
"enum": [
|
|
956
|
-
"takeshape:get",
|
|
957
|
-
"takeshape:create",
|
|
958
|
-
"takeshape:update",
|
|
959
|
-
"takeshape:delete",
|
|
960
|
-
"takeshape:duplicate",
|
|
961
|
-
"takeshape:find",
|
|
962
|
-
"takeshape:queryApiIndex"
|
|
963
|
-
]
|
|
964
|
-
},
|
|
965
|
-
"service": {
|
|
966
|
-
"type": "string",
|
|
967
|
-
"description": "Internal service identifier.",
|
|
968
|
-
"enum": ["takeshape:local"]
|
|
969
|
-
},
|
|
970
|
-
"options": {
|
|
971
|
-
"title": "TakeshapeResolverOptions",
|
|
972
|
-
"type": "object",
|
|
973
|
-
"additionalProperties": true
|
|
974
|
-
},
|
|
975
|
-
"argsMapping": {
|
|
976
|
-
"$ref": "#/definitions/argsMapping"
|
|
977
|
-
},
|
|
978
|
-
"resultsMapping": {
|
|
979
|
-
"$ref": "#/definitions/resultsMapping"
|
|
980
|
-
},
|
|
981
|
-
"shapeName": {
|
|
982
|
-
"description": "A Shape name for the resolver to use.",
|
|
983
|
-
"type": "string",
|
|
984
|
-
"minLength": 1
|
|
985
|
-
},
|
|
986
|
-
"args": {
|
|
987
|
-
"description": "Mapping and serialization configuration for args.",
|
|
988
|
-
"$ref": "#/definitions/parameterConfigForJson"
|
|
989
|
-
},
|
|
990
|
-
"results": {
|
|
991
|
-
"description": "Mapping configuration for the results of this resolver step.",
|
|
992
|
-
"$ref": "#/definitions/parameterConfigForJson"
|
|
993
|
-
}
|
|
1304
|
+
"title": {
|
|
1305
|
+
"type": "string"
|
|
994
1306
|
},
|
|
995
|
-
"
|
|
996
|
-
|
|
997
|
-
},
|
|
998
|
-
"internalTakeshapeResolver": {
|
|
999
|
-
"title": "InternalTakeshapeResolver",
|
|
1000
|
-
"type": "object",
|
|
1001
|
-
"properties": {
|
|
1002
|
-
"if": {
|
|
1003
|
-
"type": "string"
|
|
1004
|
-
},
|
|
1005
|
-
"id": {
|
|
1006
|
-
"type": "string",
|
|
1007
|
-
"pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
|
|
1008
|
-
},
|
|
1009
|
-
"name": {
|
|
1010
|
-
"title": "InternalTakeshapeResolverName",
|
|
1011
|
-
"type": "string",
|
|
1012
|
-
"description": "Name of the resolver function.",
|
|
1013
|
-
"enum": ["takeshape:getRelationship", "takeshape:taxonomySuggest", "takeshape:list", "takeshape:search", "takeshape:getUser"]
|
|
1014
|
-
},
|
|
1015
|
-
"service": {
|
|
1016
|
-
"type": "string",
|
|
1017
|
-
"description": "Internal service identifier.",
|
|
1018
|
-
"enum": ["takeshape:local"]
|
|
1019
|
-
},
|
|
1020
|
-
"options": {
|
|
1021
|
-
"title": "TakeshapeResolverOptions",
|
|
1022
|
-
"type": "object",
|
|
1023
|
-
"additionalProperties": true
|
|
1024
|
-
},
|
|
1025
|
-
"shapeName": {
|
|
1026
|
-
"description": "An optional Shape name for the resolver.",
|
|
1027
|
-
"type": "string",
|
|
1028
|
-
"minLength": 1
|
|
1029
|
-
},
|
|
1030
|
-
"args": {
|
|
1031
|
-
"description": "Mapping and serialization configuration for args.",
|
|
1032
|
-
"$ref": "#/definitions/parameterConfigForJson"
|
|
1033
|
-
},
|
|
1034
|
-
"results": {
|
|
1035
|
-
"description": "Mapping configuration for the results of this resolver step.",
|
|
1036
|
-
"$ref": "#/definitions/parameterConfigForJson"
|
|
1037
|
-
},
|
|
1038
|
-
"argsMapping": {
|
|
1039
|
-
"$ref": "#/definitions/argsMapping"
|
|
1040
|
-
},
|
|
1041
|
-
"resultsMapping": {
|
|
1042
|
-
"$ref": "#/definitions/resultsMapping"
|
|
1043
|
-
}
|
|
1307
|
+
"description": {
|
|
1308
|
+
"type": "string"
|
|
1044
1309
|
},
|
|
1045
|
-
"
|
|
1046
|
-
"
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
"title": "GraphqlResolver",
|
|
1050
|
-
"type": "object",
|
|
1051
|
-
"properties": {
|
|
1052
|
-
"if": {"type": "string"},
|
|
1053
|
-
"id": {
|
|
1054
|
-
"type": "string",
|
|
1055
|
-
"pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
|
|
1056
|
-
},
|
|
1057
|
-
"name": {
|
|
1058
|
-
"title": "GraphqlResolverName",
|
|
1059
|
-
"type": "string",
|
|
1060
|
-
"description": "Name of the resolver function.",
|
|
1061
|
-
"enum": ["graphql:query", "graphql:mutation"]
|
|
1062
|
-
},
|
|
1063
|
-
"service": {
|
|
1064
|
-
"type": "string",
|
|
1065
|
-
"description": "Configuration for a service to use with this resolver."
|
|
1066
|
-
},
|
|
1067
|
-
"argsMapping": {
|
|
1068
|
-
"$ref": "#/definitions/argsMapping"
|
|
1069
|
-
},
|
|
1070
|
-
"resultsMapping": {
|
|
1071
|
-
"$ref": "#/definitions/resultsMapping"
|
|
1072
|
-
},
|
|
1073
|
-
"options": {
|
|
1074
|
-
"title": "GraphqlResolverOptions",
|
|
1075
|
-
"type": "object",
|
|
1076
|
-
"properties": {
|
|
1077
|
-
"selectionSet": {"type": "string"},
|
|
1078
|
-
"unboxParentSelectionSet": {"type": "boolean"},
|
|
1079
|
-
"ignoreErrors": {"type": "boolean"},
|
|
1080
|
-
"skipWhenMissingArgs": {"type": "boolean"},
|
|
1081
|
-
"ttl": {"type": "number"},
|
|
1082
|
-
"timeout": {"type": "number"},
|
|
1083
|
-
"retry": {"oneOf": [{"type": "number"}, {"type": "object"}]}
|
|
1084
|
-
},
|
|
1085
|
-
"additionalProperties": true
|
|
1086
|
-
},
|
|
1087
|
-
"fieldName": {
|
|
1088
|
-
"description": "A fieldname to use in queries.",
|
|
1089
|
-
"type": "string"
|
|
1090
|
-
},
|
|
1091
|
-
"headers": {
|
|
1092
|
-
"description": "Mapping and serialization configuration for headers.",
|
|
1093
|
-
"$ref": "#/definitions/parameterConfigForHeaders"
|
|
1094
|
-
},
|
|
1095
|
-
"searchParams": {
|
|
1096
|
-
"description": "Mapping and serialization configuration for searchParams.",
|
|
1097
|
-
"$ref": "#/definitions/parameterConfigForSearchParams"
|
|
1098
|
-
},
|
|
1099
|
-
"args": {
|
|
1100
|
-
"description": "Mapping and serialization configuration for args.",
|
|
1101
|
-
"$ref": "#/definitions/parameterConfigForJson"
|
|
1102
|
-
},
|
|
1103
|
-
"results": {
|
|
1104
|
-
"description": "Mapping configuration for the results of this resolver step.",
|
|
1105
|
-
"$ref": "#/definitions/parameterConfigForJson"
|
|
1106
|
-
}
|
|
1310
|
+
"default": {},
|
|
1311
|
+
"readOnly": {
|
|
1312
|
+
"type": "boolean",
|
|
1313
|
+
"default": false
|
|
1107
1314
|
},
|
|
1108
|
-
"
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
"restResolver": {
|
|
1112
|
-
"title": "RestResolver",
|
|
1113
|
-
"type": "object",
|
|
1114
|
-
"properties": {
|
|
1115
|
-
"if": {"type": "string"},
|
|
1116
|
-
"id": {
|
|
1117
|
-
"type": "string",
|
|
1118
|
-
"pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
|
|
1119
|
-
},
|
|
1120
|
-
"name": {
|
|
1121
|
-
"title": "RestResolverName",
|
|
1122
|
-
"type": "string",
|
|
1123
|
-
"description": "Name of the resolver function.",
|
|
1124
|
-
"enum": ["rest:get", "rest:head", "rest:post", "rest:put", "rest:patch", "rest:delete"]
|
|
1125
|
-
},
|
|
1126
|
-
"service": {
|
|
1127
|
-
"type": "string",
|
|
1128
|
-
"description": "Configuration for a service to use with this resolver."
|
|
1129
|
-
},
|
|
1130
|
-
"argsMapping": {
|
|
1131
|
-
"$ref": "#/definitions/argsMapping"
|
|
1132
|
-
},
|
|
1133
|
-
"searchParamsMapping": {
|
|
1134
|
-
"$ref": "#/definitions/searchParamsMapping"
|
|
1135
|
-
},
|
|
1136
|
-
"resultsMapping": {
|
|
1137
|
-
"$ref": "#/definitions/resultsMapping"
|
|
1138
|
-
},
|
|
1139
|
-
"options": {
|
|
1140
|
-
"title": "RestResolverOptions",
|
|
1141
|
-
"type": "object",
|
|
1142
|
-
"properties": {
|
|
1143
|
-
"trailingSlash": {"type": "boolean"},
|
|
1144
|
-
"ttl": {"type": "number"},
|
|
1145
|
-
"timeout": {"type": "number"},
|
|
1146
|
-
"retry": {"oneOf": [{"type": "number"}, {"type": "object"}]}
|
|
1147
|
-
},
|
|
1148
|
-
"additionalProperties": true
|
|
1149
|
-
},
|
|
1150
|
-
"body": {
|
|
1151
|
-
"description": "Mapping and serialization configuration for a request body.",
|
|
1152
|
-
"$ref": "#/definitions/parameterConfigForBody"
|
|
1153
|
-
},
|
|
1154
|
-
"form": {
|
|
1155
|
-
"description": "Mapping and serialization configuration for form data.",
|
|
1156
|
-
"$ref": "#/definitions/parameterConfigForSearchParams"
|
|
1157
|
-
},
|
|
1158
|
-
"headers": {
|
|
1159
|
-
"description": "Mapping and serialization configuration for headers.",
|
|
1160
|
-
"$ref": "#/definitions/parameterConfigForHeaders"
|
|
1161
|
-
},
|
|
1162
|
-
"json": {
|
|
1163
|
-
"description": "Mapping and serialization configuration for a json request body.",
|
|
1164
|
-
"$ref": "#/definitions/parameterConfigForJson"
|
|
1165
|
-
},
|
|
1166
|
-
"path": {
|
|
1167
|
-
"description": "Mapping and serialization configuration for the path, or a simple string.",
|
|
1168
|
-
"oneOf": [
|
|
1169
|
-
{
|
|
1170
|
-
"$ref": "#/definitions/parameterConfigForPathParams"
|
|
1171
|
-
},
|
|
1172
|
-
{
|
|
1173
|
-
"type": "string"
|
|
1174
|
-
}
|
|
1175
|
-
]
|
|
1176
|
-
},
|
|
1177
|
-
"searchParams": {
|
|
1178
|
-
"description": "Mapping and serialization configuration for searchParams.",
|
|
1179
|
-
"$ref": "#/definitions/parameterConfigForSearchParams"
|
|
1180
|
-
},
|
|
1181
|
-
"args": {
|
|
1182
|
-
"description": "Mapping and serialization configuration for args.",
|
|
1183
|
-
"$ref": "#/definitions/parameterConfigForJson"
|
|
1184
|
-
},
|
|
1185
|
-
"results": {
|
|
1186
|
-
"description": "Mapping configuration for the results of this resolver step.",
|
|
1187
|
-
"$ref": "#/definitions/parameterConfigForJson"
|
|
1188
|
-
}
|
|
1315
|
+
"multipleOf": {
|
|
1316
|
+
"type": "number",
|
|
1317
|
+
"exclusiveMinimum": 0
|
|
1189
1318
|
},
|
|
1190
|
-
"
|
|
1191
|
-
|
|
1192
|
-
},
|
|
1193
|
-
"awsLambdaResolver": {
|
|
1194
|
-
"title": "AwsLambdaResolver",
|
|
1195
|
-
"type": "object",
|
|
1196
|
-
"properties": {
|
|
1197
|
-
"if": {"type": "string"},
|
|
1198
|
-
"id": {
|
|
1199
|
-
"type": "string",
|
|
1200
|
-
"pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
|
|
1201
|
-
},
|
|
1202
|
-
"name": {
|
|
1203
|
-
"title": "AwsLambdaResolverName",
|
|
1204
|
-
"type": "string",
|
|
1205
|
-
"description": "Name of the resolver function.",
|
|
1206
|
-
"enum": ["awsLambda:invoke"]
|
|
1207
|
-
},
|
|
1208
|
-
"service": {
|
|
1209
|
-
"type": "string",
|
|
1210
|
-
"description": "Configuration for a service to use with this resolver."
|
|
1211
|
-
},
|
|
1212
|
-
"options": {
|
|
1213
|
-
"title": "AwsLambdaResolverOptions",
|
|
1214
|
-
"type": "object",
|
|
1215
|
-
"additionalProperties": true
|
|
1216
|
-
},
|
|
1217
|
-
"payload": {
|
|
1218
|
-
"description": "Mapping configuration the Payload.",
|
|
1219
|
-
"$ref": "#/definitions/parameterConfigForJson"
|
|
1220
|
-
},
|
|
1221
|
-
"functionName": {
|
|
1222
|
-
"description": "Mapping configuration for the FunctionName.",
|
|
1223
|
-
"oneOf": [
|
|
1224
|
-
{
|
|
1225
|
-
"type": "string"
|
|
1226
|
-
},
|
|
1227
|
-
{
|
|
1228
|
-
"$ref": "#/definitions/parameterConfigForAwsLambda"
|
|
1229
|
-
}
|
|
1230
|
-
]
|
|
1231
|
-
},
|
|
1232
|
-
"clientContext": {
|
|
1233
|
-
"description": "Mapping configuration for the ClientContext.",
|
|
1234
|
-
"$ref": "#/definitions/parameterConfigForJson"
|
|
1235
|
-
},
|
|
1236
|
-
"args": {
|
|
1237
|
-
"description": "Mapping and serialization configuration for args.",
|
|
1238
|
-
"$ref": "#/definitions/parameterConfigForJson"
|
|
1239
|
-
},
|
|
1240
|
-
"results": {
|
|
1241
|
-
"description": "Mapping configuration for the results of this resolver step.",
|
|
1242
|
-
"$ref": "#/definitions/parameterConfigForJson"
|
|
1243
|
-
},
|
|
1244
|
-
"argsMapping": {
|
|
1245
|
-
"$ref": "#/definitions/argsMapping"
|
|
1246
|
-
},
|
|
1247
|
-
"searchParamsMapping": {
|
|
1248
|
-
"description": "Set or evaluate directives to generate searchParams for the service endpoint.",
|
|
1249
|
-
"$ref": "#/definitions/searchParamsMapping"
|
|
1250
|
-
},
|
|
1251
|
-
"resultsMapping": {
|
|
1252
|
-
"$ref": "#/definitions/resultsMapping"
|
|
1253
|
-
}
|
|
1319
|
+
"maximum": {
|
|
1320
|
+
"type": "number"
|
|
1254
1321
|
},
|
|
1255
|
-
"
|
|
1256
|
-
|
|
1257
|
-
},
|
|
1258
|
-
"composeResolver": {
|
|
1259
|
-
"title": "ComposeResolver",
|
|
1260
|
-
"type": "object",
|
|
1261
|
-
"properties": {
|
|
1262
|
-
"compose": {
|
|
1263
|
-
"type": "array",
|
|
1264
|
-
"items": {
|
|
1265
|
-
"$ref": "#/definitions/basicResolver"
|
|
1266
|
-
}
|
|
1267
|
-
},
|
|
1268
|
-
"resultsMapping": {
|
|
1269
|
-
"oneOf": [
|
|
1270
|
-
{
|
|
1271
|
-
"$ref": "#/definitions/directiveMappingMap"
|
|
1272
|
-
},
|
|
1273
|
-
{
|
|
1274
|
-
"$ref": "#/definitions/directiveConfig"
|
|
1275
|
-
}
|
|
1276
|
-
]
|
|
1277
|
-
},
|
|
1278
|
-
"results": {
|
|
1279
|
-
"description": "Mapping configuration for final query results.",
|
|
1280
|
-
"$ref": "#/definitions/parameterConfigForJson"
|
|
1281
|
-
}
|
|
1322
|
+
"exclusiveMaximum": {
|
|
1323
|
+
"type": "number"
|
|
1282
1324
|
},
|
|
1283
|
-
"
|
|
1284
|
-
|
|
1285
|
-
},
|
|
1286
|
-
"resolver": {
|
|
1287
|
-
"title": "Resolver",
|
|
1288
|
-
"oneOf": [{"$ref": "#/definitions/basicResolver"}, {"$ref": "#/definitions/composeResolver"}]
|
|
1289
|
-
},
|
|
1290
|
-
"ref": {
|
|
1291
|
-
"title": "Ref",
|
|
1292
|
-
"type": "string"
|
|
1293
|
-
},
|
|
1294
|
-
"query": {
|
|
1295
|
-
"title": "Query",
|
|
1296
|
-
"type": "object",
|
|
1297
|
-
"properties": {
|
|
1298
|
-
"args": {
|
|
1299
|
-
"description": "The args field specifies the name of a Shape for the input arguments required by your resolver.",
|
|
1300
|
-
"$ref": "#/definitions/args"
|
|
1301
|
-
},
|
|
1302
|
-
"resolver": {
|
|
1303
|
-
"description": "Configures the resolver for your query or mutation.",
|
|
1304
|
-
"$ref": "#/definitions/resolver"
|
|
1305
|
-
},
|
|
1306
|
-
"shape": {
|
|
1307
|
-
"$ref": "#/definitions/returnShape",
|
|
1308
|
-
"description": "Specifies which shape is returned by the query or mutation. The shape can refer to a shape in the schema's \"shapes\" object or a shape that's available on a service schema."
|
|
1309
|
-
},
|
|
1310
|
-
"description": {
|
|
1311
|
-
"type": "string",
|
|
1312
|
-
"description": "Provides more detail about what the query or mutation is for. This will be displayed in the automatically-generated GraphQL API docs."
|
|
1313
|
-
}
|
|
1325
|
+
"minimum": {
|
|
1326
|
+
"type": "number"
|
|
1314
1327
|
},
|
|
1315
|
-
"
|
|
1316
|
-
|
|
1317
|
-
"propertySchema": {
|
|
1318
|
-
"title": "PropertySchema",
|
|
1319
|
-
"type": "object",
|
|
1320
|
-
"properties": {
|
|
1321
|
-
"$ref": {
|
|
1322
|
-
"type": "string",
|
|
1323
|
-
"format": "uri-reference"
|
|
1324
|
-
},
|
|
1325
|
-
"title": {
|
|
1326
|
-
"type": "string"
|
|
1327
|
-
},
|
|
1328
|
-
"description": {
|
|
1329
|
-
"type": "string"
|
|
1330
|
-
},
|
|
1331
|
-
"default": {},
|
|
1332
|
-
"readOnly": {
|
|
1333
|
-
"type": "boolean",
|
|
1334
|
-
"default": false
|
|
1335
|
-
},
|
|
1336
|
-
"multipleOf": {
|
|
1337
|
-
"type": "number",
|
|
1338
|
-
"exclusiveMinimum": 0
|
|
1339
|
-
},
|
|
1340
|
-
"maximum": {
|
|
1341
|
-
"type": "number"
|
|
1342
|
-
},
|
|
1343
|
-
"exclusiveMaximum": {
|
|
1344
|
-
"type": "number"
|
|
1345
|
-
},
|
|
1346
|
-
"minimum": {
|
|
1347
|
-
"type": "number"
|
|
1348
|
-
},
|
|
1349
|
-
"exclusiveMinimum": {
|
|
1350
|
-
"type": "number"
|
|
1351
|
-
},
|
|
1352
|
-
"maxLength": {
|
|
1353
|
-
"$ref": "#/definitions/nonNegativeInteger"
|
|
1354
|
-
},
|
|
1355
|
-
"minLength": {
|
|
1356
|
-
"$ref": "#/definitions/nonNegativeIntegerDefault0"
|
|
1357
|
-
},
|
|
1358
|
-
"pattern": {
|
|
1359
|
-
"type": "string",
|
|
1360
|
-
"format": "regex"
|
|
1361
|
-
},
|
|
1362
|
-
"additionalItems": {
|
|
1363
|
-
"$ref": "#/definitions/propertySchema"
|
|
1364
|
-
},
|
|
1365
|
-
"items": {
|
|
1366
|
-
"$ref": "#/definitions/propertySchema"
|
|
1367
|
-
},
|
|
1368
|
-
"maxItems": {
|
|
1369
|
-
"$ref": "#/definitions/nonNegativeInteger"
|
|
1370
|
-
},
|
|
1371
|
-
"minItems": {
|
|
1372
|
-
"$ref": "#/definitions/nonNegativeIntegerDefault0"
|
|
1373
|
-
},
|
|
1374
|
-
"uniqueItems": {
|
|
1375
|
-
"type": "boolean",
|
|
1376
|
-
"default": false
|
|
1377
|
-
},
|
|
1378
|
-
"contains": {
|
|
1379
|
-
"$ref": "#/definitions/propertySchema"
|
|
1380
|
-
},
|
|
1381
|
-
"maxProperties": {
|
|
1382
|
-
"$ref": "#/definitions/nonNegativeInteger"
|
|
1383
|
-
},
|
|
1384
|
-
"minProperties": {
|
|
1385
|
-
"$ref": "#/definitions/nonNegativeIntegerDefault0"
|
|
1386
|
-
},
|
|
1387
|
-
"required": {
|
|
1388
|
-
"$ref": "#/definitions/stringArray"
|
|
1389
|
-
},
|
|
1390
|
-
"additionalProperties": {
|
|
1391
|
-
"oneOf": [{"$ref": "#/definitions/propertySchema"}, {"enum": [false]}]
|
|
1392
|
-
},
|
|
1393
|
-
"definitions": {
|
|
1394
|
-
"type": "object",
|
|
1395
|
-
"additionalProperties": {
|
|
1396
|
-
"$ref": "#/definitions/propertySchema"
|
|
1397
|
-
},
|
|
1398
|
-
"default": {}
|
|
1399
|
-
},
|
|
1400
|
-
"properties": {
|
|
1401
|
-
"type": "object",
|
|
1402
|
-
"additionalProperties": {
|
|
1403
|
-
"$ref": "#/definitions/propertySchema"
|
|
1404
|
-
},
|
|
1405
|
-
"default": {}
|
|
1406
|
-
},
|
|
1407
|
-
"const": {},
|
|
1408
|
-
"enum": {
|
|
1409
|
-
"type": "array",
|
|
1410
|
-
"minItems": 1,
|
|
1411
|
-
"uniqueItems": true
|
|
1412
|
-
},
|
|
1413
|
-
"type": {
|
|
1414
|
-
"anyOf": [
|
|
1415
|
-
{
|
|
1416
|
-
"$ref": "#/definitions/simpleTypes"
|
|
1417
|
-
},
|
|
1418
|
-
{
|
|
1419
|
-
"type": "array",
|
|
1420
|
-
"items": {
|
|
1421
|
-
"$ref": "#/definitions/simpleTypes"
|
|
1422
|
-
},
|
|
1423
|
-
"minItems": 1,
|
|
1424
|
-
"uniqueItems": true
|
|
1425
|
-
}
|
|
1426
|
-
]
|
|
1427
|
-
},
|
|
1428
|
-
"format": {
|
|
1429
|
-
"type": "string"
|
|
1430
|
-
},
|
|
1431
|
-
"contentMediaType": {
|
|
1432
|
-
"type": "string"
|
|
1433
|
-
},
|
|
1434
|
-
"contentEncoding": {
|
|
1435
|
-
"type": "string"
|
|
1436
|
-
},
|
|
1437
|
-
"allOf": {
|
|
1438
|
-
"$ref": "#/definitions/schemaArray"
|
|
1439
|
-
},
|
|
1440
|
-
"discriminator": {
|
|
1441
|
-
"type": "object",
|
|
1442
|
-
"properties": {
|
|
1443
|
-
"propertyName": {
|
|
1444
|
-
"type": "string"
|
|
1445
|
-
}
|
|
1446
|
-
}
|
|
1447
|
-
},
|
|
1448
|
-
"oneOf": {
|
|
1449
|
-
"$ref": "#/definitions/schemaArray"
|
|
1450
|
-
},
|
|
1451
|
-
"extends": {
|
|
1452
|
-
"$ref": "#/definitions/objectOrRefArray"
|
|
1453
|
-
},
|
|
1454
|
-
"@relationship": {
|
|
1455
|
-
"$ref": "#/definitions/relationship"
|
|
1456
|
-
},
|
|
1457
|
-
"@backreference": {
|
|
1458
|
-
"$ref": "#/definitions/backreference"
|
|
1459
|
-
},
|
|
1460
|
-
"@input": {
|
|
1461
|
-
"$ref": "#/definitions/input"
|
|
1462
|
-
},
|
|
1463
|
-
"@syncLocaleStructure": {
|
|
1464
|
-
"type": "boolean"
|
|
1465
|
-
},
|
|
1466
|
-
"@sensitive": {
|
|
1467
|
-
"type": "boolean"
|
|
1468
|
-
},
|
|
1469
|
-
"@draftjs": {
|
|
1470
|
-
"type": "boolean"
|
|
1471
|
-
},
|
|
1472
|
-
"@l10n": {
|
|
1473
|
-
"type": "boolean"
|
|
1474
|
-
},
|
|
1475
|
-
"@key": {
|
|
1476
|
-
"type": "string",
|
|
1477
|
-
"pattern": "^[-_a-zA-Z0-9]+$"
|
|
1478
|
-
},
|
|
1479
|
-
"@workflow": {
|
|
1480
|
-
"type": "string"
|
|
1481
|
-
},
|
|
1482
|
-
"@mapping": {
|
|
1483
|
-
"$ref": "#/definitions/fieldMapping"
|
|
1484
|
-
},
|
|
1485
|
-
"@tag": {
|
|
1486
|
-
"type": "string"
|
|
1487
|
-
},
|
|
1488
|
-
"@tags": {
|
|
1489
|
-
"type": "array",
|
|
1490
|
-
"items": {
|
|
1491
|
-
"type": "string"
|
|
1492
|
-
}
|
|
1493
|
-
},
|
|
1494
|
-
"@deprecationReason": {
|
|
1495
|
-
"type": "string"
|
|
1496
|
-
},
|
|
1497
|
-
"@args": {
|
|
1498
|
-
"$ref": "#/definitions/args"
|
|
1499
|
-
},
|
|
1500
|
-
"@resolver": {
|
|
1501
|
-
"$ref": "#/definitions/resolver"
|
|
1502
|
-
},
|
|
1503
|
-
"@ref": {
|
|
1504
|
-
"$ref": "#/definitions/ref"
|
|
1505
|
-
},
|
|
1506
|
-
"@derivedFrom": {
|
|
1507
|
-
"type": "string"
|
|
1508
|
-
}
|
|
1328
|
+
"exclusiveMinimum": {
|
|
1329
|
+
"type": "number"
|
|
1509
1330
|
},
|
|
1510
|
-
"
|
|
1511
|
-
|
|
1512
|
-
"shape": {
|
|
1513
|
-
"title": "Shape",
|
|
1514
|
-
"description": "A Shape is a schema object for structuring and storing data from one or more sources, including the TakeShape data store and connected services",
|
|
1515
|
-
"type": "object",
|
|
1516
|
-
"properties": {
|
|
1517
|
-
"name": {
|
|
1518
|
-
"type": "string",
|
|
1519
|
-
"pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$",
|
|
1520
|
-
"description": "The Pascal-cased human-readable id for a Shape. This value should match the shape's key in the shapes object. This value is used in @ref and @mapping annotations"
|
|
1521
|
-
},
|
|
1522
|
-
"id": {
|
|
1523
|
-
"type": "string",
|
|
1524
|
-
"pattern": "[0-9A-Za-z_-]+",
|
|
1525
|
-
"description": "The machine-readable id for a Shape which should never change. When using TakeShape's built-in database to store Shape data, this value is used database as a stable \"table name\" and changing it will result in orphaning that data."
|
|
1526
|
-
},
|
|
1527
|
-
"title": {
|
|
1528
|
-
"type": "string",
|
|
1529
|
-
"description": "The human-readable name for a Shape for use in a UI."
|
|
1530
|
-
},
|
|
1531
|
-
"description": {
|
|
1532
|
-
"type": "string"
|
|
1533
|
-
},
|
|
1534
|
-
"model": {
|
|
1535
|
-
"description": "Specifying a model type allows Shape data to be stored in TakeShape's built-in database",
|
|
1536
|
-
"type": "object",
|
|
1537
|
-
"properties": {
|
|
1538
|
-
"type": {
|
|
1539
|
-
"title": "Model Type",
|
|
1540
|
-
"type": "string",
|
|
1541
|
-
"enum": ["single", "multiple", "taxonomy"]
|
|
1542
|
-
}
|
|
1543
|
-
},
|
|
1544
|
-
"required": ["type"],
|
|
1545
|
-
"additionalProperties": false
|
|
1546
|
-
},
|
|
1547
|
-
"workflow": {
|
|
1548
|
-
"type": "string"
|
|
1549
|
-
},
|
|
1550
|
-
"schema": {
|
|
1551
|
-
"$ref": "#/definitions/shapeSchema"
|
|
1552
|
-
}
|
|
1331
|
+
"maxLength": {
|
|
1332
|
+
"$ref": "#/definitions/nonNegativeInteger"
|
|
1553
1333
|
},
|
|
1554
|
-
"
|
|
1555
|
-
|
|
1556
|
-
},
|
|
1557
|
-
"shapeWithObjectSchema": {
|
|
1558
|
-
"title": "Shape With Object Schema",
|
|
1559
|
-
"type": "object",
|
|
1560
|
-
"allOf": [
|
|
1561
|
-
{
|
|
1562
|
-
"$ref": "#/definitions/shape"
|
|
1563
|
-
},
|
|
1564
|
-
{
|
|
1565
|
-
"type": "object",
|
|
1566
|
-
"properties": {
|
|
1567
|
-
"schema": {
|
|
1568
|
-
"$ref": "#/definitions/objectSchema"
|
|
1569
|
-
}
|
|
1570
|
-
},
|
|
1571
|
-
"required": ["schema"],
|
|
1572
|
-
"additionalProperties": false
|
|
1573
|
-
}
|
|
1574
|
-
]
|
|
1575
|
-
},
|
|
1576
|
-
"shapeMap": {
|
|
1577
|
-
"title": "Shape Map",
|
|
1578
|
-
"type": "object",
|
|
1579
|
-
"patternProperties": {
|
|
1580
|
-
"[0-9A-Za-z_-]+": {"$ref": "#/definitions/shape"}
|
|
1581
|
-
}
|
|
1582
|
-
},
|
|
1583
|
-
"formMap": {
|
|
1584
|
-
"title": "Form Map",
|
|
1585
|
-
"type": "object",
|
|
1586
|
-
"patternProperties": {
|
|
1587
|
-
"[0-9A-Za-z_-]+": {
|
|
1588
|
-
"$ref": "#/definitions/formsConfig"
|
|
1589
|
-
}
|
|
1590
|
-
}
|
|
1591
|
-
},
|
|
1592
|
-
"indexedShapeMap": {
|
|
1593
|
-
"title": "Indexed Shape Map",
|
|
1594
|
-
"type": "object",
|
|
1595
|
-
"patternProperties": {
|
|
1596
|
-
"[0-9A-Za-z_-]+": {
|
|
1597
|
-
"$ref": "#/definitions/indexedShapeConfig"
|
|
1598
|
-
}
|
|
1599
|
-
}
|
|
1600
|
-
},
|
|
1601
|
-
"indexedShapeConfig": {
|
|
1602
|
-
"title": "Indexed Shape Config",
|
|
1603
|
-
"type": "object",
|
|
1604
|
-
"properties": {
|
|
1605
|
-
"idField": {
|
|
1606
|
-
"type": "string"
|
|
1607
|
-
},
|
|
1608
|
-
"searchSummaryField": {
|
|
1609
|
-
"type": "string"
|
|
1610
|
-
},
|
|
1611
|
-
"queries": {
|
|
1612
|
-
"$ref": "#/definitions/indexedShapeQueriesConfig"
|
|
1613
|
-
},
|
|
1614
|
-
"triggers": {
|
|
1615
|
-
"type": "array",
|
|
1616
|
-
"items": {
|
|
1617
|
-
"$ref": "#/definitions/indexedShapeTriggersConfig"
|
|
1618
|
-
}
|
|
1619
|
-
}
|
|
1334
|
+
"minLength": {
|
|
1335
|
+
"$ref": "#/definitions/nonNegativeIntegerDefault0"
|
|
1620
1336
|
},
|
|
1621
|
-
"
|
|
1622
|
-
|
|
1623
|
-
|
|
1624
|
-
"indexedShapeQueriesConfig": {
|
|
1625
|
-
"title": "Indexed Shape Queries Config",
|
|
1626
|
-
"type": "object",
|
|
1627
|
-
"properties": {
|
|
1628
|
-
"list": {
|
|
1629
|
-
"$ref": "#/definitions/indexedShapeListQueryConfig"
|
|
1630
|
-
},
|
|
1631
|
-
"get": {
|
|
1632
|
-
"$ref": "#/definitions/indexedShapeGetQueryConfig"
|
|
1633
|
-
}
|
|
1337
|
+
"pattern": {
|
|
1338
|
+
"type": "string",
|
|
1339
|
+
"format": "regex"
|
|
1634
1340
|
},
|
|
1635
|
-
"
|
|
1636
|
-
|
|
1637
|
-
"indexedShapeListQueryConfig": {
|
|
1638
|
-
"title": "Indexed Shape Query All Config",
|
|
1639
|
-
"type": "object",
|
|
1640
|
-
"properties": {
|
|
1641
|
-
"name": {
|
|
1642
|
-
"type": "string"
|
|
1643
|
-
},
|
|
1644
|
-
"ignoreFields": {
|
|
1645
|
-
"type": "array",
|
|
1646
|
-
"items": {
|
|
1647
|
-
"type": "string"
|
|
1648
|
-
}
|
|
1649
|
-
},
|
|
1650
|
-
"objectDepthLimit": {
|
|
1651
|
-
"type": "number"
|
|
1652
|
-
},
|
|
1653
|
-
"pagination": {
|
|
1654
|
-
"$ref": "#/definitions/paginationConfig"
|
|
1655
|
-
}
|
|
1341
|
+
"additionalItems": {
|
|
1342
|
+
"$ref": "#/definitions/propertySchema"
|
|
1656
1343
|
},
|
|
1657
|
-
"
|
|
1658
|
-
|
|
1659
|
-
},
|
|
1660
|
-
"indexedShapeGetQueryConfig": {
|
|
1661
|
-
"title": "Indexed Shape Query Single Config",
|
|
1662
|
-
"type": "object",
|
|
1663
|
-
"properties": {
|
|
1664
|
-
"name": {
|
|
1665
|
-
"type": "string"
|
|
1666
|
-
},
|
|
1667
|
-
"ignoreFields": {
|
|
1668
|
-
"type": "array",
|
|
1669
|
-
"items": {
|
|
1670
|
-
"type": "string"
|
|
1671
|
-
}
|
|
1672
|
-
},
|
|
1673
|
-
"objectDepthLimit": {
|
|
1674
|
-
"type": "number"
|
|
1675
|
-
},
|
|
1676
|
-
"idArg": {
|
|
1677
|
-
"type": "string"
|
|
1678
|
-
}
|
|
1344
|
+
"items": {
|
|
1345
|
+
"$ref": "#/definitions/propertySchema"
|
|
1679
1346
|
},
|
|
1680
|
-
"
|
|
1681
|
-
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
|
|
1686
|
-
|
|
1687
|
-
|
|
1688
|
-
|
|
1689
|
-
|
|
1690
|
-
|
|
1691
|
-
|
|
1692
|
-
{
|
|
1693
|
-
"$ref": "#/definitions/paginationOffsetConfig"
|
|
1694
|
-
}
|
|
1695
|
-
]
|
|
1696
|
-
},
|
|
1697
|
-
"paginationCursorConfig": {
|
|
1698
|
-
"title": "Pagination Cursor Config",
|
|
1699
|
-
"type": "object",
|
|
1700
|
-
"properties": {
|
|
1701
|
-
"type": {
|
|
1702
|
-
"type": "string",
|
|
1703
|
-
"enum": ["cursor"]
|
|
1704
|
-
},
|
|
1705
|
-
"cursorArg": {
|
|
1706
|
-
"type": "string"
|
|
1707
|
-
},
|
|
1708
|
-
"cursorPath": {
|
|
1709
|
-
"type": "string"
|
|
1710
|
-
},
|
|
1711
|
-
"pageSize": {
|
|
1712
|
-
"type": "number"
|
|
1713
|
-
},
|
|
1714
|
-
"pageSizeArg": {
|
|
1715
|
-
"type": "string"
|
|
1716
|
-
},
|
|
1717
|
-
"hasMorePath": {
|
|
1718
|
-
"type": "string"
|
|
1719
|
-
},
|
|
1720
|
-
"itemsToIndexPath": {
|
|
1721
|
-
"type": "string"
|
|
1722
|
-
}
|
|
1347
|
+
"maxItems": {
|
|
1348
|
+
"$ref": "#/definitions/nonNegativeInteger"
|
|
1349
|
+
},
|
|
1350
|
+
"minItems": {
|
|
1351
|
+
"$ref": "#/definitions/nonNegativeIntegerDefault0"
|
|
1352
|
+
},
|
|
1353
|
+
"uniqueItems": {
|
|
1354
|
+
"type": "boolean",
|
|
1355
|
+
"default": false
|
|
1356
|
+
},
|
|
1357
|
+
"contains": {
|
|
1358
|
+
"$ref": "#/definitions/propertySchema"
|
|
1723
1359
|
},
|
|
1724
|
-
"
|
|
1725
|
-
|
|
1726
|
-
},
|
|
1727
|
-
"paginationPageConfig": {
|
|
1728
|
-
"title": "Pagination Page Config",
|
|
1729
|
-
"type": "object",
|
|
1730
|
-
"properties": {
|
|
1731
|
-
"type": {
|
|
1732
|
-
"type": "string",
|
|
1733
|
-
"enum": ["page"]
|
|
1734
|
-
},
|
|
1735
|
-
"pageArg": {
|
|
1736
|
-
"type": "string"
|
|
1737
|
-
},
|
|
1738
|
-
"itemsToIndexPath": {
|
|
1739
|
-
"type": "string"
|
|
1740
|
-
},
|
|
1741
|
-
"pageTotalPath": {
|
|
1742
|
-
"type": "string"
|
|
1743
|
-
}
|
|
1360
|
+
"maxProperties": {
|
|
1361
|
+
"$ref": "#/definitions/nonNegativeInteger"
|
|
1744
1362
|
},
|
|
1745
|
-
"
|
|
1746
|
-
|
|
1747
|
-
},
|
|
1748
|
-
"paginationOffsetConfig": {
|
|
1749
|
-
"title": "Pagination Offset Config",
|
|
1750
|
-
"type": "object",
|
|
1751
|
-
"properties": {
|
|
1752
|
-
"type": {
|
|
1753
|
-
"type": "string",
|
|
1754
|
-
"enum": ["offset"]
|
|
1755
|
-
},
|
|
1756
|
-
"offsetArg": {
|
|
1757
|
-
"type": "string"
|
|
1758
|
-
},
|
|
1759
|
-
"itemsToIndexPath": {
|
|
1760
|
-
"type": "string"
|
|
1761
|
-
},
|
|
1762
|
-
"itemTotalPath": {
|
|
1763
|
-
"type": "string"
|
|
1764
|
-
}
|
|
1363
|
+
"minProperties": {
|
|
1364
|
+
"$ref": "#/definitions/nonNegativeIntegerDefault0"
|
|
1765
1365
|
},
|
|
1766
|
-
"
|
|
1767
|
-
|
|
1768
|
-
|
|
1769
|
-
|
|
1770
|
-
|
|
1771
|
-
|
|
1772
|
-
|
|
1773
|
-
|
|
1774
|
-
|
|
1775
|
-
|
|
1776
|
-
"$ref": "#/definitions/indexedShapeWebhookTriggerConfig"
|
|
1777
|
-
}
|
|
1778
|
-
]
|
|
1779
|
-
},
|
|
1780
|
-
"indexedShapeScheduleTriggerConfig": {
|
|
1781
|
-
"title": "Indexed Shape Schedule Trigger Config",
|
|
1782
|
-
"type": "object",
|
|
1783
|
-
"properties": {
|
|
1784
|
-
"type": {
|
|
1785
|
-
"type": "string",
|
|
1786
|
-
"enum": ["schedule"]
|
|
1787
|
-
},
|
|
1788
|
-
"query": {
|
|
1789
|
-
"enum": ["get", "list"]
|
|
1366
|
+
"required": {
|
|
1367
|
+
"$ref": "#/definitions/stringArray"
|
|
1368
|
+
},
|
|
1369
|
+
"additionalProperties": {
|
|
1370
|
+
"oneOf": [{"$ref": "#/definitions/propertySchema"}, {"enum": [false]}]
|
|
1371
|
+
},
|
|
1372
|
+
"definitions": {
|
|
1373
|
+
"type": "object",
|
|
1374
|
+
"additionalProperties": {
|
|
1375
|
+
"$ref": "#/definitions/propertySchema"
|
|
1790
1376
|
},
|
|
1791
|
-
"
|
|
1792
|
-
"type": "number"
|
|
1793
|
-
}
|
|
1377
|
+
"default": {}
|
|
1794
1378
|
},
|
|
1795
|
-
"additionalProperties": false,
|
|
1796
|
-
"required": ["type", "query", "interval"]
|
|
1797
|
-
},
|
|
1798
|
-
"indexedShapeWebhookTriggerConfig": {
|
|
1799
|
-
"title": "Indexed Shape Webhook Trigger Config",
|
|
1800
|
-
"type": "object",
|
|
1801
1379
|
"properties": {
|
|
1802
|
-
"type":
|
|
1803
|
-
|
|
1804
|
-
"
|
|
1805
|
-
},
|
|
1806
|
-
"query": {
|
|
1807
|
-
"enum": ["get", "list"]
|
|
1808
|
-
},
|
|
1809
|
-
"service": {
|
|
1810
|
-
"type": "string"
|
|
1380
|
+
"type": "object",
|
|
1381
|
+
"additionalProperties": {
|
|
1382
|
+
"$ref": "#/definitions/propertySchema"
|
|
1811
1383
|
},
|
|
1812
|
-
"
|
|
1813
|
-
|
|
1814
|
-
|
|
1384
|
+
"default": {}
|
|
1385
|
+
},
|
|
1386
|
+
"const": {},
|
|
1387
|
+
"enum": {
|
|
1388
|
+
"type": "array",
|
|
1389
|
+
"minItems": 1,
|
|
1390
|
+
"uniqueItems": true
|
|
1391
|
+
},
|
|
1392
|
+
"type": {
|
|
1393
|
+
"anyOf": [
|
|
1394
|
+
{
|
|
1395
|
+
"$ref": "#/definitions/simpleTypes"
|
|
1396
|
+
},
|
|
1397
|
+
{
|
|
1398
|
+
"type": "array",
|
|
1399
|
+
"items": {
|
|
1400
|
+
"$ref": "#/definitions/simpleTypes"
|
|
1401
|
+
},
|
|
1402
|
+
"minItems": 1,
|
|
1403
|
+
"uniqueItems": true
|
|
1404
|
+
}
|
|
1405
|
+
]
|
|
1406
|
+
},
|
|
1407
|
+
"format": {
|
|
1408
|
+
"type": "string"
|
|
1409
|
+
},
|
|
1410
|
+
"contentMediaType": {
|
|
1411
|
+
"type": "string"
|
|
1412
|
+
},
|
|
1413
|
+
"contentEncoding": {
|
|
1414
|
+
"type": "string"
|
|
1415
|
+
},
|
|
1416
|
+
"allOf": {
|
|
1417
|
+
"$ref": "#/definitions/schemaArray"
|
|
1418
|
+
},
|
|
1419
|
+
"discriminator": {
|
|
1420
|
+
"type": "object",
|
|
1421
|
+
"properties": {
|
|
1422
|
+
"propertyName": {
|
|
1815
1423
|
"type": "string"
|
|
1816
1424
|
}
|
|
1817
1425
|
}
|
|
1818
1426
|
},
|
|
1819
|
-
"
|
|
1820
|
-
|
|
1821
|
-
|
|
1822
|
-
|
|
1823
|
-
|
|
1824
|
-
|
|
1825
|
-
"
|
|
1826
|
-
"
|
|
1427
|
+
"oneOf": {
|
|
1428
|
+
"$ref": "#/definitions/schemaArray"
|
|
1429
|
+
},
|
|
1430
|
+
"extends": {
|
|
1431
|
+
"$ref": "#/definitions/objectOrRefArray"
|
|
1432
|
+
},
|
|
1433
|
+
"@backreference": {
|
|
1434
|
+
"$ref": "#/definitions/backreference"
|
|
1435
|
+
},
|
|
1436
|
+
"@input": {
|
|
1437
|
+
"description": "A PropertySchema providing an alternative shape for a GraphQL input type.",
|
|
1438
|
+
"$ref": "#/definitions/propertySchema"
|
|
1439
|
+
},
|
|
1440
|
+
"@output": {
|
|
1441
|
+
"description": "A PropertySchema which is original output.",
|
|
1442
|
+
"$ref": "#/definitions/propertySchema"
|
|
1443
|
+
},
|
|
1444
|
+
"@syncLocaleStructure": {
|
|
1445
|
+
"type": "boolean"
|
|
1446
|
+
},
|
|
1447
|
+
"@sensitive": {
|
|
1448
|
+
"type": "boolean"
|
|
1449
|
+
},
|
|
1450
|
+
"@draftjs": {
|
|
1451
|
+
"type": "boolean"
|
|
1452
|
+
},
|
|
1453
|
+
"@l10n": {
|
|
1454
|
+
"type": "boolean"
|
|
1455
|
+
},
|
|
1456
|
+
"@key": {
|
|
1457
|
+
"type": "string",
|
|
1458
|
+
"pattern": "^[-_a-zA-Z0-9]+$"
|
|
1459
|
+
},
|
|
1460
|
+
"@workflow": {
|
|
1461
|
+
"type": "string"
|
|
1462
|
+
},
|
|
1463
|
+
"@mapping": {
|
|
1464
|
+
"$ref": "#/definitions/fieldMapping"
|
|
1465
|
+
},
|
|
1466
|
+
"@tag": {
|
|
1467
|
+
"type": "string"
|
|
1468
|
+
},
|
|
1469
|
+
"@tags": {
|
|
1470
|
+
"type": "array",
|
|
1471
|
+
"items": {
|
|
1827
1472
|
"type": "string"
|
|
1828
1473
|
}
|
|
1829
1474
|
},
|
|
1830
|
-
"
|
|
1831
|
-
|
|
1475
|
+
"@deprecationReason": {
|
|
1476
|
+
"type": "string"
|
|
1477
|
+
},
|
|
1478
|
+
"@args": {
|
|
1479
|
+
"$ref": "#/definitions/args"
|
|
1480
|
+
},
|
|
1481
|
+
"@resolver": {
|
|
1482
|
+
"$ref": "#/definitions/resolver"
|
|
1483
|
+
},
|
|
1484
|
+
"@ref": {
|
|
1485
|
+
"$ref": "#/definitions/ref"
|
|
1486
|
+
},
|
|
1487
|
+
"@derivedFrom": {
|
|
1488
|
+
"type": "string"
|
|
1489
|
+
}
|
|
1832
1490
|
},
|
|
1833
|
-
"
|
|
1834
|
-
|
|
1835
|
-
|
|
1836
|
-
|
|
1837
|
-
|
|
1838
|
-
|
|
1839
|
-
|
|
1840
|
-
|
|
1841
|
-
|
|
1842
|
-
|
|
1843
|
-
|
|
1844
|
-
|
|
1845
|
-
|
|
1491
|
+
"additionalProperties": false
|
|
1492
|
+
},
|
|
1493
|
+
"shape": {
|
|
1494
|
+
"title": "Shape",
|
|
1495
|
+
"description": "A Shape is a schema object for structuring and storing data from one or more sources, including the TakeShape data store and connected services",
|
|
1496
|
+
"type": "object",
|
|
1497
|
+
"properties": {
|
|
1498
|
+
"name": {
|
|
1499
|
+
"type": "string",
|
|
1500
|
+
"pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$",
|
|
1501
|
+
"description": "The Pascal-cased human-readable id for a Shape. This value should match the shape's key in the shapes object. This value is used in @ref and @mapping annotations"
|
|
1502
|
+
},
|
|
1503
|
+
"id": {
|
|
1504
|
+
"type": "string",
|
|
1505
|
+
"pattern": "[0-9A-Za-z_-]+",
|
|
1506
|
+
"description": "The machine-readable id for a Shape which should never change. When using TakeShape's built-in database to store Shape data, this value is used database as a stable \"table name\" and changing it will result in orphaning that data."
|
|
1507
|
+
},
|
|
1508
|
+
"title": {
|
|
1509
|
+
"type": "string",
|
|
1510
|
+
"description": "The human-readable name for a Shape for use in a UI."
|
|
1511
|
+
},
|
|
1512
|
+
"description": {
|
|
1513
|
+
"type": "string"
|
|
1514
|
+
},
|
|
1515
|
+
"model": {
|
|
1516
|
+
"description": "Specifying a model type allows Shape data to be stored in TakeShape's built-in database",
|
|
1517
|
+
"type": "object",
|
|
1846
1518
|
"properties": {
|
|
1847
|
-
"
|
|
1848
|
-
"
|
|
1849
|
-
|
|
1850
|
-
|
|
1519
|
+
"type": {
|
|
1520
|
+
"title": "Model Type",
|
|
1521
|
+
"type": "string",
|
|
1522
|
+
"enum": ["single", "multiple", "taxonomy"]
|
|
1851
1523
|
}
|
|
1852
|
-
}
|
|
1524
|
+
},
|
|
1525
|
+
"required": ["type"],
|
|
1526
|
+
"additionalProperties": false
|
|
1853
1527
|
},
|
|
1854
|
-
"
|
|
1528
|
+
"workflow": {
|
|
1529
|
+
"type": "string"
|
|
1530
|
+
},
|
|
1531
|
+
"schema": {
|
|
1532
|
+
"$ref": "#/definitions/shapeSchema"
|
|
1533
|
+
}
|
|
1855
1534
|
},
|
|
1856
|
-
"
|
|
1857
|
-
|
|
1858
|
-
|
|
1859
|
-
|
|
1860
|
-
|
|
1861
|
-
|
|
1535
|
+
"required": ["name", "title", "id", "schema"],
|
|
1536
|
+
"additionalProperties": false
|
|
1537
|
+
},
|
|
1538
|
+
"shapeWithObjectSchema": {
|
|
1539
|
+
"title": "Shape With Object Schema",
|
|
1540
|
+
"type": "object",
|
|
1541
|
+
"allOf": [
|
|
1542
|
+
{
|
|
1543
|
+
"$ref": "#/definitions/shape"
|
|
1544
|
+
},
|
|
1545
|
+
{
|
|
1546
|
+
"type": "object",
|
|
1547
|
+
"properties": {
|
|
1548
|
+
"schema": {
|
|
1549
|
+
"$ref": "#/definitions/objectSchema"
|
|
1550
|
+
}
|
|
1862
1551
|
},
|
|
1552
|
+
"required": ["schema"],
|
|
1553
|
+
"additionalProperties": false
|
|
1554
|
+
}
|
|
1555
|
+
]
|
|
1556
|
+
},
|
|
1557
|
+
"shapeMap": {
|
|
1558
|
+
"title": "Shape Map",
|
|
1559
|
+
"type": "object",
|
|
1560
|
+
"patternProperties": {
|
|
1561
|
+
"[0-9A-Za-z_-]+": {"$ref": "#/definitions/shape"}
|
|
1562
|
+
}
|
|
1563
|
+
},
|
|
1564
|
+
"formMap": {
|
|
1565
|
+
"title": "Form Map",
|
|
1566
|
+
"type": "object",
|
|
1567
|
+
"patternProperties": {
|
|
1568
|
+
"[0-9A-Za-z_-]+": {
|
|
1569
|
+
"$ref": "#/definitions/formsConfig"
|
|
1570
|
+
}
|
|
1571
|
+
}
|
|
1572
|
+
},
|
|
1573
|
+
"indexedShapeMap": {
|
|
1574
|
+
"title": "Indexed Shape Map",
|
|
1575
|
+
"type": "object",
|
|
1576
|
+
"patternProperties": {
|
|
1577
|
+
"[0-9A-Za-z_-]+": {
|
|
1578
|
+
"$ref": "#/definitions/indexedShapeConfig"
|
|
1579
|
+
}
|
|
1580
|
+
}
|
|
1581
|
+
},
|
|
1582
|
+
"indexedShapeConfig": {
|
|
1583
|
+
"title": "Indexed Shape Config",
|
|
1584
|
+
"type": "object",
|
|
1585
|
+
"properties": {
|
|
1586
|
+
"idField": {
|
|
1587
|
+
"type": "string"
|
|
1588
|
+
},
|
|
1589
|
+
"searchSummaryField": {
|
|
1590
|
+
"type": "string"
|
|
1591
|
+
},
|
|
1592
|
+
"queries": {
|
|
1593
|
+
"$ref": "#/definitions/indexedShapeQueriesConfig"
|
|
1594
|
+
},
|
|
1595
|
+
"triggers": {
|
|
1596
|
+
"type": "array",
|
|
1863
1597
|
"items": {
|
|
1864
|
-
"$ref": "#/definitions/
|
|
1598
|
+
"$ref": "#/definitions/indexedShapeTriggersConfig"
|
|
1865
1599
|
}
|
|
1866
|
-
}
|
|
1867
|
-
"additionalProperties": false,
|
|
1868
|
-
"required": ["widget", "items"]
|
|
1600
|
+
}
|
|
1869
1601
|
},
|
|
1870
|
-
"
|
|
1871
|
-
|
|
1872
|
-
|
|
1873
|
-
|
|
1874
|
-
|
|
1875
|
-
|
|
1876
|
-
|
|
1877
|
-
|
|
1878
|
-
|
|
1879
|
-
},
|
|
1880
|
-
"
|
|
1881
|
-
|
|
1602
|
+
"additionalProperties": false,
|
|
1603
|
+
"required": ["queries", "triggers"]
|
|
1604
|
+
},
|
|
1605
|
+
"indexedShapeQueriesConfig": {
|
|
1606
|
+
"title": "Indexed Shape Queries Config",
|
|
1607
|
+
"type": "object",
|
|
1608
|
+
"properties": {
|
|
1609
|
+
"list": {
|
|
1610
|
+
"$ref": "#/definitions/indexedShapeListQueryConfig"
|
|
1611
|
+
},
|
|
1612
|
+
"get": {
|
|
1613
|
+
"$ref": "#/definitions/indexedShapeGetQueryConfig"
|
|
1614
|
+
}
|
|
1882
1615
|
},
|
|
1883
|
-
"
|
|
1884
|
-
|
|
1885
|
-
|
|
1886
|
-
|
|
1887
|
-
|
|
1888
|
-
|
|
1889
|
-
|
|
1890
|
-
|
|
1891
|
-
"params": {
|
|
1892
|
-
"type": "array",
|
|
1893
|
-
"items": {
|
|
1894
|
-
"properties": {
|
|
1895
|
-
"name": {
|
|
1896
|
-
"type": "string"
|
|
1897
|
-
},
|
|
1898
|
-
"value": {
|
|
1899
|
-
"type": "string"
|
|
1900
|
-
}
|
|
1901
|
-
},
|
|
1902
|
-
"required": ["name", "value"],
|
|
1903
|
-
"additionalProperties": false
|
|
1904
|
-
}
|
|
1905
|
-
}
|
|
1616
|
+
"additionalProperties": false
|
|
1617
|
+
},
|
|
1618
|
+
"indexedShapeListQueryConfig": {
|
|
1619
|
+
"title": "Indexed Shape Query All Config",
|
|
1620
|
+
"type": "object",
|
|
1621
|
+
"properties": {
|
|
1622
|
+
"name": {
|
|
1623
|
+
"type": "string"
|
|
1906
1624
|
},
|
|
1907
|
-
"
|
|
1908
|
-
|
|
1909
|
-
|
|
1910
|
-
"bearerAuthentication": {
|
|
1911
|
-
"title": "Bearer Authentication",
|
|
1912
|
-
"type": "object",
|
|
1913
|
-
"properties": {
|
|
1914
|
-
"type": {
|
|
1915
|
-
"type": "string",
|
|
1916
|
-
"enum": ["bearer"]
|
|
1917
|
-
},
|
|
1918
|
-
"token": {
|
|
1919
|
-
"type": "string"
|
|
1920
|
-
},
|
|
1921
|
-
"prefix": {
|
|
1922
|
-
"type": "string"
|
|
1923
|
-
},
|
|
1924
|
-
"header": {
|
|
1625
|
+
"ignoreFields": {
|
|
1626
|
+
"type": "array",
|
|
1627
|
+
"items": {
|
|
1925
1628
|
"type": "string"
|
|
1926
1629
|
}
|
|
1927
1630
|
},
|
|
1928
|
-
"
|
|
1929
|
-
|
|
1930
|
-
},
|
|
1931
|
-
"oauth2BearerAuthentication": {
|
|
1932
|
-
"title": "OAuth 2 Bearer Authentication",
|
|
1933
|
-
"type": "object",
|
|
1934
|
-
"properties": {
|
|
1935
|
-
"type": {
|
|
1936
|
-
"type": "string",
|
|
1937
|
-
"enum": ["oauth2Bearer"]
|
|
1938
|
-
},
|
|
1939
|
-
"token": {
|
|
1940
|
-
"type": "string"
|
|
1941
|
-
},
|
|
1942
|
-
"prefix": {
|
|
1943
|
-
"type": "string"
|
|
1944
|
-
},
|
|
1945
|
-
"header": {
|
|
1946
|
-
"type": "string"
|
|
1947
|
-
},
|
|
1948
|
-
"scope": {
|
|
1949
|
-
"type": "string"
|
|
1950
|
-
},
|
|
1951
|
-
"expiresAt": {
|
|
1952
|
-
"type": "string"
|
|
1953
|
-
}
|
|
1631
|
+
"objectDepthLimit": {
|
|
1632
|
+
"type": "number"
|
|
1954
1633
|
},
|
|
1955
|
-
"
|
|
1956
|
-
|
|
1634
|
+
"pagination": {
|
|
1635
|
+
"$ref": "#/definitions/paginationConfig"
|
|
1636
|
+
}
|
|
1957
1637
|
},
|
|
1958
|
-
"
|
|
1959
|
-
|
|
1960
|
-
|
|
1961
|
-
|
|
1962
|
-
|
|
1963
|
-
|
|
1964
|
-
|
|
1965
|
-
|
|
1966
|
-
"
|
|
1967
|
-
"type": "string"
|
|
1968
|
-
},
|
|
1969
|
-
"password": {
|
|
1970
|
-
"type": "string"
|
|
1971
|
-
},
|
|
1972
|
-
"useIso8859": {
|
|
1973
|
-
"type": "boolean"
|
|
1974
|
-
}
|
|
1638
|
+
"additionalProperties": false,
|
|
1639
|
+
"required": ["name"]
|
|
1640
|
+
},
|
|
1641
|
+
"indexedShapeGetQueryConfig": {
|
|
1642
|
+
"title": "Indexed Shape Query Single Config",
|
|
1643
|
+
"type": "object",
|
|
1644
|
+
"properties": {
|
|
1645
|
+
"name": {
|
|
1646
|
+
"type": "string"
|
|
1975
1647
|
},
|
|
1976
|
-
"
|
|
1977
|
-
|
|
1978
|
-
|
|
1979
|
-
"oauth2Authentication": {
|
|
1980
|
-
"title": "OAuth 2 Authentication",
|
|
1981
|
-
"type": "object",
|
|
1982
|
-
"properties": {
|
|
1983
|
-
"type": {
|
|
1984
|
-
"type": "string",
|
|
1985
|
-
"enum": ["oauth2"]
|
|
1986
|
-
},
|
|
1987
|
-
"grantType": {
|
|
1988
|
-
"type": "string",
|
|
1989
|
-
"enum": ["authorizationCode", "clientCredentials"]
|
|
1990
|
-
},
|
|
1991
|
-
"authorizationUrl": {
|
|
1992
|
-
"type": "string"
|
|
1993
|
-
},
|
|
1994
|
-
"accessTokenUrl": {
|
|
1995
|
-
"type": "string"
|
|
1996
|
-
},
|
|
1997
|
-
"clientId": {
|
|
1998
|
-
"type": "string"
|
|
1999
|
-
},
|
|
2000
|
-
"clientSecret": {
|
|
2001
|
-
"type": "string"
|
|
2002
|
-
},
|
|
2003
|
-
"scope": {
|
|
2004
|
-
"type": "string"
|
|
2005
|
-
},
|
|
2006
|
-
"usePkce": {
|
|
2007
|
-
"type": "boolean"
|
|
2008
|
-
},
|
|
2009
|
-
"redirectUrl": {
|
|
2010
|
-
"type": "string"
|
|
2011
|
-
},
|
|
2012
|
-
"headerPrefix": {
|
|
2013
|
-
"type": "string"
|
|
2014
|
-
},
|
|
2015
|
-
"audience": {
|
|
2016
|
-
"type": "string"
|
|
2017
|
-
},
|
|
2018
|
-
"resource": {
|
|
1648
|
+
"ignoreFields": {
|
|
1649
|
+
"type": "array",
|
|
1650
|
+
"items": {
|
|
2019
1651
|
"type": "string"
|
|
2020
1652
|
}
|
|
2021
1653
|
},
|
|
2022
|
-
"
|
|
2023
|
-
|
|
1654
|
+
"objectDepthLimit": {
|
|
1655
|
+
"type": "number"
|
|
1656
|
+
},
|
|
1657
|
+
"idArg": {
|
|
1658
|
+
"type": "string"
|
|
1659
|
+
}
|
|
2024
1660
|
},
|
|
2025
|
-
"
|
|
2026
|
-
|
|
2027
|
-
|
|
2028
|
-
|
|
2029
|
-
|
|
2030
|
-
|
|
2031
|
-
|
|
2032
|
-
|
|
2033
|
-
"awsAccessKeyId": {
|
|
2034
|
-
"type": "string"
|
|
2035
|
-
},
|
|
2036
|
-
"awsSecretAccessKey": {
|
|
2037
|
-
"type": "string"
|
|
2038
|
-
}
|
|
1661
|
+
"additionalProperties": false,
|
|
1662
|
+
"required": ["name"]
|
|
1663
|
+
},
|
|
1664
|
+
"paginationConfig": {
|
|
1665
|
+
"title": "Pagination Config",
|
|
1666
|
+
"oneOf": [
|
|
1667
|
+
{
|
|
1668
|
+
"$ref": "#/definitions/paginationCursorConfig"
|
|
2039
1669
|
},
|
|
2040
|
-
|
|
2041
|
-
|
|
1670
|
+
{
|
|
1671
|
+
"$ref": "#/definitions/paginationPageConfig"
|
|
1672
|
+
},
|
|
1673
|
+
{
|
|
1674
|
+
"$ref": "#/definitions/paginationOffsetConfig"
|
|
1675
|
+
}
|
|
1676
|
+
]
|
|
1677
|
+
},
|
|
1678
|
+
"paginationCursorConfig": {
|
|
1679
|
+
"title": "Pagination Cursor Config",
|
|
1680
|
+
"type": "object",
|
|
1681
|
+
"properties": {
|
|
1682
|
+
"type": {
|
|
1683
|
+
"type": "string",
|
|
1684
|
+
"enum": ["cursor"]
|
|
1685
|
+
},
|
|
1686
|
+
"cursorArg": {
|
|
1687
|
+
"type": "string"
|
|
1688
|
+
},
|
|
1689
|
+
"cursorPath": {
|
|
1690
|
+
"type": "string"
|
|
1691
|
+
},
|
|
1692
|
+
"pageSize": {
|
|
1693
|
+
"type": "number"
|
|
1694
|
+
},
|
|
1695
|
+
"pageSizeArg": {
|
|
1696
|
+
"type": "string"
|
|
1697
|
+
},
|
|
1698
|
+
"hasMorePath": {
|
|
1699
|
+
"type": "string"
|
|
1700
|
+
},
|
|
1701
|
+
"itemsToIndexPath": {
|
|
1702
|
+
"type": "string"
|
|
1703
|
+
}
|
|
2042
1704
|
},
|
|
2043
|
-
"
|
|
2044
|
-
|
|
2045
|
-
|
|
2046
|
-
|
|
2047
|
-
|
|
2048
|
-
|
|
2049
|
-
|
|
2050
|
-
|
|
2051
|
-
|
|
2052
|
-
|
|
2053
|
-
|
|
2054
|
-
|
|
2055
|
-
|
|
2056
|
-
|
|
2057
|
-
|
|
2058
|
-
|
|
2059
|
-
|
|
2060
|
-
|
|
2061
|
-
|
|
2062
|
-
|
|
2063
|
-
},
|
|
2064
|
-
{
|
|
2065
|
-
"$ref": "#/definitions/customAuthentication"
|
|
2066
|
-
}
|
|
2067
|
-
]
|
|
1705
|
+
"additionalProperties": false,
|
|
1706
|
+
"required": ["type", "cursorArg", "cursorPath", "pageSizeArg", "hasMorePath", "itemsToIndexPath"]
|
|
1707
|
+
},
|
|
1708
|
+
"paginationPageConfig": {
|
|
1709
|
+
"title": "Pagination Page Config",
|
|
1710
|
+
"type": "object",
|
|
1711
|
+
"properties": {
|
|
1712
|
+
"type": {
|
|
1713
|
+
"type": "string",
|
|
1714
|
+
"enum": ["page"]
|
|
1715
|
+
},
|
|
1716
|
+
"pageArg": {
|
|
1717
|
+
"type": "string"
|
|
1718
|
+
},
|
|
1719
|
+
"itemsToIndexPath": {
|
|
1720
|
+
"type": "string"
|
|
1721
|
+
},
|
|
1722
|
+
"pageTotalPath": {
|
|
1723
|
+
"type": "string"
|
|
1724
|
+
}
|
|
2068
1725
|
},
|
|
2069
|
-
"
|
|
2070
|
-
|
|
2071
|
-
|
|
2072
|
-
|
|
2073
|
-
|
|
1726
|
+
"additionalProperties": false,
|
|
1727
|
+
"required": ["type", "pageArg", "itemsToIndexPath", "pageTotalPath"]
|
|
1728
|
+
},
|
|
1729
|
+
"paginationOffsetConfig": {
|
|
1730
|
+
"title": "Pagination Offset Config",
|
|
1731
|
+
"type": "object",
|
|
1732
|
+
"properties": {
|
|
1733
|
+
"type": {
|
|
1734
|
+
"type": "string",
|
|
1735
|
+
"enum": ["offset"]
|
|
1736
|
+
},
|
|
1737
|
+
"offsetArg": {
|
|
1738
|
+
"type": "string"
|
|
1739
|
+
},
|
|
1740
|
+
"itemsToIndexPath": {
|
|
1741
|
+
"type": "string"
|
|
1742
|
+
},
|
|
1743
|
+
"itemTotalPath": {
|
|
1744
|
+
"type": "string"
|
|
1745
|
+
}
|
|
2074
1746
|
},
|
|
2075
|
-
"
|
|
2076
|
-
|
|
2077
|
-
|
|
2078
|
-
|
|
2079
|
-
|
|
2080
|
-
|
|
2081
|
-
|
|
2082
|
-
|
|
2083
|
-
|
|
2084
|
-
|
|
2085
|
-
|
|
2086
|
-
|
|
2087
|
-
|
|
2088
|
-
|
|
2089
|
-
|
|
2090
|
-
|
|
2091
|
-
|
|
2092
|
-
|
|
2093
|
-
|
|
2094
|
-
|
|
2095
|
-
"
|
|
2096
|
-
"$ref": "#/definitions/serviceType"
|
|
2097
|
-
},
|
|
2098
|
-
"authenticationType": {
|
|
2099
|
-
"type": "string",
|
|
2100
|
-
"enum": ["oauth2", "basic", "bearer", "searchParams", "oauth2Bearer", "custom", "aws", "none", "unknown"]
|
|
2101
|
-
},
|
|
2102
|
-
"authentication": {
|
|
2103
|
-
"$ref": "#/definitions/serviceAuthentication"
|
|
2104
|
-
},
|
|
2105
|
-
"webhookId": {
|
|
2106
|
-
"type": "string"
|
|
2107
|
-
},
|
|
2108
|
-
"options": {
|
|
2109
|
-
"type": "object",
|
|
2110
|
-
"description": "Configuration options passed to and handled by the provider."
|
|
2111
|
-
}
|
|
1747
|
+
"additionalProperties": false,
|
|
1748
|
+
"required": ["type", "offsetArg", "itemsToIndexPath", "itemTotalPath"]
|
|
1749
|
+
},
|
|
1750
|
+
"indexedShapeTriggersConfig": {
|
|
1751
|
+
"title": "Indexed Shape Triggers Config",
|
|
1752
|
+
"oneOf": [
|
|
1753
|
+
{
|
|
1754
|
+
"$ref": "#/definitions/indexedShapeScheduleTriggerConfig"
|
|
1755
|
+
},
|
|
1756
|
+
{
|
|
1757
|
+
"$ref": "#/definitions/indexedShapeWebhookTriggerConfig"
|
|
1758
|
+
}
|
|
1759
|
+
]
|
|
1760
|
+
},
|
|
1761
|
+
"indexedShapeScheduleTriggerConfig": {
|
|
1762
|
+
"title": "Indexed Shape Schedule Trigger Config",
|
|
1763
|
+
"type": "object",
|
|
1764
|
+
"properties": {
|
|
1765
|
+
"type": {
|
|
1766
|
+
"type": "string",
|
|
1767
|
+
"enum": ["schedule"]
|
|
2112
1768
|
},
|
|
2113
|
-
"
|
|
2114
|
-
|
|
1769
|
+
"query": {
|
|
1770
|
+
"enum": ["get", "list"]
|
|
1771
|
+
},
|
|
1772
|
+
"interval": {
|
|
1773
|
+
"type": "number"
|
|
1774
|
+
}
|
|
2115
1775
|
},
|
|
2116
|
-
"
|
|
2117
|
-
|
|
2118
|
-
|
|
2119
|
-
|
|
2120
|
-
|
|
2121
|
-
|
|
2122
|
-
|
|
2123
|
-
|
|
2124
|
-
"
|
|
2125
|
-
|
|
2126
|
-
|
|
2127
|
-
|
|
2128
|
-
"
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
|
|
2133
|
-
|
|
2134
|
-
|
|
2135
|
-
|
|
2136
|
-
"serviceType": {
|
|
2137
|
-
"$ref": "#/definitions/serviceType"
|
|
2138
|
-
},
|
|
2139
|
-
"authenticationType": {
|
|
2140
|
-
"type": "string",
|
|
2141
|
-
"enum": ["oauth2", "basic", "bearer", "searchParams", "oauth2Bearer", "custom", "aws", "none", "unknown"]
|
|
2142
|
-
},
|
|
2143
|
-
"authentication": {
|
|
2144
|
-
"type": "string"
|
|
2145
|
-
},
|
|
2146
|
-
"webhookId": {
|
|
1776
|
+
"additionalProperties": false,
|
|
1777
|
+
"required": ["type", "query", "interval"]
|
|
1778
|
+
},
|
|
1779
|
+
"indexedShapeWebhookTriggerConfig": {
|
|
1780
|
+
"title": "Indexed Shape Webhook Trigger Config",
|
|
1781
|
+
"type": "object",
|
|
1782
|
+
"properties": {
|
|
1783
|
+
"type": {
|
|
1784
|
+
"type": "string",
|
|
1785
|
+
"enum": ["webhook"]
|
|
1786
|
+
},
|
|
1787
|
+
"query": {
|
|
1788
|
+
"enum": ["get", "list"]
|
|
1789
|
+
},
|
|
1790
|
+
"service": {
|
|
1791
|
+
"type": "string"
|
|
1792
|
+
},
|
|
1793
|
+
"events": {
|
|
1794
|
+
"type": "array",
|
|
1795
|
+
"items": {
|
|
2147
1796
|
"type": "string"
|
|
2148
|
-
},
|
|
2149
|
-
"options": {
|
|
2150
|
-
"type": "object",
|
|
2151
|
-
"description": "Configuration options passed to and handled by the provider."
|
|
2152
1797
|
}
|
|
2153
|
-
}
|
|
2154
|
-
"required": ["id", "title", "provider", "serviceType", "authenticationType"],
|
|
2155
|
-
"additionalProperties": false
|
|
1798
|
+
}
|
|
2156
1799
|
},
|
|
2157
|
-
"
|
|
2158
|
-
|
|
2159
|
-
|
|
2160
|
-
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
|
|
2164
|
-
|
|
2165
|
-
|
|
2166
|
-
]
|
|
2167
|
-
},
|
|
2168
|
-
"storedServiceMap": {
|
|
2169
|
-
"title": "Stored Service Map",
|
|
2170
|
-
"type": "object",
|
|
2171
|
-
"patternProperties": {
|
|
2172
|
-
"[0-9A-Za-z_-]+": {
|
|
2173
|
-
"$ref": "#/definitions/storedServiceConfig"
|
|
2174
|
-
}
|
|
1800
|
+
"additionalProperties": false,
|
|
1801
|
+
"required": ["type", "query", "service", "events"]
|
|
1802
|
+
},
|
|
1803
|
+
"formScalarConfig": {
|
|
1804
|
+
"title": "Form Scalar Config",
|
|
1805
|
+
"type": "object",
|
|
1806
|
+
"properties": {
|
|
1807
|
+
"widget": {
|
|
1808
|
+
"type": "string"
|
|
2175
1809
|
}
|
|
2176
1810
|
},
|
|
2177
|
-
"
|
|
2178
|
-
|
|
2179
|
-
|
|
2180
|
-
|
|
2181
|
-
|
|
2182
|
-
|
|
2183
|
-
|
|
2184
|
-
|
|
2185
|
-
|
|
2186
|
-
|
|
2187
|
-
|
|
2188
|
-
|
|
2189
|
-
|
|
2190
|
-
"description": "Human-readable id for use in the UI"
|
|
2191
|
-
},
|
|
2192
|
-
"description": {
|
|
2193
|
-
"title": "Description",
|
|
1811
|
+
"additionalProperties": false,
|
|
1812
|
+
"required": ["widget"]
|
|
1813
|
+
},
|
|
1814
|
+
"formObjectConfig": {
|
|
1815
|
+
"title": "Form Object Config",
|
|
1816
|
+
"type": "object",
|
|
1817
|
+
"properties": {
|
|
1818
|
+
"widget": {
|
|
1819
|
+
"type": "string"
|
|
1820
|
+
},
|
|
1821
|
+
"order": {
|
|
1822
|
+
"type": "array",
|
|
1823
|
+
"items": {
|
|
2194
1824
|
"type": "string"
|
|
2195
|
-
},
|
|
2196
|
-
"color": {
|
|
2197
|
-
"title": "Color",
|
|
2198
|
-
"type": "string",
|
|
2199
|
-
"description": "Hex color code"
|
|
2200
|
-
},
|
|
2201
|
-
"live": {
|
|
2202
|
-
"title": "Live",
|
|
2203
|
-
"type": "boolean",
|
|
2204
|
-
"description": "Value to indicate whether items in the state should be returned in list queries"
|
|
2205
|
-
},
|
|
2206
|
-
"key": {
|
|
2207
|
-
"title": "Key",
|
|
2208
|
-
"type": "string",
|
|
2209
|
-
"description": "machine-readable id"
|
|
2210
1825
|
}
|
|
2211
1826
|
},
|
|
2212
|
-
"required": ["name", "title", "color", "live", "key"],
|
|
2213
|
-
"additionalProperties": false
|
|
2214
|
-
},
|
|
2215
|
-
"workflow": {
|
|
2216
|
-
"title": "Workflow",
|
|
2217
|
-
"type": "object",
|
|
2218
1827
|
"properties": {
|
|
2219
|
-
"
|
|
2220
|
-
"
|
|
2221
|
-
|
|
2222
|
-
|
|
2223
|
-
},
|
|
2224
|
-
"title": {
|
|
2225
|
-
"type": "string",
|
|
2226
|
-
"title": "Workflow Name",
|
|
2227
|
-
"minLength": 1,
|
|
2228
|
-
"description": "Human-readable id for use in the UI"
|
|
2229
|
-
},
|
|
2230
|
-
"steps": {
|
|
2231
|
-
"type": "array",
|
|
2232
|
-
"title": "Steps",
|
|
2233
|
-
"items": {
|
|
2234
|
-
"$ref": "#/definitions/workflowStep"
|
|
2235
|
-
},
|
|
2236
|
-
"minItems": 1
|
|
1828
|
+
"patternProperties": {
|
|
1829
|
+
"[0-9A-Za-z_-]+": {
|
|
1830
|
+
"$ref": "#/definitions/formConfig"
|
|
1831
|
+
}
|
|
2237
1832
|
}
|
|
2238
|
-
}
|
|
2239
|
-
"required": ["name", "title", "steps"]
|
|
1833
|
+
}
|
|
2240
1834
|
},
|
|
2241
|
-
"
|
|
2242
|
-
|
|
2243
|
-
|
|
2244
|
-
|
|
2245
|
-
|
|
1835
|
+
"additionalProperties": false
|
|
1836
|
+
},
|
|
1837
|
+
"formArrayConfig": {
|
|
1838
|
+
"title": "Form Array Config",
|
|
1839
|
+
"type": "object",
|
|
1840
|
+
"properties": {
|
|
1841
|
+
"widget": {
|
|
1842
|
+
"type": "string"
|
|
1843
|
+
},
|
|
1844
|
+
"items": {
|
|
1845
|
+
"$ref": "#/definitions/formConfig"
|
|
2246
1846
|
}
|
|
2247
1847
|
},
|
|
2248
|
-
"
|
|
2249
|
-
|
|
2250
|
-
|
|
1848
|
+
"additionalProperties": false,
|
|
1849
|
+
"required": ["widget", "items"]
|
|
1850
|
+
},
|
|
1851
|
+
"customAuthentication": {
|
|
1852
|
+
"title": "Custom Authentication",
|
|
1853
|
+
"description": "For use with a custom auth handler on a service provider.",
|
|
1854
|
+
"type": "object",
|
|
1855
|
+
"properties": {
|
|
1856
|
+
"type": {
|
|
1857
|
+
"type": "string",
|
|
1858
|
+
"enum": ["custom"]
|
|
1859
|
+
}
|
|
2251
1860
|
},
|
|
2252
|
-
"
|
|
2253
|
-
|
|
2254
|
-
|
|
2255
|
-
|
|
2256
|
-
|
|
2257
|
-
|
|
2258
|
-
|
|
1861
|
+
"additionalProperties": true,
|
|
1862
|
+
"required": ["type"]
|
|
1863
|
+
},
|
|
1864
|
+
"searchParamsAuthentication": {
|
|
1865
|
+
"title": "Search Params Authentication",
|
|
1866
|
+
"type": "object",
|
|
1867
|
+
"properties": {
|
|
1868
|
+
"type": {
|
|
1869
|
+
"type": "string",
|
|
1870
|
+
"enum": ["searchParams"]
|
|
2259
1871
|
},
|
|
2260
|
-
"
|
|
2261
|
-
"
|
|
2262
|
-
|
|
1872
|
+
"params": {
|
|
1873
|
+
"type": "array",
|
|
1874
|
+
"items": {
|
|
1875
|
+
"properties": {
|
|
1876
|
+
"name": {
|
|
1877
|
+
"type": "string"
|
|
1878
|
+
},
|
|
1879
|
+
"value": {
|
|
1880
|
+
"type": "string"
|
|
1881
|
+
}
|
|
1882
|
+
},
|
|
1883
|
+
"required": ["name", "value"],
|
|
1884
|
+
"additionalProperties": false
|
|
2263
1885
|
}
|
|
2264
|
-
}
|
|
2265
|
-
"required": ["default"]
|
|
2266
|
-
}
|
|
2267
|
-
},
|
|
2268
|
-
"properties": {
|
|
2269
|
-
"$schema": {
|
|
2270
|
-
"type": "string"
|
|
2271
|
-
},
|
|
2272
|
-
"version": {
|
|
2273
|
-
"type": "number",
|
|
2274
|
-
"description": "This is the revision number of your schema. Every time your project schema is updated, this value should be incremented."
|
|
1886
|
+
}
|
|
2275
1887
|
},
|
|
2276
|
-
"
|
|
2277
|
-
|
|
2278
|
-
|
|
1888
|
+
"additionalProperties": false,
|
|
1889
|
+
"required": ["type", "params"]
|
|
1890
|
+
},
|
|
1891
|
+
"bearerAuthentication": {
|
|
1892
|
+
"title": "Bearer Authentication",
|
|
1893
|
+
"type": "object",
|
|
1894
|
+
"properties": {
|
|
1895
|
+
"type": {
|
|
1896
|
+
"type": "string",
|
|
1897
|
+
"enum": ["bearer"]
|
|
1898
|
+
},
|
|
1899
|
+
"token": {
|
|
1900
|
+
"type": "string"
|
|
1901
|
+
},
|
|
1902
|
+
"prefix": {
|
|
1903
|
+
"type": "string"
|
|
1904
|
+
},
|
|
1905
|
+
"header": {
|
|
1906
|
+
"type": "string"
|
|
1907
|
+
}
|
|
2279
1908
|
},
|
|
2280
|
-
"
|
|
2281
|
-
|
|
2282
|
-
|
|
2283
|
-
|
|
1909
|
+
"additionalProperties": false,
|
|
1910
|
+
"required": ["type", "token"]
|
|
1911
|
+
},
|
|
1912
|
+
"oauth2BearerAuthentication": {
|
|
1913
|
+
"title": "OAuth 2 Bearer Authentication",
|
|
1914
|
+
"type": "object",
|
|
1915
|
+
"properties": {
|
|
1916
|
+
"type": {
|
|
1917
|
+
"type": "string",
|
|
1918
|
+
"enum": ["oauth2Bearer"]
|
|
1919
|
+
},
|
|
1920
|
+
"token": {
|
|
1921
|
+
"type": "string"
|
|
1922
|
+
},
|
|
1923
|
+
"prefix": {
|
|
1924
|
+
"type": "string"
|
|
1925
|
+
},
|
|
1926
|
+
"header": {
|
|
1927
|
+
"type": "string"
|
|
1928
|
+
},
|
|
1929
|
+
"scope": {
|
|
1930
|
+
"type": "string"
|
|
1931
|
+
},
|
|
1932
|
+
"expiresAt": {
|
|
1933
|
+
"type": "string"
|
|
1934
|
+
}
|
|
2284
1935
|
},
|
|
2285
|
-
"
|
|
2286
|
-
|
|
2287
|
-
|
|
1936
|
+
"additionalProperties": false,
|
|
1937
|
+
"required": ["type", "token"]
|
|
1938
|
+
},
|
|
1939
|
+
"basicAuthentication": {
|
|
1940
|
+
"title": "Basic Authentication",
|
|
1941
|
+
"type": "object",
|
|
1942
|
+
"properties": {
|
|
1943
|
+
"type": {
|
|
1944
|
+
"type": "string",
|
|
1945
|
+
"enum": ["basic"]
|
|
1946
|
+
},
|
|
1947
|
+
"username": {
|
|
1948
|
+
"type": "string"
|
|
1949
|
+
},
|
|
1950
|
+
"password": {
|
|
1951
|
+
"type": "string"
|
|
1952
|
+
},
|
|
1953
|
+
"useIso8859": {
|
|
1954
|
+
"type": "boolean"
|
|
1955
|
+
}
|
|
2288
1956
|
},
|
|
2289
|
-
"
|
|
2290
|
-
|
|
2291
|
-
|
|
1957
|
+
"additionalProperties": false,
|
|
1958
|
+
"required": ["type", "username", "password"]
|
|
1959
|
+
},
|
|
1960
|
+
"oauth2Authentication": {
|
|
1961
|
+
"title": "OAuth 2 Authentication",
|
|
1962
|
+
"type": "object",
|
|
1963
|
+
"properties": {
|
|
1964
|
+
"type": {
|
|
1965
|
+
"type": "string",
|
|
1966
|
+
"enum": ["oauth2"]
|
|
1967
|
+
},
|
|
1968
|
+
"grantType": {
|
|
1969
|
+
"type": "string",
|
|
1970
|
+
"enum": ["authorizationCode", "clientCredentials"]
|
|
1971
|
+
},
|
|
1972
|
+
"authorizationUrl": {
|
|
1973
|
+
"type": "string"
|
|
1974
|
+
},
|
|
1975
|
+
"accessTokenUrl": {
|
|
1976
|
+
"type": "string"
|
|
1977
|
+
},
|
|
1978
|
+
"clientId": {
|
|
1979
|
+
"type": "string"
|
|
1980
|
+
},
|
|
1981
|
+
"clientSecret": {
|
|
1982
|
+
"type": "string"
|
|
1983
|
+
},
|
|
1984
|
+
"scope": {
|
|
1985
|
+
"type": "string"
|
|
1986
|
+
},
|
|
1987
|
+
"usePkce": {
|
|
1988
|
+
"type": "boolean"
|
|
1989
|
+
},
|
|
1990
|
+
"redirectUrl": {
|
|
1991
|
+
"type": "string"
|
|
1992
|
+
},
|
|
1993
|
+
"headerPrefix": {
|
|
1994
|
+
"type": "string"
|
|
1995
|
+
},
|
|
1996
|
+
"audience": {
|
|
1997
|
+
"type": "string"
|
|
1998
|
+
},
|
|
1999
|
+
"resource": {
|
|
2000
|
+
"type": "string"
|
|
2001
|
+
}
|
|
2292
2002
|
},
|
|
2293
|
-
"
|
|
2294
|
-
|
|
2295
|
-
|
|
2296
|
-
|
|
2003
|
+
"additionalProperties": false,
|
|
2004
|
+
"required": ["type", "grantType", "clientId"]
|
|
2005
|
+
},
|
|
2006
|
+
"awsAuthentication": {
|
|
2007
|
+
"title": "AWS Authentication",
|
|
2008
|
+
"type": "object",
|
|
2009
|
+
"properties": {
|
|
2010
|
+
"type": {
|
|
2011
|
+
"type": "string",
|
|
2012
|
+
"enum": ["aws"]
|
|
2013
|
+
},
|
|
2014
|
+
"awsAccessKeyId": {
|
|
2015
|
+
"type": "string"
|
|
2016
|
+
},
|
|
2017
|
+
"awsSecretAccessKey": {
|
|
2018
|
+
"type": "string"
|
|
2019
|
+
}
|
|
2297
2020
|
},
|
|
2298
|
-
"
|
|
2299
|
-
|
|
2300
|
-
|
|
2301
|
-
|
|
2021
|
+
"additionalProperties": false,
|
|
2022
|
+
"required": ["type", "awsAccessKeyId", "awsSecretAccessKey"]
|
|
2023
|
+
},
|
|
2024
|
+
"serviceAuthentication": {
|
|
2025
|
+
"title": "Service Authentication",
|
|
2026
|
+
"oneOf": [
|
|
2027
|
+
{
|
|
2028
|
+
"$ref": "#/definitions/oauth2Authentication"
|
|
2029
|
+
},
|
|
2030
|
+
{
|
|
2031
|
+
"$ref": "#/definitions/oauth2BearerAuthentication"
|
|
2032
|
+
},
|
|
2033
|
+
{
|
|
2034
|
+
"$ref": "#/definitions/bearerAuthentication"
|
|
2035
|
+
},
|
|
2036
|
+
{
|
|
2037
|
+
"$ref": "#/definitions/basicAuthentication"
|
|
2038
|
+
},
|
|
2039
|
+
{
|
|
2040
|
+
"$ref": "#/definitions/searchParamsAuthentication"
|
|
2041
|
+
},
|
|
2042
|
+
{
|
|
2043
|
+
"$ref": "#/definitions/awsAuthentication"
|
|
2044
|
+
},
|
|
2045
|
+
{
|
|
2046
|
+
"$ref": "#/definitions/customAuthentication"
|
|
2047
|
+
}
|
|
2048
|
+
]
|
|
2049
|
+
},
|
|
2050
|
+
"serviceType": {
|
|
2051
|
+
"title": "Service Type",
|
|
2052
|
+
"description": "The general type of this service, specifying how and where it will be utilized.",
|
|
2053
|
+
"type": "string",
|
|
2054
|
+
"enum": ["deployment", "authentication", "takeshape", "rest", "graphql", "openapi", "aws", "unknown"]
|
|
2055
|
+
},
|
|
2056
|
+
"serviceConfig": {
|
|
2057
|
+
"title": "Service Config",
|
|
2058
|
+
"type": "object",
|
|
2059
|
+
"properties": {
|
|
2060
|
+
"id": {
|
|
2061
|
+
"type": "string",
|
|
2062
|
+
"description": "Machine-readable identifier, should typically be the same as the property name on the services object."
|
|
2063
|
+
},
|
|
2064
|
+
"title": {
|
|
2065
|
+
"type": "string",
|
|
2066
|
+
"description": "Human-readable name for this service."
|
|
2067
|
+
},
|
|
2068
|
+
"provider": {
|
|
2069
|
+
"description": "The service provider id.",
|
|
2070
|
+
"type": "string"
|
|
2071
|
+
},
|
|
2072
|
+
"namespace": {
|
|
2073
|
+
"type": "string",
|
|
2074
|
+
"description": "A namespace to use for the imported types tied to this service."
|
|
2075
|
+
},
|
|
2076
|
+
"serviceType": {
|
|
2077
|
+
"$ref": "#/definitions/serviceType"
|
|
2078
|
+
},
|
|
2079
|
+
"authenticationType": {
|
|
2080
|
+
"type": "string",
|
|
2081
|
+
"enum": ["oauth2", "basic", "bearer", "searchParams", "oauth2Bearer", "custom", "aws", "none", "unknown"]
|
|
2082
|
+
},
|
|
2083
|
+
"authentication": {
|
|
2084
|
+
"$ref": "#/definitions/serviceAuthentication"
|
|
2085
|
+
},
|
|
2086
|
+
"webhookId": {
|
|
2087
|
+
"type": "string"
|
|
2088
|
+
},
|
|
2089
|
+
"options": {
|
|
2090
|
+
"type": "object",
|
|
2091
|
+
"description": "Configuration options passed to and handled by the provider."
|
|
2092
|
+
}
|
|
2302
2093
|
},
|
|
2303
|
-
"
|
|
2304
|
-
|
|
2094
|
+
"required": ["id", "title", "provider", "serviceType", "authenticationType"],
|
|
2095
|
+
"additionalProperties": false
|
|
2096
|
+
},
|
|
2097
|
+
"storedServiceConfig": {
|
|
2098
|
+
"title": "Stored Service Config",
|
|
2099
|
+
"type": "object",
|
|
2100
|
+
"properties": {
|
|
2101
|
+
"id": {
|
|
2102
|
+
"type": "string",
|
|
2103
|
+
"description": "Machine-readable identifier, should typically be the same as the property name on the services object."
|
|
2104
|
+
},
|
|
2105
|
+
"title": {
|
|
2106
|
+
"type": "string",
|
|
2107
|
+
"description": "Human-readable name for this service."
|
|
2108
|
+
},
|
|
2109
|
+
"provider": {
|
|
2110
|
+
"type": "string",
|
|
2111
|
+
"description": "The service provider id."
|
|
2112
|
+
},
|
|
2113
|
+
"namespace": {
|
|
2114
|
+
"type": "string",
|
|
2115
|
+
"description": "A namespace to use for the imported types tied to this service."
|
|
2116
|
+
},
|
|
2117
|
+
"serviceType": {
|
|
2118
|
+
"$ref": "#/definitions/serviceType"
|
|
2119
|
+
},
|
|
2120
|
+
"authenticationType": {
|
|
2121
|
+
"type": "string",
|
|
2122
|
+
"enum": ["oauth2", "basic", "bearer", "searchParams", "oauth2Bearer", "custom", "aws", "none", "unknown"]
|
|
2123
|
+
},
|
|
2124
|
+
"authentication": {
|
|
2125
|
+
"type": "string"
|
|
2126
|
+
},
|
|
2127
|
+
"webhookId": {
|
|
2128
|
+
"type": "string"
|
|
2129
|
+
},
|
|
2130
|
+
"options": {
|
|
2131
|
+
"type": "object",
|
|
2132
|
+
"description": "Configuration options passed to and handled by the provider."
|
|
2133
|
+
}
|
|
2305
2134
|
},
|
|
2306
|
-
"
|
|
2307
|
-
|
|
2308
|
-
|
|
2309
|
-
|
|
2310
|
-
|
|
2135
|
+
"required": ["id", "title", "provider", "serviceType", "authenticationType"],
|
|
2136
|
+
"additionalProperties": false
|
|
2137
|
+
},
|
|
2138
|
+
"anyServiceConfig": {
|
|
2139
|
+
"title": "Any Service Config",
|
|
2140
|
+
"oneOf": [
|
|
2141
|
+
{
|
|
2142
|
+
"$ref": "#/definitions/storedServiceConfig"
|
|
2143
|
+
},
|
|
2144
|
+
{
|
|
2145
|
+
"$ref": "#/definitions/serviceConfig"
|
|
2146
|
+
}
|
|
2147
|
+
]
|
|
2148
|
+
},
|
|
2149
|
+
"storedServiceMap": {
|
|
2150
|
+
"title": "Stored Service Map",
|
|
2151
|
+
"type": "object",
|
|
2152
|
+
"patternProperties": {
|
|
2153
|
+
"[0-9A-Za-z_-]+": {
|
|
2154
|
+
"$ref": "#/definitions/storedServiceConfig"
|
|
2155
|
+
}
|
|
2156
|
+
}
|
|
2157
|
+
},
|
|
2158
|
+
"workflowStep": {
|
|
2159
|
+
"title": "Workflow Step",
|
|
2160
|
+
"type": "object",
|
|
2161
|
+
"properties": {
|
|
2162
|
+
"name": {
|
|
2163
|
+
"type": "string",
|
|
2164
|
+
"title": "Name",
|
|
2165
|
+
"pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$",
|
|
2166
|
+
"description": "machine-readable slug"
|
|
2167
|
+
},
|
|
2168
|
+
"title": {
|
|
2169
|
+
"title": "Title",
|
|
2170
|
+
"type": "string",
|
|
2171
|
+
"description": "Human-readable id for use in the UI"
|
|
2172
|
+
},
|
|
2173
|
+
"description": {
|
|
2174
|
+
"title": "Description",
|
|
2175
|
+
"type": "string"
|
|
2176
|
+
},
|
|
2177
|
+
"color": {
|
|
2178
|
+
"title": "Color",
|
|
2179
|
+
"type": "string",
|
|
2180
|
+
"description": "Hex color code"
|
|
2181
|
+
},
|
|
2182
|
+
"live": {
|
|
2183
|
+
"title": "Live",
|
|
2184
|
+
"type": "boolean",
|
|
2185
|
+
"description": "Value to indicate whether items in the state should be returned in list queries"
|
|
2186
|
+
},
|
|
2187
|
+
"key": {
|
|
2188
|
+
"title": "Key",
|
|
2189
|
+
"type": "string",
|
|
2190
|
+
"description": "machine-readable id"
|
|
2191
|
+
}
|
|
2311
2192
|
},
|
|
2312
|
-
"
|
|
2313
|
-
|
|
2314
|
-
|
|
2315
|
-
|
|
2193
|
+
"required": ["name", "title", "color", "live", "key"],
|
|
2194
|
+
"additionalProperties": false
|
|
2195
|
+
},
|
|
2196
|
+
"workflow": {
|
|
2197
|
+
"title": "Workflow",
|
|
2198
|
+
"type": "object",
|
|
2199
|
+
"properties": {
|
|
2200
|
+
"name": {
|
|
2316
2201
|
"type": "string",
|
|
2202
|
+
"pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$",
|
|
2203
|
+
"description": "machine-readable id"
|
|
2204
|
+
},
|
|
2205
|
+
"title": {
|
|
2206
|
+
"type": "string",
|
|
2207
|
+
"title": "Workflow Name",
|
|
2317
2208
|
"minLength": 1,
|
|
2318
|
-
"
|
|
2209
|
+
"description": "Human-readable id for use in the UI"
|
|
2210
|
+
},
|
|
2211
|
+
"steps": {
|
|
2212
|
+
"type": "array",
|
|
2213
|
+
"title": "Steps",
|
|
2214
|
+
"items": {
|
|
2215
|
+
"$ref": "#/definitions/workflowStep"
|
|
2216
|
+
},
|
|
2217
|
+
"minItems": 1
|
|
2319
2218
|
}
|
|
2320
2219
|
},
|
|
2321
|
-
"
|
|
2322
|
-
|
|
2323
|
-
|
|
2324
|
-
|
|
2325
|
-
"
|
|
2326
|
-
|
|
2327
|
-
"
|
|
2328
|
-
}
|
|
2329
|
-
|
|
2330
|
-
|
|
2331
|
-
|
|
2332
|
-
|
|
2333
|
-
|
|
2334
|
-
|
|
2335
|
-
|
|
2336
|
-
|
|
2337
|
-
"
|
|
2338
|
-
"
|
|
2339
|
-
|
|
2340
|
-
|
|
2341
|
-
"workflows": {
|
|
2342
|
-
"$ref": "#/definitions/workflowMap",
|
|
2343
|
-
"description": "Workflows describe the status of a shape item. Every schema starts with a default workflow with two steps, Disabled and Enabled"
|
|
2220
|
+
"required": ["name", "title", "steps"]
|
|
2221
|
+
},
|
|
2222
|
+
"workflowMap": {
|
|
2223
|
+
"title": "Workflow Map",
|
|
2224
|
+
"type": "object",
|
|
2225
|
+
"patternProperties": {
|
|
2226
|
+
"[0-9A-Za-z_-]+": {"$ref": "#/definitions/workflow"}
|
|
2227
|
+
}
|
|
2228
|
+
},
|
|
2229
|
+
"formConfig": {
|
|
2230
|
+
"title": "Form Config",
|
|
2231
|
+
"type": "object"
|
|
2232
|
+
},
|
|
2233
|
+
"formsConfig": {
|
|
2234
|
+
"title": "Forms Config",
|
|
2235
|
+
"type": "object",
|
|
2236
|
+
"properties": {
|
|
2237
|
+
"default": {
|
|
2238
|
+
"$ref": "#/definitions/formConfig"
|
|
2239
|
+
}
|
|
2344
2240
|
},
|
|
2345
|
-
"
|
|
2346
|
-
"
|
|
2241
|
+
"patternProperties": {
|
|
2242
|
+
"[0-9A-Za-z_-]+": {
|
|
2243
|
+
"$ref": "#/definitions/formConfig"
|
|
2244
|
+
}
|
|
2347
2245
|
},
|
|
2348
|
-
"
|
|
2349
|
-
|
|
2350
|
-
|
|
2246
|
+
"required": ["default"]
|
|
2247
|
+
}
|
|
2248
|
+
},
|
|
2249
|
+
"properties": {
|
|
2250
|
+
"$schema": {
|
|
2251
|
+
"type": "string"
|
|
2252
|
+
},
|
|
2253
|
+
"version": {
|
|
2254
|
+
"type": "number",
|
|
2255
|
+
"description": "This is the revision number of your schema. Every time your project schema is updated, this value should be incremented."
|
|
2256
|
+
},
|
|
2257
|
+
"apiVersion": {
|
|
2258
|
+
"type": "string",
|
|
2259
|
+
"description": "The version of the TakeShape API your project is using. We increase the version as we make breaking changes to the API endpoints."
|
|
2260
|
+
},
|
|
2261
|
+
"schemaVersion": {
|
|
2262
|
+
"type": "string",
|
|
2263
|
+
"enum": ["3.18.0"],
|
|
2264
|
+
"description": "The version of the schema format your project is using. We increase the version as we make breaking changes to the schema format."
|
|
2265
|
+
},
|
|
2266
|
+
"projectId": {
|
|
2267
|
+
"type": "string",
|
|
2268
|
+
"description": "The ID of the TakeShape project this schema belongs to."
|
|
2269
|
+
},
|
|
2270
|
+
"author": {
|
|
2271
|
+
"type": "string",
|
|
2272
|
+
"description": "The ID of the TakeShape user who created the schema."
|
|
2273
|
+
},
|
|
2274
|
+
"created": {
|
|
2275
|
+
"type": "string",
|
|
2276
|
+
"format": "date-time",
|
|
2277
|
+
"description": "The date the schema was created"
|
|
2278
|
+
},
|
|
2279
|
+
"updated": {
|
|
2280
|
+
"type": "string",
|
|
2281
|
+
"format": "date-time",
|
|
2282
|
+
"description": "The date the schema was last updated"
|
|
2283
|
+
},
|
|
2284
|
+
"deactivated": {
|
|
2285
|
+
"type": "number"
|
|
2286
|
+
},
|
|
2287
|
+
"defaultLocale": {
|
|
2288
|
+
"type": "string",
|
|
2289
|
+
"minLength": 1,
|
|
2290
|
+
"pattern": "^[a-zA-Z]{2,3}(-[a-zA-Z]{2,3})?$",
|
|
2291
|
+
"description": "The locale that should be preferred when creating new Shape items. This must be an entry in the locales array."
|
|
2292
|
+
},
|
|
2293
|
+
"locales": {
|
|
2294
|
+
"type": "array",
|
|
2295
|
+
"minItems": 1,
|
|
2296
|
+
"items": {
|
|
2297
|
+
"type": "string",
|
|
2298
|
+
"minLength": 1,
|
|
2299
|
+
"pattern": "^[a-zA-Z]{2,3}(-[a-zA-Z]{2,3})?$"
|
|
2351
2300
|
}
|
|
2352
2301
|
},
|
|
2353
|
-
"
|
|
2354
|
-
|
|
2355
|
-
"
|
|
2356
|
-
|
|
2357
|
-
|
|
2358
|
-
"
|
|
2359
|
-
"
|
|
2360
|
-
|
|
2361
|
-
|
|
2362
|
-
"
|
|
2363
|
-
"
|
|
2364
|
-
|
|
2365
|
-
|
|
2366
|
-
"
|
|
2367
|
-
"
|
|
2368
|
-
|
|
2369
|
-
|
|
2370
|
-
|
|
2302
|
+
"queries": {
|
|
2303
|
+
"$ref": "#/definitions/queryMap",
|
|
2304
|
+
"description": "Queries map directly to queries your project's GraphQL API"
|
|
2305
|
+
},
|
|
2306
|
+
"mutations": {
|
|
2307
|
+
"$ref": "#/definitions/queryMap",
|
|
2308
|
+
"description": "Mutations map directly to mutations your project's GraphQL API"
|
|
2309
|
+
},
|
|
2310
|
+
"shapes": {
|
|
2311
|
+
"$ref": "#/definitions/shapeMap",
|
|
2312
|
+
"description": "A Shape is a schema object for structuring and storing data from one or more sources, including the TakeShape data store and connected services."
|
|
2313
|
+
},
|
|
2314
|
+
"indexedShapes": {
|
|
2315
|
+
"$ref": "#/definitions/indexedShapeMap",
|
|
2316
|
+
"description": "Experimental shape indexing configuration if you are curious about learning more message @asprouse in the TakeShape Slack"
|
|
2317
|
+
},
|
|
2318
|
+
"forms": {
|
|
2319
|
+
"$ref": "#/definitions/formMap",
|
|
2320
|
+
"description": "Forms define a visual interface for editing Shapes in the TakeShape UI."
|
|
2321
|
+
},
|
|
2322
|
+
"workflows": {
|
|
2323
|
+
"$ref": "#/definitions/workflowMap",
|
|
2324
|
+
"description": "Workflows describe the status of a shape item. Every schema starts with a default workflow with two steps, Disabled and Enabled"
|
|
2325
|
+
},
|
|
2326
|
+
"dataKey": {
|
|
2327
|
+
"type": "string"
|
|
2328
|
+
},
|
|
2329
|
+
"services": {
|
|
2330
|
+
"$ref": "#/definitions/storedServiceMap",
|
|
2331
|
+
"description": "By connecting new Services to your project schema, you can add shapes, queries, and mutations from 3rd party sources to your API in TakeShape. This allows you to mesh together exactly the API you need to interact with all of the services your app or business depends upon. Services use an encrypted configuration to keep auth tokens secret. For this reason, services can only be added to a schema through the web client or through the Admin API."
|
|
2332
|
+
}
|
|
2333
|
+
},
|
|
2334
|
+
"additionalProperties": false,
|
|
2335
|
+
"required": [
|
|
2336
|
+
"projectId",
|
|
2337
|
+
"created",
|
|
2338
|
+
"updated",
|
|
2339
|
+
"apiVersion",
|
|
2340
|
+
"schemaVersion",
|
|
2341
|
+
"version",
|
|
2342
|
+
"defaultLocale",
|
|
2343
|
+
"locales",
|
|
2344
|
+
"shapes",
|
|
2345
|
+
"queries",
|
|
2346
|
+
"mutations",
|
|
2347
|
+
"workflows",
|
|
2348
|
+
"dataKey"
|
|
2349
|
+
]
|
|
2350
|
+
}
|