@takeshape/schema 11.9.4 → 11.12.1

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.
Files changed (84) hide show
  1. package/dist/migration/index.d.ts +1 -0
  2. package/dist/migration/index.d.ts.map +1 -1
  3. package/dist/migration/index.js +3 -1
  4. package/dist/migration/to/v3.47.0.d.ts +5 -0
  5. package/dist/migration/to/v3.47.0.d.ts.map +1 -0
  6. package/dist/migration/to/v3.47.0.js +16 -0
  7. package/dist/project-schema/index.d.ts +4 -1
  8. package/dist/project-schema/index.d.ts.map +1 -1
  9. package/dist/project-schema/index.js +17 -3
  10. package/dist/project-schema/latest.d.ts +36 -3
  11. package/dist/project-schema/latest.d.ts.map +1 -1
  12. package/dist/project-schema/migrate.d.ts.map +1 -1
  13. package/dist/project-schema/migrate.js +3 -0
  14. package/dist/project-schema/v3.47.0.d.ts +1737 -0
  15. package/dist/project-schema/v3.47.0.d.ts.map +1 -0
  16. package/dist/project-schema/v3.47.0.js +5 -0
  17. package/dist/schemas/index.d.ts +2 -2
  18. package/dist/schemas/index.d.ts.map +1 -1
  19. package/dist/schemas/index.js +5 -4
  20. package/dist/schemas/index.ts +4 -2
  21. package/dist/schemas/project-schema/latest.json +62 -3
  22. package/dist/schemas/project-schema/v3.47.0.json +3626 -0
  23. package/dist/schemas/project-schema.json +3 -0
  24. package/es/migration/index.js +3 -1
  25. package/es/migration/to/v3.47.0.js +10 -0
  26. package/es/project-schema/index.js +3 -1
  27. package/es/project-schema/migrate.js +4 -1
  28. package/es/project-schema/v3.47.0.js +1 -0
  29. package/es/schemas/index.js +4 -3
  30. package/es/schemas/index.ts +4 -2
  31. package/es/schemas/project-schema/latest.json +62 -3
  32. package/es/schemas/project-schema/v3.47.0.json +3626 -0
  33. package/es/schemas/project-schema.json +3 -0
  34. package/examples/latest/all-fields-shapes-inline.json +1 -1
  35. package/examples/latest/all-fields-shapes.json +1 -1
  36. package/examples/latest/betzino.json +1 -1
  37. package/examples/latest/blog-schema.json +1 -1
  38. package/examples/latest/brewery-schema.json +1 -1
  39. package/examples/latest/clear-cache-schema.json +1 -1
  40. package/examples/latest/complex-project-schema.json +1 -1
  41. package/examples/latest/complex-schema.json +1 -1
  42. package/examples/latest/edit-schema.json +1 -1
  43. package/examples/latest/fabric-ecommerce.json +1 -1
  44. package/examples/latest/frank-and-fred-schema.json +1 -1
  45. package/examples/latest/klirr-schema.json +1 -1
  46. package/examples/latest/layers/rick-and-morty-layer.json +1 -1
  47. package/examples/latest/layers/shopify-layer-2023-01.json +1 -1
  48. package/examples/latest/layers/shopify-storefront-2023-04.json +1 -1
  49. package/examples/latest/layers/wordpress-2024-01.json +1 -1
  50. package/examples/latest/massive-schema.json +1 -1
  51. package/examples/latest/mill-components-schema.json +1 -1
  52. package/examples/latest/nested-shape-arrays.json +1 -1
  53. package/examples/latest/one-earth.json +1 -1
  54. package/examples/latest/pet-oneof-array.json +1 -1
  55. package/examples/latest/post-schema.json +1 -1
  56. package/examples/latest/pruned-shopify-product-schema.json +1 -1
  57. package/examples/latest/rag-example.json +2 -2
  58. package/examples/latest/real-world-schema.json +1 -1
  59. package/examples/latest/recursive-repeater-schema.json +1 -1
  60. package/examples/latest/recursive-schema.json +1 -1
  61. package/examples/latest/rick-and-morty-ast.json +1 -1
  62. package/examples/latest/rick-and-morty-graphql.json +1 -1
  63. package/examples/latest/rick-and-morty-rest.json +1 -1
  64. package/examples/latest/rick-and-morty-with-indexing.json +1 -1
  65. package/examples/latest/schema-where-filter.json +1 -1
  66. package/examples/latest/schema-with-repeater-draftjs.json +1 -1
  67. package/examples/latest/schema-with-rick-and-morty.json +1 -1
  68. package/examples/latest/shape-books-v3_2_0.json +1 -1
  69. package/examples/latest/shape-books.json +1 -1
  70. package/examples/latest/shape-editor-schema-edited.json +1 -1
  71. package/examples/latest/shape-editor-schema-initial.json +1 -1
  72. package/examples/latest/shapedb-crud-every-prop-type.json +1 -1
  73. package/examples/latest/shopify-lookbook.json +1 -1
  74. package/examples/latest/shopify-product-2022-07.json +1 -1
  75. package/examples/latest/shopify-product-2023-04.json +1 -1
  76. package/examples/latest/shopify-store-with-widget.json +1 -1
  77. package/examples/latest/stripe-product-runtime-schema.json +1 -1
  78. package/examples/latest/stripe-starter-resolved.json +1 -1
  79. package/examples/latest/user-schema-no-required.json +1 -1
  80. package/examples/latest/user-schema-with-defaults.json +1 -1
  81. package/examples/latest/valvoline-ai-demo.json +1 -1
  82. package/examples/latest/vector-search-schema.json +1 -1
  83. package/examples/source/rag-example.json +86 -23
  84. package/package.json +5 -5
@@ -0,0 +1,3626 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "$id": "https://schema.takeshape.io/project-schema/v3.47.0#",
4
+ "title": "Project Schema JSON",
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
27
+ }
28
+ ]
29
+ },
30
+ "simpleTypes": {
31
+ "title": "Simple Types",
32
+ "enum": [
33
+ "array",
34
+ "boolean",
35
+ "integer",
36
+ "null",
37
+ "number",
38
+ "object",
39
+ "string"
40
+ ]
41
+ },
42
+ "stringArray": {
43
+ "title": "String Array",
44
+ "type": "array",
45
+ "items": {
46
+ "type": "string"
47
+ },
48
+ "uniqueItems": true,
49
+ "default": []
50
+ },
51
+ "backreference": {
52
+ "title": "Back Reference",
53
+ "description": "A configuration object for a reverse reference in a relationship.",
54
+ "type": "object",
55
+ "properties": {
56
+ "enabled": {
57
+ "type": "boolean"
58
+ },
59
+ "name": {
60
+ "type": "string",
61
+ "pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$"
62
+ }
63
+ },
64
+ "additionalProperties": false,
65
+ "required": [
66
+ "enabled"
67
+ ]
68
+ },
69
+ "mappingString": {
70
+ "title": "Mapping String",
71
+ "type": "string",
72
+ "pattern": "^[\\w-]+(?::[\\w-]+)+(?:\\.[\\w%-]+)+$"
73
+ },
74
+ "fieldMapping": {
75
+ "title": "Field Mapping",
76
+ "oneOf": [
77
+ {
78
+ "$ref": "#/definitions/mappingString"
79
+ },
80
+ {
81
+ "type": "array",
82
+ "items": {
83
+ "$ref": "#/definitions/mappingString"
84
+ }
85
+ }
86
+ ]
87
+ },
88
+ "refSchema": {
89
+ "title": "Ref Schema",
90
+ "type": "object",
91
+ "properties": {
92
+ "@ref": {
93
+ "$ref": "#/definitions/ref"
94
+ }
95
+ },
96
+ "required": [
97
+ "@ref"
98
+ ]
99
+ },
100
+ "refSchemaLegacy": {
101
+ "title": "Ref Schema Legacy",
102
+ "type": "object",
103
+ "properties": {
104
+ "$ref": {
105
+ "$ref": "#/definitions/ref"
106
+ }
107
+ },
108
+ "required": [
109
+ "$ref"
110
+ ]
111
+ },
112
+ "shapeSchemaEnum": {
113
+ "title": "Shape Schema Enum",
114
+ "type": "object",
115
+ "properties": {
116
+ "enum": {
117
+ "type": "array",
118
+ "minItems": 1,
119
+ "uniqueItems": true
120
+ }
121
+ },
122
+ "additionalProperties": false,
123
+ "required": [
124
+ "enum"
125
+ ]
126
+ },
127
+ "objectSchema": {
128
+ "title": "Object Schema",
129
+ "type": "object",
130
+ "allOf": [
131
+ {
132
+ "$ref": "#/definitions/propertySchema"
133
+ },
134
+ {
135
+ "properties": {
136
+ "type": {
137
+ "type": "string",
138
+ "const": "object"
139
+ },
140
+ "properties": {
141
+ "type": "object",
142
+ "additionalProperties": {
143
+ "$ref": "#/definitions/propertySchema"
144
+ }
145
+ }
146
+ },
147
+ "required": [
148
+ "type",
149
+ "properties"
150
+ ]
151
+ }
152
+ ]
153
+ },
154
+ "returnShapeArraySchema": {
155
+ "title": "Return Shape Array Schema",
156
+ "type": "object",
157
+ "allOf": [
158
+ {
159
+ "$ref": "#/definitions/propertySchema"
160
+ },
161
+ {
162
+ "properties": {
163
+ "type": {
164
+ "type": "string",
165
+ "const": "array"
166
+ },
167
+ "items": {
168
+ "oneOf": [
169
+ {
170
+ "$ref": "#/definitions/refSchema"
171
+ },
172
+ {
173
+ "type": "object",
174
+ "properties": {
175
+ "type": {
176
+ "enum": [
177
+ "boolean",
178
+ "integer",
179
+ "number",
180
+ "string",
181
+ "object"
182
+ ]
183
+ }
184
+ },
185
+ "required": [
186
+ "type"
187
+ ]
188
+ }
189
+ ]
190
+ }
191
+ },
192
+ "required": [
193
+ "type",
194
+ "items"
195
+ ]
196
+ }
197
+ ]
198
+ },
199
+ "objectOrRefArray": {
200
+ "title": "ObjectOrRefArray",
201
+ "type": "array",
202
+ "items": {
203
+ "oneOf": [
204
+ {
205
+ "$ref": "#/definitions/refSchema"
206
+ },
207
+ {
208
+ "$ref": "#/definitions/refSchemaLegacy"
209
+ },
210
+ {
211
+ "$ref": "#/definitions/objectSchema"
212
+ }
213
+ ],
214
+ "unevaluatedProperties": true
215
+ }
216
+ },
217
+ "shapeSchemaAllOf": {
218
+ "title": "Shape Schema All Of",
219
+ "type": "object",
220
+ "properties": {
221
+ "allOf": {
222
+ "$ref": "#/definitions/objectOrRefArray"
223
+ }
224
+ },
225
+ "required": [
226
+ "allOf"
227
+ ],
228
+ "additionalProperties": false
229
+ },
230
+ "allOfSchema": {
231
+ "title": "AllOfSchema",
232
+ "allOf": [
233
+ {
234
+ "$ref": "#/definitions/propertySchema"
235
+ },
236
+ {
237
+ "type": "object",
238
+ "properties": {
239
+ "allOf": {
240
+ "$ref": "#/definitions/objectOrRefArray"
241
+ }
242
+ },
243
+ "required": [
244
+ "allOf"
245
+ ]
246
+ }
247
+ ]
248
+ },
249
+ "shapeSchemaExtends": {
250
+ "title": "ShapeSchemaExtends",
251
+ "type": "object",
252
+ "properties": {
253
+ "extends": {
254
+ "$ref": "#/definitions/objectOrRefArray"
255
+ }
256
+ },
257
+ "required": [
258
+ "extends"
259
+ ],
260
+ "additionalProperties": false
261
+ },
262
+ "extendsSchema": {
263
+ "title": "ExtendsSchema",
264
+ "allOf": [
265
+ {
266
+ "$ref": "#/definitions/propertySchema"
267
+ },
268
+ {
269
+ "type": "object",
270
+ "properties": {
271
+ "extends": {
272
+ "$ref": "#/definitions/objectOrRefArray"
273
+ }
274
+ },
275
+ "required": [
276
+ "extends"
277
+ ]
278
+ }
279
+ ]
280
+ },
281
+ "shapeSchemaOneOf": {
282
+ "title": "Shape Schema One Of",
283
+ "type": "object",
284
+ "properties": {
285
+ "oneOf": {
286
+ "$ref": "#/definitions/objectOrRefArray"
287
+ }
288
+ },
289
+ "required": [
290
+ "oneOf"
291
+ ],
292
+ "additionalProperties": false
293
+ },
294
+ "oneOfSchema": {
295
+ "title": "OneOfSchema",
296
+ "allOf": [
297
+ {
298
+ "$ref": "#/definitions/propertySchema"
299
+ },
300
+ {
301
+ "type": "object",
302
+ "properties": {
303
+ "oneOf": {
304
+ "$ref": "#/definitions/objectOrRefArray"
305
+ }
306
+ },
307
+ "required": [
308
+ "oneOf"
309
+ ],
310
+ "additionalProperties": false
311
+ }
312
+ ]
313
+ },
314
+ "shapeSchemaAny": {
315
+ "type": "object",
316
+ "title": "ShapeSchemaAny",
317
+ "additionalProperties": false
318
+ },
319
+ "shapeSchema": {
320
+ "title": "Shape Schema",
321
+ "type": "object",
322
+ "oneOf": [
323
+ {
324
+ "$ref": "#/definitions/shapeSchemaAllOf"
325
+ },
326
+ {
327
+ "$ref": "#/definitions/shapeSchemaExtends"
328
+ },
329
+ {
330
+ "$ref": "#/definitions/shapeSchemaOneOf"
331
+ },
332
+ {
333
+ "$ref": "#/definitions/shapeSchemaEnum"
334
+ },
335
+ {
336
+ "$ref": "#/definitions/objectSchema"
337
+ },
338
+ {
339
+ "$ref": "#/definitions/shapeSchemaAny"
340
+ }
341
+ ]
342
+ },
343
+ "queryMap": {
344
+ "title": "Query Map",
345
+ "type": "object",
346
+ "patternProperties": {
347
+ "^[0-9A-Za-z_]+$": {
348
+ "$ref": "#/definitions/query"
349
+ }
350
+ },
351
+ "additionalProperties": false
352
+ },
353
+ "args": {
354
+ "title": "Args",
355
+ "oneOf": [
356
+ {
357
+ "type": "string"
358
+ },
359
+ {
360
+ "$ref": "#/definitions/objectSchema"
361
+ }
362
+ ]
363
+ },
364
+ "returnShape": {
365
+ "title": "Return Shape",
366
+ "oneOf": [
367
+ {
368
+ "type": "string"
369
+ },
370
+ {
371
+ "$ref": "#/definitions/returnShapeArraySchema"
372
+ }
373
+ ]
374
+ },
375
+ "directiveConfigItem": {
376
+ "title": "Directive Config Item",
377
+ "description": "A tuple with a string directive name, and options to pass to the directive",
378
+ "type": "array",
379
+ "items": [
380
+ {
381
+ "title": "Directive Name",
382
+ "type": "string"
383
+ },
384
+ {
385
+ "title": "Directive Options",
386
+ "type": "object",
387
+ "propertyNames": {
388
+ "pattern": "[0-9A-Za-z_-]+"
389
+ }
390
+ }
391
+ ]
392
+ },
393
+ "parameterSerializeStyleOptions": {
394
+ "title": "Parameter Serialize Style Options",
395
+ "description": "All possible options for the more specific ParameterSerializeStyleOptions types.",
396
+ "type": "object",
397
+ "properties": {
398
+ "style": {
399
+ "type": "string",
400
+ "enum": [
401
+ "simple",
402
+ "label",
403
+ "matrix",
404
+ "form",
405
+ "spaceDelimited",
406
+ "pipeDelimited",
407
+ "deepObject",
408
+ "none"
409
+ ]
410
+ },
411
+ "explode": {
412
+ "type": "boolean"
413
+ },
414
+ "allowEmptyValue": {
415
+ "type": "boolean"
416
+ },
417
+ "allowReserved": {
418
+ "description": "The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.",
419
+ "type": "boolean"
420
+ },
421
+ "skipEncoding": {
422
+ "type": "boolean"
423
+ }
424
+ },
425
+ "required": [
426
+ "style"
427
+ ],
428
+ "additionalProperties": false
429
+ },
430
+ "parameterSerializeStyleOptionsForPathParams": {
431
+ "title": "Parameter Serialize Style Options For Path Params",
432
+ "description": "Options to be passed to the serialization routine.",
433
+ "type": "object",
434
+ "properties": {
435
+ "style": {
436
+ "type": "string",
437
+ "enum": [
438
+ "simple",
439
+ "label",
440
+ "matrix",
441
+ "none"
442
+ ]
443
+ },
444
+ "explode": {
445
+ "type": "boolean"
446
+ },
447
+ "allowEmptyValue": {
448
+ "type": "boolean"
449
+ },
450
+ "allowReserved": {
451
+ "description": "The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.",
452
+ "type": "boolean"
453
+ },
454
+ "skipEncoding": {
455
+ "type": "boolean"
456
+ }
457
+ },
458
+ "required": [
459
+ "style"
460
+ ],
461
+ "additionalProperties": false
462
+ },
463
+ "parameterSerializeStyleOptionsForSearchParams": {
464
+ "title": "Parameter Serialize Style Options For Search Params",
465
+ "description": "Options to be passed to the serialization routine.",
466
+ "type": "object",
467
+ "properties": {
468
+ "style": {
469
+ "type": "string",
470
+ "enum": [
471
+ "form",
472
+ "spaceDelimited",
473
+ "pipeDelimited",
474
+ "deepObject",
475
+ "none"
476
+ ]
477
+ },
478
+ "explode": {
479
+ "type": "boolean"
480
+ },
481
+ "allowEmptyValue": {
482
+ "type": "boolean"
483
+ },
484
+ "allowReserved": {
485
+ "description": "The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.",
486
+ "type": "boolean"
487
+ },
488
+ "skipEncoding": {
489
+ "type": "boolean"
490
+ }
491
+ },
492
+ "required": [
493
+ "style"
494
+ ],
495
+ "additionalProperties": false
496
+ },
497
+ "parameterSerializeStyleOptionsForHeaders": {
498
+ "title": "Parameter Serialize Style Options For Headers",
499
+ "description": "Options to be passed to the serialization routine.",
500
+ "type": "object",
501
+ "properties": {
502
+ "style": {
503
+ "type": "string",
504
+ "enum": [
505
+ "simple",
506
+ "none"
507
+ ]
508
+ },
509
+ "explode": {
510
+ "type": "boolean"
511
+ }
512
+ },
513
+ "required": [
514
+ "style"
515
+ ],
516
+ "additionalProperties": false
517
+ },
518
+ "parameterSerializeContentOptions": {
519
+ "title": "Parameter Serialize Content Options",
520
+ "description": "Options to be passed to the serialization routine.",
521
+ "type": "object",
522
+ "properties": {
523
+ "contentType": {
524
+ "type": "string"
525
+ },
526
+ "allowReserved": {
527
+ "description": "The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.",
528
+ "type": "boolean"
529
+ },
530
+ "skipEncoding": {
531
+ "type": "boolean"
532
+ },
533
+ "options": {
534
+ "description": "Options to be passed directly to the content serializer library. Valid options depend upon your contentType.",
535
+ "type": "object"
536
+ }
537
+ },
538
+ "required": [
539
+ "contentType"
540
+ ],
541
+ "additionalProperties": false
542
+ },
543
+ "parameterSerializeOptions": {
544
+ "title": "Parameter Serialize Options",
545
+ "description": "Options to be passed to the serialization routine.",
546
+ "type": "object",
547
+ "oneOf": [
548
+ {
549
+ "$ref": "#/definitions/parameterSerializeStyleOptions"
550
+ },
551
+ {
552
+ "$ref": "#/definitions/parameterSerializeContentOptions"
553
+ }
554
+ ]
555
+ },
556
+ "parameterSerializeConfig": {
557
+ "title": "Parameter Serialize Config",
558
+ "description": "All possible options for the more specific ParameterSerializeConfig types.",
559
+ "type": "object",
560
+ "properties": {
561
+ "content": {
562
+ "$ref": "#/definitions/parameterSerializeContentOptions"
563
+ },
564
+ "defaults": {
565
+ "$ref": "#/definitions/parameterSerializeOptions"
566
+ },
567
+ "paths": {
568
+ "type": "object",
569
+ "patternProperties": {
570
+ "^[^\\n\\r]*$": {
571
+ "$ref": "#/definitions/parameterSerializeOptions"
572
+ }
573
+ }
574
+ }
575
+ },
576
+ "additionalProperties": false
577
+ },
578
+ "parameterSerializeConfigForBody": {
579
+ "title": "Parameter Serialize Config For Body",
580
+ "description": "Top-level paths to use serialization options for.",
581
+ "type": "object",
582
+ "properties": {
583
+ "content": {
584
+ "$ref": "#/definitions/parameterSerializeContentOptions"
585
+ }
586
+ },
587
+ "additionalProperties": false
588
+ },
589
+ "parameterSerializeConfigForPathParams": {
590
+ "title": "Parameter Serialize Config For Path Params",
591
+ "description": "Top-level paths to use path params serialization options for.",
592
+ "type": "object",
593
+ "properties": {
594
+ "template": {
595
+ "description": "For generating the path using tokens frpm the ParameterOps, e.g., '/products/{productId}'",
596
+ "type": "string"
597
+ },
598
+ "defaults": {
599
+ "oneOf": [
600
+ {
601
+ "$ref": "#/definitions/parameterSerializeStyleOptionsForPathParams"
602
+ },
603
+ {
604
+ "$ref": "#/definitions/parameterSerializeContentOptions"
605
+ }
606
+ ]
607
+ },
608
+ "paths": {
609
+ "type": "object",
610
+ "patternProperties": {
611
+ "^[^\\n\\r]*$": {
612
+ "oneOf": [
613
+ {
614
+ "$ref": "#/definitions/parameterSerializeStyleOptionsForPathParams"
615
+ },
616
+ {
617
+ "$ref": "#/definitions/parameterSerializeContentOptions"
618
+ }
619
+ ]
620
+ }
621
+ }
622
+ }
623
+ },
624
+ "required": [
625
+ "template"
626
+ ],
627
+ "additionalProperties": false
628
+ },
629
+ "parameterSerializeConfigForSearchParams": {
630
+ "title": "Parameter Serialize Config For Search Params",
631
+ "description": "Top-level paths to use search params serialization options for.",
632
+ "type": "object",
633
+ "properties": {
634
+ "defaults": {
635
+ "oneOf": [
636
+ {
637
+ "$ref": "#/definitions/parameterSerializeStyleOptionsForSearchParams"
638
+ },
639
+ {
640
+ "$ref": "#/definitions/parameterSerializeContentOptions"
641
+ }
642
+ ]
643
+ },
644
+ "paths": {
645
+ "type": "object",
646
+ "patternProperties": {
647
+ "^[^\\n\\r]*$": {
648
+ "oneOf": [
649
+ {
650
+ "$ref": "#/definitions/parameterSerializeStyleOptionsForSearchParams"
651
+ },
652
+ {
653
+ "$ref": "#/definitions/parameterSerializeContentOptions"
654
+ }
655
+ ]
656
+ }
657
+ }
658
+ }
659
+ },
660
+ "additionalProperties": false
661
+ },
662
+ "parameterSerializeConfigForHeaders": {
663
+ "title": "Parameter Serialize Config For Headers",
664
+ "description": "Top-level paths to use headers serialization options for.",
665
+ "type": "object",
666
+ "properties": {
667
+ "defaults": {
668
+ "oneOf": [
669
+ {
670
+ "$ref": "#/definitions/parameterSerializeStyleOptionsForHeaders"
671
+ },
672
+ {
673
+ "$ref": "#/definitions/parameterSerializeContentOptions"
674
+ }
675
+ ]
676
+ },
677
+ "paths": {
678
+ "type": "object",
679
+ "patternProperties": {
680
+ "^[^\\n\\r]*$": {
681
+ "oneOf": [
682
+ {
683
+ "$ref": "#/definitions/parameterSerializeStyleOptionsForHeaders"
684
+ },
685
+ {
686
+ "$ref": "#/definitions/parameterSerializeContentOptions"
687
+ }
688
+ ]
689
+ }
690
+ }
691
+ }
692
+ },
693
+ "additionalProperties": false
694
+ },
695
+ "parameterOpNested": {
696
+ "title": "Parameter Op Nested",
697
+ "description": "An object describing an operation to generate a parameter, using a nested OpList.",
698
+ "type": "object",
699
+ "properties": {
700
+ "path": {
701
+ "description": "A path to the parameter for this operation.",
702
+ "type": "string",
703
+ "minLength": 1,
704
+ "pattern": "^[^\\n\\r]*$"
705
+ },
706
+ "op": {
707
+ "description": "A mode for this parameter's operation.",
708
+ "type": "string",
709
+ "enum": [
710
+ "set",
711
+ "concat",
712
+ "extend",
713
+ "remove"
714
+ ]
715
+ },
716
+ "ops": {
717
+ "description": "A nested op list.",
718
+ "$ref": "#/definitions/parameterOpList"
719
+ }
720
+ },
721
+ "required": [
722
+ "path",
723
+ "ops"
724
+ ],
725
+ "additionalProperties": false
726
+ },
727
+ "parameterOpValue": {
728
+ "title": "Parameter Op Value",
729
+ "description": "An object describing an operation to generate a parameter using a value.",
730
+ "type": "object",
731
+ "properties": {
732
+ "path": {
733
+ "description": "A path to the parameter for this operation.",
734
+ "type": "string",
735
+ "minLength": 1,
736
+ "pattern": "^[^\\n\\r]*$"
737
+ },
738
+ "op": {
739
+ "description": "A mode for this parameter's operation.",
740
+ "type": "string",
741
+ "enum": [
742
+ "set",
743
+ "concat",
744
+ "extend",
745
+ "remove"
746
+ ]
747
+ },
748
+ "value": {
749
+ "description": "A value to set directly at this path.",
750
+ "type": [
751
+ "number",
752
+ "string",
753
+ "boolean",
754
+ "object",
755
+ "array",
756
+ "null"
757
+ ]
758
+ }
759
+ },
760
+ "required": [
761
+ "path",
762
+ "value"
763
+ ],
764
+ "additionalProperties": false
765
+ },
766
+ "parameterOpMapping": {
767
+ "title": "Parameter Op Mapping",
768
+ "description": "An object describing an operation to generate a parameter using a mapping.",
769
+ "type": "object",
770
+ "properties": {
771
+ "path": {
772
+ "description": "A path to the parameter for this operation.",
773
+ "type": "string",
774
+ "minLength": 1,
775
+ "pattern": "^[^\\n\\r]*$"
776
+ },
777
+ "op": {
778
+ "description": "A mode for this parameter's operation.",
779
+ "type": "string",
780
+ "enum": [
781
+ "set",
782
+ "concat",
783
+ "extend",
784
+ "remove"
785
+ ]
786
+ },
787
+ "mapping": {
788
+ "description": "Either a valid JSONPath or a directive pipeline to evaluate against the query context.",
789
+ "oneOf": [
790
+ {
791
+ "type": "string",
792
+ "minLength": 1
793
+ },
794
+ {
795
+ "$ref": "#/definitions/directiveConfig"
796
+ }
797
+ ]
798
+ }
799
+ },
800
+ "required": [
801
+ "path",
802
+ "mapping"
803
+ ],
804
+ "additionalProperties": false
805
+ },
806
+ "parameterOpOp": {
807
+ "title": "Parameter Op Op",
808
+ "description": "An object describing an operation to generate a parameter using a mapping.",
809
+ "type": "object",
810
+ "properties": {
811
+ "path": {
812
+ "description": "A path to the parameter for this operation.",
813
+ "type": "string",
814
+ "minLength": 1,
815
+ "pattern": "^[^\\n\\r]*$"
816
+ },
817
+ "op": {
818
+ "description": "A mode for this parameter's operation.",
819
+ "type": "string",
820
+ "enum": [
821
+ "set",
822
+ "concat",
823
+ "extend",
824
+ "remove"
825
+ ]
826
+ }
827
+ },
828
+ "required": [
829
+ "path",
830
+ "op"
831
+ ],
832
+ "additionalProperties": false
833
+ },
834
+ "parameterOp": {
835
+ "title": "Parameter Op",
836
+ "description": "An object describing an operation to generate a parameter.",
837
+ "oneOf": [
838
+ {
839
+ "$ref": "#/definitions/parameterOpNested"
840
+ },
841
+ {
842
+ "$ref": "#/definitions/parameterOpValue"
843
+ },
844
+ {
845
+ "$ref": "#/definitions/parameterOpMapping"
846
+ },
847
+ {
848
+ "$ref": "#/definitions/parameterOpOp"
849
+ }
850
+ ]
851
+ },
852
+ "parameterOpList": {
853
+ "title": "Parameter Op List",
854
+ "type": "array",
855
+ "items": {
856
+ "$ref": "#/definitions/parameterOp"
857
+ },
858
+ "minItems": 1
859
+ },
860
+ "parameterConfig": {
861
+ "title": "Parameter Config",
862
+ "description": "All possible options for the more specific ParameterConfig types.",
863
+ "type": "object",
864
+ "properties": {
865
+ "ops": {
866
+ "$ref": "#/definitions/parameterOpList"
867
+ },
868
+ "serialize": {
869
+ "$ref": "#/definitions/parameterSerializeConfig"
870
+ }
871
+ },
872
+ "required": [
873
+ "ops"
874
+ ],
875
+ "additionalProperties": false
876
+ },
877
+ "parameterConfigForBody": {
878
+ "title": "Parameter Config For Body",
879
+ "type": "object",
880
+ "properties": {
881
+ "ops": {
882
+ "$ref": "#/definitions/parameterOpList"
883
+ },
884
+ "serialize": {
885
+ "$ref": "#/definitions/parameterSerializeConfigForBody"
886
+ }
887
+ },
888
+ "required": [
889
+ "ops"
890
+ ],
891
+ "additionalProperties": false
892
+ },
893
+ "parameterConfigForPathParams": {
894
+ "title": "Parameter Config For Path Params",
895
+ "type": "object",
896
+ "properties": {
897
+ "ops": {
898
+ "$ref": "#/definitions/parameterOpList"
899
+ },
900
+ "serialize": {
901
+ "$ref": "#/definitions/parameterSerializeConfigForPathParams"
902
+ }
903
+ },
904
+ "required": [
905
+ "ops",
906
+ "serialize"
907
+ ],
908
+ "additionalProperties": false
909
+ },
910
+ "parameterConfigForAwsLambda": {
911
+ "title": "ParameterConfigForAwsLambda",
912
+ "type": "object",
913
+ "properties": {
914
+ "ops": {
915
+ "$ref": "#/definitions/parameterOpList"
916
+ },
917
+ "serialize": {
918
+ "$ref": "#/definitions/parameterSerializeConfigForPathParams"
919
+ }
920
+ },
921
+ "required": [
922
+ "ops",
923
+ "serialize"
924
+ ],
925
+ "additionalProperties": false
926
+ },
927
+ "parameterConfigForSearchParams": {
928
+ "title": "Parameter Config For Search Params",
929
+ "type": "object",
930
+ "properties": {
931
+ "ops": {
932
+ "$ref": "#/definitions/parameterOpList"
933
+ },
934
+ "serialize": {
935
+ "$ref": "#/definitions/parameterSerializeConfigForSearchParams"
936
+ }
937
+ },
938
+ "required": [
939
+ "ops"
940
+ ],
941
+ "additionalProperties": false
942
+ },
943
+ "parameterConfigForHeaders": {
944
+ "title": "Parameter Config For Headers",
945
+ "type": "object",
946
+ "properties": {
947
+ "ops": {
948
+ "$ref": "#/definitions/parameterOpList"
949
+ },
950
+ "serialize": {
951
+ "$ref": "#/definitions/parameterSerializeConfigForHeaders"
952
+ }
953
+ },
954
+ "required": [
955
+ "ops"
956
+ ],
957
+ "additionalProperties": false
958
+ },
959
+ "parameterConfigForJson": {
960
+ "title": "Parameter Config For Json",
961
+ "type": "object",
962
+ "properties": {
963
+ "ops": {
964
+ "$ref": "#/definitions/parameterOpList"
965
+ }
966
+ },
967
+ "required": [
968
+ "ops"
969
+ ],
970
+ "additionalProperties": false
971
+ },
972
+ "directiveConfig": {
973
+ "title": "Directive Config",
974
+ "description": "An array of individual directive config items to process in order",
975
+ "type": "array",
976
+ "items": {
977
+ "$ref": "#/definitions/directiveConfigItem"
978
+ },
979
+ "minItems": 1
980
+ },
981
+ "directiveMappingMap": {
982
+ "title": "Directive Mapping Map",
983
+ "description": "An map of object keys / key paths to directive configs",
984
+ "type": "object",
985
+ "patternProperties": {
986
+ "[0-9A-Za-z_-]+": {
987
+ "$ref": "#/definitions/directiveConfig"
988
+ }
989
+ }
990
+ },
991
+ "directiveMappingArrayItem": {
992
+ "title": "Directive Mapping Array Item",
993
+ "description": "A tuple with a string key and a directive config to evaluate",
994
+ "type": "array",
995
+ "items": [
996
+ {
997
+ "type": "string"
998
+ },
999
+ {
1000
+ "$ref": "#/definitions/directiveConfig"
1001
+ }
1002
+ ]
1003
+ },
1004
+ "directiveMappingArray": {
1005
+ "title": "Directive Mapping Array",
1006
+ "description": "An array of key / value or directive config tuples",
1007
+ "type": "array",
1008
+ "items": {
1009
+ "$ref": "#/definitions/directiveMappingArrayItem"
1010
+ }
1011
+ },
1012
+ "basicResolver": {
1013
+ "title": "BasicResolver",
1014
+ "description": "A single resolver, can be composed with the ComposeResolver.",
1015
+ "discriminator": {
1016
+ "propertyName": "name"
1017
+ },
1018
+ "oneOf": [
1019
+ {
1020
+ "$ref": "#/definitions/utilResolver"
1021
+ },
1022
+ {
1023
+ "$ref": "#/definitions/delegateResolver"
1024
+ },
1025
+ {
1026
+ "$ref": "#/definitions/takeshapeResolver"
1027
+ },
1028
+ {
1029
+ "$ref": "#/definitions/shapedbResolver"
1030
+ },
1031
+ {
1032
+ "$ref": "#/definitions/shapedbResolverShapeNameNotRequired"
1033
+ },
1034
+ {
1035
+ "$ref": "#/definitions/graphqlResolver"
1036
+ },
1037
+ {
1038
+ "$ref": "#/definitions/restResolver"
1039
+ },
1040
+ {
1041
+ "$ref": "#/definitions/awsLambdaResolver"
1042
+ },
1043
+ {
1044
+ "$ref": "#/definitions/salsifyResolver"
1045
+ },
1046
+ {
1047
+ "$ref": "#/definitions/functionResolver"
1048
+ },
1049
+ {
1050
+ "$ref": "#/definitions/aiGenerateTextResolver"
1051
+ },
1052
+ {
1053
+ "$ref": "#/definitions/aiEmbeddingResolver"
1054
+ },
1055
+ {
1056
+ "$ref": "#/definitions/aiParseFileResolver"
1057
+ }
1058
+ ]
1059
+ },
1060
+ "serviceResolver": {
1061
+ "title": "ServiceResolver",
1062
+ "description": "A resolver which references a specific service",
1063
+ "discriminator": {
1064
+ "propertyName": "name"
1065
+ },
1066
+ "oneOf": [
1067
+ {
1068
+ "$ref": "#/definitions/takeshapeResolver"
1069
+ },
1070
+ {
1071
+ "$ref": "#/definitions/shapedbResolverShapeNameNotRequired"
1072
+ },
1073
+ {
1074
+ "$ref": "#/definitions/shapedbResolver"
1075
+ },
1076
+ {
1077
+ "$ref": "#/definitions/graphqlResolver"
1078
+ },
1079
+ {
1080
+ "$ref": "#/definitions/restResolver"
1081
+ },
1082
+ {
1083
+ "$ref": "#/definitions/awsLambdaResolver"
1084
+ }
1085
+ ]
1086
+ },
1087
+ "argsMapping": {
1088
+ "title": "ArgsMapping",
1089
+ "description": "Maps a query's input args to the input expected by the service's endpoint.",
1090
+ "oneOf": [
1091
+ {
1092
+ "$ref": "#/definitions/directiveMappingMap"
1093
+ },
1094
+ {
1095
+ "$ref": "#/definitions/directiveConfig"
1096
+ }
1097
+ ]
1098
+ },
1099
+ "searchParamsMapping": {
1100
+ "title": "SearchParamsMapping",
1101
+ "description": "Set or evaluate directives to generate searchParams for the service endpoint.",
1102
+ "$ref": "#/definitions/directiveMappingArray"
1103
+ },
1104
+ "resultsMapping": {
1105
+ "title": "ResultsMapping",
1106
+ "description": "Maps a service endpoint's response results to the expected shape of the query's response.",
1107
+ "oneOf": [
1108
+ {
1109
+ "$ref": "#/definitions/directiveMappingMap"
1110
+ },
1111
+ {
1112
+ "$ref": "#/definitions/directiveConfig"
1113
+ }
1114
+ ]
1115
+ },
1116
+ "utilResolver": {
1117
+ "title": "UtilResolver",
1118
+ "type": "object",
1119
+ "properties": {
1120
+ "if": {
1121
+ "type": "string"
1122
+ },
1123
+ "id": {
1124
+ "type": "string",
1125
+ "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1126
+ },
1127
+ "name": {
1128
+ "title": "UtilResolverName",
1129
+ "type": "string",
1130
+ "description": "Name of the resolver function.",
1131
+ "enum": [
1132
+ "util:noop",
1133
+ "util:wrap"
1134
+ ]
1135
+ },
1136
+ "options": {
1137
+ "title": "UtilResolverOptions",
1138
+ "type": "object",
1139
+ "additionalProperties": true
1140
+ },
1141
+ "value": {
1142
+ "description": "Optional value to return from the noop resolver.",
1143
+ "type": [
1144
+ "number",
1145
+ "string",
1146
+ "boolean",
1147
+ "object",
1148
+ "array",
1149
+ "null"
1150
+ ]
1151
+ },
1152
+ "args": {
1153
+ "description": "Mapping and serialization configuration for args.",
1154
+ "$ref": "#/definitions/parameterConfigForJson"
1155
+ },
1156
+ "results": {
1157
+ "description": "Mapping configuration for the results of this resolver step.",
1158
+ "$ref": "#/definitions/parameterConfigForJson"
1159
+ },
1160
+ "argsMapping": {
1161
+ "$ref": "#/definitions/argsMapping"
1162
+ },
1163
+ "resultsMapping": {
1164
+ "$ref": "#/definitions/resultsMapping"
1165
+ }
1166
+ },
1167
+ "required": [
1168
+ "name"
1169
+ ],
1170
+ "additionalProperties": false
1171
+ },
1172
+ "functionResolver": {
1173
+ "title": "FunctionResolver",
1174
+ "type": "object",
1175
+ "properties": {
1176
+ "if": {
1177
+ "type": "string"
1178
+ },
1179
+ "id": {
1180
+ "type": "string",
1181
+ "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1182
+ },
1183
+ "name": {
1184
+ "title": "FunctionResolverName",
1185
+ "type": "string",
1186
+ "description": "Name of the resolver function.",
1187
+ "enum": [
1188
+ "function:run"
1189
+ ]
1190
+ },
1191
+ "options": {
1192
+ "title": "FunctionResolverOptions",
1193
+ "type": "object",
1194
+ "additionalProperties": true
1195
+ },
1196
+ "args": {
1197
+ "description": "Mapping and serialization configuration for args.",
1198
+ "$ref": "#/definitions/parameterConfigForJson"
1199
+ },
1200
+ "results": {
1201
+ "description": "Mapping configuration for the results of this resolver step.",
1202
+ "$ref": "#/definitions/parameterConfigForJson"
1203
+ },
1204
+ "argsMapping": {
1205
+ "$ref": "#/definitions/argsMapping"
1206
+ },
1207
+ "resultsMapping": {
1208
+ "$ref": "#/definitions/resultsMapping"
1209
+ },
1210
+ "javascript": {
1211
+ "title": "FunctionResolverJavascript",
1212
+ "type": "string"
1213
+ }
1214
+ },
1215
+ "required": [
1216
+ "name"
1217
+ ],
1218
+ "additionalProperties": false
1219
+ },
1220
+ "delegateResolver": {
1221
+ "title": "DelegateResolver",
1222
+ "type": "object",
1223
+ "properties": {
1224
+ "if": {
1225
+ "type": "string"
1226
+ },
1227
+ "id": {
1228
+ "type": "string",
1229
+ "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1230
+ },
1231
+ "name": {
1232
+ "title": "Delegate Resolver Name",
1233
+ "type": "string",
1234
+ "description": "Name of the resolver function.",
1235
+ "enum": [
1236
+ "delegate"
1237
+ ]
1238
+ },
1239
+ "options": {
1240
+ "title": "DelegateResolverOptions",
1241
+ "type": "object",
1242
+ "additionalProperties": true
1243
+ },
1244
+ "argsMapping": {
1245
+ "$ref": "#/definitions/argsMapping"
1246
+ },
1247
+ "resultsMapping": {
1248
+ "$ref": "#/definitions/resultsMapping"
1249
+ },
1250
+ "to": {
1251
+ "description": "A ref to a query/mutation/property to delegate to.",
1252
+ "type": "string",
1253
+ "minLength": 1
1254
+ },
1255
+ "args": {
1256
+ "description": "Mapping and serialization configuration for args.",
1257
+ "$ref": "#/definitions/parameterConfigForJson"
1258
+ },
1259
+ "results": {
1260
+ "description": "Mapping configuration for the results of this resolver step.",
1261
+ "$ref": "#/definitions/parameterConfigForJson"
1262
+ }
1263
+ },
1264
+ "required": [
1265
+ "name",
1266
+ "to"
1267
+ ],
1268
+ "additionalProperties": false
1269
+ },
1270
+ "salsifyResolver": {
1271
+ "title": "SalsifyResolver",
1272
+ "type": "object",
1273
+ "properties": {
1274
+ "if": {
1275
+ "type": "string"
1276
+ },
1277
+ "id": {
1278
+ "type": "string",
1279
+ "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1280
+ },
1281
+ "name": {
1282
+ "title": "Salsify Resolver Name",
1283
+ "type": "string",
1284
+ "description": "Name of the resolver function.",
1285
+ "enum": [
1286
+ "salsify:listChannelProducts"
1287
+ ]
1288
+ },
1289
+ "service": {
1290
+ "type": "string",
1291
+ "description": "Configuration for a service to use with this resolver."
1292
+ },
1293
+ "options": {
1294
+ "title": "SalsifyResolverOptions",
1295
+ "type": "object",
1296
+ "additionalProperties": true
1297
+ },
1298
+ "args": {
1299
+ "description": "Mapping and serialization configuration for args.",
1300
+ "$ref": "#/definitions/parameterConfigForJson"
1301
+ },
1302
+ "results": {
1303
+ "description": "Mapping configuration for the results of this resolver step.",
1304
+ "$ref": "#/definitions/parameterConfigForJson"
1305
+ },
1306
+ "argsMapping": {
1307
+ "$ref": "#/definitions/argsMapping"
1308
+ },
1309
+ "resultsMapping": {
1310
+ "$ref": "#/definitions/resultsMapping"
1311
+ }
1312
+ },
1313
+ "required": [
1314
+ "name",
1315
+ "service"
1316
+ ],
1317
+ "additionalProperties": false
1318
+ },
1319
+ "shapedbResolver": {
1320
+ "title": "ShapedbResolver",
1321
+ "type": "object",
1322
+ "properties": {
1323
+ "if": {
1324
+ "type": "string"
1325
+ },
1326
+ "id": {
1327
+ "type": "string",
1328
+ "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1329
+ },
1330
+ "name": {
1331
+ "title": "ShapedbResolverName",
1332
+ "type": "string",
1333
+ "description": "Name of the resolver function.",
1334
+ "enum": [
1335
+ "shapedb:get",
1336
+ "shapedb:create",
1337
+ "shapedb:update",
1338
+ "shapedb:delete",
1339
+ "shapedb:duplicate",
1340
+ "shapedb:find"
1341
+ ]
1342
+ },
1343
+ "service": {
1344
+ "type": "string",
1345
+ "description": "Internal service identifier.",
1346
+ "enum": [
1347
+ "shapedb"
1348
+ ]
1349
+ },
1350
+ "options": {
1351
+ "title": "ShapedbResolverOptions",
1352
+ "type": "object",
1353
+ "additionalProperties": true
1354
+ },
1355
+ "argsMapping": {
1356
+ "$ref": "#/definitions/argsMapping"
1357
+ },
1358
+ "resultsMapping": {
1359
+ "$ref": "#/definitions/resultsMapping"
1360
+ },
1361
+ "shapeName": {
1362
+ "description": "A Shape name for the resolver to use.",
1363
+ "type": "string",
1364
+ "minLength": 1
1365
+ },
1366
+ "args": {
1367
+ "description": "Mapping and serialization configuration for args.",
1368
+ "$ref": "#/definitions/parameterConfigForJson"
1369
+ },
1370
+ "results": {
1371
+ "description": "Mapping configuration for the results of this resolver step.",
1372
+ "$ref": "#/definitions/parameterConfigForJson"
1373
+ }
1374
+ },
1375
+ "required": [
1376
+ "name",
1377
+ "service",
1378
+ "shapeName"
1379
+ ],
1380
+ "additionalProperties": false
1381
+ },
1382
+ "shapedbResolverShapeNameNotRequired": {
1383
+ "title": "ShapedbResolverShapeNameNotRequired",
1384
+ "type": "object",
1385
+ "properties": {
1386
+ "if": {
1387
+ "type": "string"
1388
+ },
1389
+ "id": {
1390
+ "type": "string",
1391
+ "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1392
+ },
1393
+ "name": {
1394
+ "title": "ShapedbResolverShapeNameNotRequiredName",
1395
+ "type": "string",
1396
+ "description": "Name of the resolver function.",
1397
+ "enum": [
1398
+ "shapedb:list",
1399
+ "shapedb:taxonomySuggest",
1400
+ "shapedb:getRelated"
1401
+ ]
1402
+ },
1403
+ "service": {
1404
+ "type": "string",
1405
+ "description": "Internal service identifier.",
1406
+ "enum": [
1407
+ "shapedb"
1408
+ ]
1409
+ },
1410
+ "options": {
1411
+ "title": "ShapedbResolverShapeNameNotRequiredOptions",
1412
+ "type": "object",
1413
+ "additionalProperties": true
1414
+ },
1415
+ "shapeName": {
1416
+ "description": "An optional Shape name for the resolver.",
1417
+ "type": "string",
1418
+ "minLength": 1
1419
+ },
1420
+ "args": {
1421
+ "description": "Mapping and serialization configuration for args.",
1422
+ "$ref": "#/definitions/parameterConfigForJson"
1423
+ },
1424
+ "results": {
1425
+ "description": "Mapping configuration for the results of this resolver step.",
1426
+ "$ref": "#/definitions/parameterConfigForJson"
1427
+ },
1428
+ "argsMapping": {
1429
+ "$ref": "#/definitions/argsMapping"
1430
+ },
1431
+ "resultsMapping": {
1432
+ "$ref": "#/definitions/resultsMapping"
1433
+ }
1434
+ },
1435
+ "required": [
1436
+ "name",
1437
+ "service"
1438
+ ],
1439
+ "additionalProperties": false
1440
+ },
1441
+ "aiToolConfig": {
1442
+ "title": "AIToolConfig",
1443
+ "type": "object",
1444
+ "properties": {
1445
+ "ref": {
1446
+ "type": "string"
1447
+ },
1448
+ "selectionSet": {
1449
+ "type": "string"
1450
+ }
1451
+ },
1452
+ "required": [
1453
+ "ref"
1454
+ ],
1455
+ "additionalProperties": false
1456
+ },
1457
+ "aiSimilarityGuardrail": {
1458
+ "title": "AISimilarityGuardrail",
1459
+ "type": "object",
1460
+ "properties": {
1461
+ "name": {
1462
+ "enum": [
1463
+ "similarity"
1464
+ ]
1465
+ },
1466
+ "shape": {
1467
+ "type": "string"
1468
+ },
1469
+ "defaultResponse": {
1470
+ "type": "string"
1471
+ },
1472
+ "threshold": {
1473
+ "type": "number"
1474
+ }
1475
+ },
1476
+ "required": [
1477
+ "name",
1478
+ "shape",
1479
+ "defaultResponse"
1480
+ ],
1481
+ "additionalProperties": false
1482
+ },
1483
+ "aiGuardrail": {
1484
+ "title": "AIGuardrail",
1485
+ "discriminator": {
1486
+ "propertyName": "name"
1487
+ },
1488
+ "oneOf": [
1489
+ {
1490
+ "$ref": "#/definitions/aiSimilarityGuardrail"
1491
+ }
1492
+ ]
1493
+ },
1494
+ "aiGenerateTextResolverOptions": {
1495
+ "title": "AIGenerateTextResolverOptions",
1496
+ "type": "object",
1497
+ "properties": {
1498
+ "history": {
1499
+ "title": "history",
1500
+ "type": "boolean"
1501
+ },
1502
+ "maxTokens": {
1503
+ "type": "integer",
1504
+ "title": "Maximum Tokens",
1505
+ "description": "Maximum number of tokens to generate."
1506
+ },
1507
+ "temperature": {
1508
+ "type": "number",
1509
+ "title": "Temperature",
1510
+ "description": "This is a number between 0 (almost no randomness) and 1 (very random). It is recommended to set either `temperature` or `topP`, but not both. Defaults to 0",
1511
+ "minimum": 0,
1512
+ "maximum": 1
1513
+ },
1514
+ "topP": {
1515
+ "type": "number",
1516
+ "title": "Top P",
1517
+ "description": "Nucleus sampling. This is a number between 0 and 1. E.g. 0.1 would mean that only tokens with the top 10% probability mass are considered. It is recommended to set either `temperature` or `topP`, but not both.",
1518
+ "minimum": 0,
1519
+ "maximum": 1
1520
+ },
1521
+ "topK": {
1522
+ "type": "number",
1523
+ "title": "Top K",
1524
+ "description": "Only sample from the top K options for each subsequent token. Used to remove \"long tail\" low probability responses. Recommended for advanced use cases only. You usually only need to use temperature."
1525
+ },
1526
+ "presencePenalty": {
1527
+ "type": "number",
1528
+ "title": "Presence penalty setting",
1529
+ "description": "It affects the likelihood of the model to repeat information that is already in the prompt. The presence penalty is a number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition). 0 means no penalty.",
1530
+ "minimum": -1,
1531
+ "maximum": 1
1532
+ },
1533
+ "frequencyPenalty": {
1534
+ "type": "number",
1535
+ "title": "Frequency penalty setting",
1536
+ "description": "It affects the likelihood of the model to repeatedly use the same words or phrases. The frequency penalty is a number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition). 0 means no penalty.",
1537
+ "minimum": -1,
1538
+ "maximum": 1
1539
+ },
1540
+ "stopSequences": {
1541
+ "title": "Stop sequences",
1542
+ "description": "If set, the model will stop generating text when one of the stop sequences is generated.",
1543
+ "type": "array",
1544
+ "items": {
1545
+ "type": "string"
1546
+ }
1547
+ },
1548
+ "seed": {
1549
+ "type": "integer",
1550
+ "title": "Seed",
1551
+ "description": " The seed (integer) to use for random sampling. If set and supported by the model, calls will generate deterministic results."
1552
+ },
1553
+ "maxRetries": {
1554
+ "type": "integer",
1555
+ "description": "Maximum number of retries. Set to 0 to disable retries. Defaults to 2"
1556
+ },
1557
+ "toolChoice": {
1558
+ "type": "string",
1559
+ "description": "The tool choice strategy. Default: 'auto'",
1560
+ "anyOf": [
1561
+ {
1562
+ "enum": [
1563
+ "auto",
1564
+ "none",
1565
+ "required"
1566
+ ]
1567
+ },
1568
+ {
1569
+ "type": "string"
1570
+ }
1571
+ ]
1572
+ },
1573
+ "maxToolRoundtrips": {
1574
+ "type": "integer",
1575
+ "description": "Maximal number of automatic roundtrips for tool calls."
1576
+ }
1577
+ }
1578
+ },
1579
+ "aiGenerateTextResolver": {
1580
+ "title": "AIGenerateTextResolver",
1581
+ "type": "object",
1582
+ "properties": {
1583
+ "if": {
1584
+ "type": "string"
1585
+ },
1586
+ "id": {
1587
+ "type": "string",
1588
+ "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1589
+ },
1590
+ "name": {
1591
+ "title": "AI Resolver Name",
1592
+ "type": "string",
1593
+ "description": "Name of the resolver function.",
1594
+ "enum": [
1595
+ "ai:generateText",
1596
+ "ai:chat"
1597
+ ]
1598
+ },
1599
+ "service": {
1600
+ "type": "string",
1601
+ "description": "Configuration for a service to use with this resolver."
1602
+ },
1603
+ "options": {
1604
+ "$ref": "#/definitions/aiGenerateTextResolverOptions"
1605
+ },
1606
+ "systemPrompt": {
1607
+ "type": "string"
1608
+ },
1609
+ "inputTemplate": {
1610
+ "type": "string"
1611
+ },
1612
+ "model": {
1613
+ "type": "string"
1614
+ },
1615
+ "tools": {
1616
+ "type": "array",
1617
+ "items": {
1618
+ "oneOf": [
1619
+ {
1620
+ "type": "string"
1621
+ },
1622
+ {
1623
+ "$ref": "#/definitions/aiToolConfig"
1624
+ }
1625
+ ]
1626
+ }
1627
+ },
1628
+ "guardrails": {
1629
+ "type": "array",
1630
+ "items": {
1631
+ "$ref": "#/definitions/aiGuardrail"
1632
+ }
1633
+ },
1634
+ "context": {
1635
+ "description": "Mapping and serialization configuration for prompt context.",
1636
+ "$ref": "#/definitions/parameterConfigForJson"
1637
+ },
1638
+ "results": {
1639
+ "description": "Mapping configuration for the results of this resolver step.",
1640
+ "$ref": "#/definitions/parameterConfigForJson"
1641
+ }
1642
+ },
1643
+ "required": [
1644
+ "name",
1645
+ "service",
1646
+ "model",
1647
+ "systemPrompt"
1648
+ ],
1649
+ "additionalProperties": false
1650
+ },
1651
+ "aiEmbeddingResolverOptions": {
1652
+ "title": "AIEmbeddingResolverOptions",
1653
+ "type": "object",
1654
+ "properties": {
1655
+ "useDependencies": {
1656
+ "type": "boolean"
1657
+ }
1658
+ }
1659
+ },
1660
+ "aiEmbeddingResolver": {
1661
+ "title": "AIEmbeddingResolver",
1662
+ "type": "object",
1663
+ "properties": {
1664
+ "if": {
1665
+ "type": "string"
1666
+ },
1667
+ "id": {
1668
+ "type": "string",
1669
+ "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1670
+ },
1671
+ "name": {
1672
+ "title": "AI Resolver Name",
1673
+ "type": "string",
1674
+ "description": "Name of the resolver function.",
1675
+ "enum": [
1676
+ "ai:createEmbedding"
1677
+ ]
1678
+ },
1679
+ "service": {
1680
+ "type": "string",
1681
+ "description": "Configuration for a service to use with this resolver."
1682
+ },
1683
+ "options": {
1684
+ "$ref": "#/definitions/aiEmbeddingResolverOptions"
1685
+ },
1686
+ "model": {
1687
+ "type": "string"
1688
+ },
1689
+ "args": {
1690
+ "description": "Mapping and serialization configuration for prompt context.",
1691
+ "$ref": "#/definitions/parameterConfigForJson"
1692
+ },
1693
+ "results": {
1694
+ "description": "Mapping configuration for the results of this resolver step.",
1695
+ "$ref": "#/definitions/parameterConfigForJson"
1696
+ }
1697
+ },
1698
+ "required": [
1699
+ "name",
1700
+ "service",
1701
+ "model"
1702
+ ],
1703
+ "additionalProperties": false
1704
+ },
1705
+ "aiParseFileResolverOptions": {
1706
+ "title": "AIParseFileResolverOptions",
1707
+ "type": "object"
1708
+ },
1709
+ "aiParseFileResolver": {
1710
+ "title": "AIParseFileResolver",
1711
+ "type": "object",
1712
+ "properties": {
1713
+ "if": {
1714
+ "type": "string"
1715
+ },
1716
+ "id": {
1717
+ "type": "string",
1718
+ "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1719
+ },
1720
+ "name": {
1721
+ "title": "AI Resolver Name",
1722
+ "type": "string",
1723
+ "description": "Name of the resolver function.",
1724
+ "enum": [
1725
+ "ai:parseFile"
1726
+ ]
1727
+ },
1728
+ "service": {
1729
+ "type": "string",
1730
+ "description": "Configuration for a service to use with this resolver."
1731
+ },
1732
+ "options": {
1733
+ "$ref": "#/definitions/aiEmbeddingResolverOptions"
1734
+ },
1735
+ "args": {
1736
+ "description": "Mapping and serialization configuration for prompt context.",
1737
+ "$ref": "#/definitions/parameterConfigForJson"
1738
+ },
1739
+ "results": {
1740
+ "description": "Mapping configuration for the results of this resolver step.",
1741
+ "$ref": "#/definitions/parameterConfigForJson"
1742
+ }
1743
+ },
1744
+ "required": [
1745
+ "name",
1746
+ "service"
1747
+ ],
1748
+ "additionalProperties": false
1749
+ },
1750
+ "takeshapeResolver": {
1751
+ "title": "TakeshapeResolver",
1752
+ "type": "object",
1753
+ "properties": {
1754
+ "if": {
1755
+ "type": "string"
1756
+ },
1757
+ "id": {
1758
+ "type": "string",
1759
+ "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1760
+ },
1761
+ "name": {
1762
+ "title": "TakeshapeResolverName",
1763
+ "type": "string",
1764
+ "description": "Name of the resolver function.",
1765
+ "enum": [
1766
+ "takeshape:getUser",
1767
+ "takeshape:search",
1768
+ "takeshape:vectorSearch",
1769
+ "takeshape:queryApiIndex"
1770
+ ]
1771
+ },
1772
+ "service": {
1773
+ "type": "string",
1774
+ "description": "Internal service identifier.",
1775
+ "enum": [
1776
+ "takeshape"
1777
+ ]
1778
+ },
1779
+ "options": {
1780
+ "title": "TakeshapeResolverOptions",
1781
+ "type": "object",
1782
+ "additionalProperties": true
1783
+ },
1784
+ "shapeName": {
1785
+ "description": "An optional Shape name for the resolver.",
1786
+ "type": "string",
1787
+ "minLength": 1
1788
+ },
1789
+ "args": {
1790
+ "description": "Mapping and serialization configuration for args.",
1791
+ "$ref": "#/definitions/parameterConfigForJson"
1792
+ },
1793
+ "results": {
1794
+ "description": "Mapping configuration for the results of this resolver step.",
1795
+ "$ref": "#/definitions/parameterConfigForJson"
1796
+ },
1797
+ "argsMapping": {
1798
+ "$ref": "#/definitions/argsMapping"
1799
+ },
1800
+ "resultsMapping": {
1801
+ "$ref": "#/definitions/resultsMapping"
1802
+ }
1803
+ },
1804
+ "required": [
1805
+ "name",
1806
+ "service"
1807
+ ],
1808
+ "additionalProperties": false
1809
+ },
1810
+ "graphqlResolver": {
1811
+ "title": "GraphqlResolver",
1812
+ "type": "object",
1813
+ "properties": {
1814
+ "if": {
1815
+ "type": "string"
1816
+ },
1817
+ "id": {
1818
+ "type": "string",
1819
+ "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1820
+ },
1821
+ "name": {
1822
+ "title": "GraphqlResolverName",
1823
+ "type": "string",
1824
+ "description": "Name of the resolver function.",
1825
+ "enum": [
1826
+ "graphql:query",
1827
+ "graphql:mutation",
1828
+ "shopify:bulkQuery"
1829
+ ]
1830
+ },
1831
+ "service": {
1832
+ "type": "string",
1833
+ "description": "Configuration for a service to use with this resolver."
1834
+ },
1835
+ "argsMapping": {
1836
+ "$ref": "#/definitions/argsMapping"
1837
+ },
1838
+ "resultsMapping": {
1839
+ "$ref": "#/definitions/resultsMapping"
1840
+ },
1841
+ "options": {
1842
+ "title": "GraphqlResolverOptions",
1843
+ "type": "object",
1844
+ "properties": {
1845
+ "selectionSet": {
1846
+ "type": "string"
1847
+ },
1848
+ "unboxParentSelectionSet": {
1849
+ "type": "boolean"
1850
+ },
1851
+ "ignoreErrors": {
1852
+ "type": "boolean"
1853
+ },
1854
+ "skipWhenMissingArgs": {
1855
+ "type": "boolean"
1856
+ },
1857
+ "ttl": {
1858
+ "type": "number"
1859
+ },
1860
+ "timeout": {
1861
+ "type": "number"
1862
+ },
1863
+ "allowStream": {
1864
+ "type": "boolean"
1865
+ },
1866
+ "retry": {
1867
+ "oneOf": [
1868
+ {
1869
+ "type": "number"
1870
+ },
1871
+ {
1872
+ "type": "object"
1873
+ }
1874
+ ]
1875
+ }
1876
+ },
1877
+ "additionalProperties": true
1878
+ },
1879
+ "fieldName": {
1880
+ "description": "A fieldname to use in queries.",
1881
+ "type": "string"
1882
+ },
1883
+ "headers": {
1884
+ "description": "Mapping and serialization configuration for headers.",
1885
+ "$ref": "#/definitions/parameterConfigForHeaders"
1886
+ },
1887
+ "searchParams": {
1888
+ "description": "Mapping and serialization configuration for searchParams.",
1889
+ "$ref": "#/definitions/parameterConfigForSearchParams"
1890
+ },
1891
+ "args": {
1892
+ "description": "Mapping and serialization configuration for args.",
1893
+ "$ref": "#/definitions/parameterConfigForJson"
1894
+ },
1895
+ "results": {
1896
+ "description": "Mapping configuration for the results of this resolver step.",
1897
+ "$ref": "#/definitions/parameterConfigForJson"
1898
+ }
1899
+ },
1900
+ "required": [
1901
+ "name",
1902
+ "service",
1903
+ "fieldName"
1904
+ ],
1905
+ "additionalProperties": false
1906
+ },
1907
+ "restResolver": {
1908
+ "title": "RestResolver",
1909
+ "type": "object",
1910
+ "properties": {
1911
+ "if": {
1912
+ "type": "string"
1913
+ },
1914
+ "id": {
1915
+ "type": "string",
1916
+ "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1917
+ },
1918
+ "name": {
1919
+ "title": "RestResolverName",
1920
+ "type": "string",
1921
+ "description": "Name of the resolver function.",
1922
+ "enum": [
1923
+ "rest:get",
1924
+ "rest:head",
1925
+ "rest:post",
1926
+ "rest:put",
1927
+ "rest:patch",
1928
+ "rest:delete"
1929
+ ]
1930
+ },
1931
+ "service": {
1932
+ "type": "string",
1933
+ "description": "Configuration for a service to use with this resolver."
1934
+ },
1935
+ "argsMapping": {
1936
+ "$ref": "#/definitions/argsMapping"
1937
+ },
1938
+ "searchParamsMapping": {
1939
+ "$ref": "#/definitions/searchParamsMapping"
1940
+ },
1941
+ "resultsMapping": {
1942
+ "$ref": "#/definitions/resultsMapping"
1943
+ },
1944
+ "options": {
1945
+ "title": "RestResolverOptions",
1946
+ "type": "object",
1947
+ "properties": {
1948
+ "trailingSlash": {
1949
+ "type": "boolean"
1950
+ },
1951
+ "allowStream": {
1952
+ "type": "boolean"
1953
+ },
1954
+ "ttl": {
1955
+ "type": "number"
1956
+ },
1957
+ "timeout": {
1958
+ "type": "number"
1959
+ },
1960
+ "retry": {
1961
+ "oneOf": [
1962
+ {
1963
+ "type": "number"
1964
+ },
1965
+ {
1966
+ "type": "object"
1967
+ }
1968
+ ]
1969
+ }
1970
+ },
1971
+ "additionalProperties": true
1972
+ },
1973
+ "body": {
1974
+ "description": "Mapping and serialization configuration for a request body.",
1975
+ "$ref": "#/definitions/parameterConfigForBody"
1976
+ },
1977
+ "form": {
1978
+ "description": "Mapping and serialization configuration for form data.",
1979
+ "$ref": "#/definitions/parameterConfigForSearchParams"
1980
+ },
1981
+ "headers": {
1982
+ "description": "Mapping and serialization configuration for headers.",
1983
+ "$ref": "#/definitions/parameterConfigForHeaders"
1984
+ },
1985
+ "json": {
1986
+ "description": "Mapping and serialization configuration for a json request body.",
1987
+ "$ref": "#/definitions/parameterConfigForJson"
1988
+ },
1989
+ "path": {
1990
+ "description": "Mapping and serialization configuration for the path, or a simple string.",
1991
+ "oneOf": [
1992
+ {
1993
+ "$ref": "#/definitions/parameterConfigForPathParams"
1994
+ },
1995
+ {
1996
+ "type": "string"
1997
+ }
1998
+ ]
1999
+ },
2000
+ "searchParams": {
2001
+ "description": "Mapping and serialization configuration for searchParams.",
2002
+ "$ref": "#/definitions/parameterConfigForSearchParams"
2003
+ },
2004
+ "args": {
2005
+ "description": "Mapping and serialization configuration for args.",
2006
+ "$ref": "#/definitions/parameterConfigForJson"
2007
+ },
2008
+ "results": {
2009
+ "description": "Mapping configuration for the results of this resolver step.",
2010
+ "$ref": "#/definitions/parameterConfigForJson"
2011
+ }
2012
+ },
2013
+ "required": [
2014
+ "name",
2015
+ "service",
2016
+ "path"
2017
+ ],
2018
+ "additionalProperties": false
2019
+ },
2020
+ "awsLambdaResolver": {
2021
+ "title": "AwsLambdaResolver",
2022
+ "type": "object",
2023
+ "properties": {
2024
+ "if": {
2025
+ "type": "string"
2026
+ },
2027
+ "id": {
2028
+ "type": "string",
2029
+ "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
2030
+ },
2031
+ "name": {
2032
+ "title": "AwsLambdaResolverName",
2033
+ "type": "string",
2034
+ "description": "Name of the resolver function.",
2035
+ "enum": [
2036
+ "awsLambda:invoke"
2037
+ ]
2038
+ },
2039
+ "service": {
2040
+ "type": "string",
2041
+ "description": "Configuration for a service to use with this resolver."
2042
+ },
2043
+ "options": {
2044
+ "title": "AwsLambdaResolverOptions",
2045
+ "type": "object",
2046
+ "additionalProperties": true
2047
+ },
2048
+ "payload": {
2049
+ "description": "Mapping configuration the Payload.",
2050
+ "$ref": "#/definitions/parameterConfigForJson"
2051
+ },
2052
+ "functionName": {
2053
+ "description": "Mapping configuration for the FunctionName.",
2054
+ "oneOf": [
2055
+ {
2056
+ "type": "string"
2057
+ },
2058
+ {
2059
+ "$ref": "#/definitions/parameterConfigForAwsLambda"
2060
+ }
2061
+ ]
2062
+ },
2063
+ "clientContext": {
2064
+ "description": "Mapping configuration for the ClientContext.",
2065
+ "$ref": "#/definitions/parameterConfigForJson"
2066
+ },
2067
+ "args": {
2068
+ "description": "Mapping and serialization configuration for args.",
2069
+ "$ref": "#/definitions/parameterConfigForJson"
2070
+ },
2071
+ "results": {
2072
+ "description": "Mapping configuration for the results of this resolver step.",
2073
+ "$ref": "#/definitions/parameterConfigForJson"
2074
+ },
2075
+ "argsMapping": {
2076
+ "$ref": "#/definitions/argsMapping"
2077
+ },
2078
+ "searchParamsMapping": {
2079
+ "description": "Set or evaluate directives to generate searchParams for the service endpoint.",
2080
+ "$ref": "#/definitions/searchParamsMapping"
2081
+ },
2082
+ "resultsMapping": {
2083
+ "$ref": "#/definitions/resultsMapping"
2084
+ }
2085
+ },
2086
+ "required": [
2087
+ "name",
2088
+ "service",
2089
+ "functionName"
2090
+ ],
2091
+ "additionalProperties": false
2092
+ },
2093
+ "composeResolver": {
2094
+ "title": "ComposeResolver",
2095
+ "type": "object",
2096
+ "properties": {
2097
+ "compose": {
2098
+ "type": "array",
2099
+ "items": {
2100
+ "$ref": "#/definitions/basicResolver"
2101
+ }
2102
+ },
2103
+ "resultsMapping": {
2104
+ "oneOf": [
2105
+ {
2106
+ "$ref": "#/definitions/directiveMappingMap"
2107
+ },
2108
+ {
2109
+ "$ref": "#/definitions/directiveConfig"
2110
+ }
2111
+ ]
2112
+ },
2113
+ "results": {
2114
+ "description": "Mapping configuration for final query results.",
2115
+ "$ref": "#/definitions/parameterConfigForJson"
2116
+ }
2117
+ },
2118
+ "required": [
2119
+ "compose"
2120
+ ],
2121
+ "additionalProperties": false
2122
+ },
2123
+ "resolver": {
2124
+ "title": "Resolver",
2125
+ "oneOf": [
2126
+ {
2127
+ "$ref": "#/definitions/basicResolver"
2128
+ },
2129
+ {
2130
+ "$ref": "#/definitions/composeResolver"
2131
+ }
2132
+ ]
2133
+ },
2134
+ "dependencies": {
2135
+ "title": "Dependencies",
2136
+ "type": "string"
2137
+ },
2138
+ "ref": {
2139
+ "title": "Ref",
2140
+ "type": "string"
2141
+ },
2142
+ "indexed": {
2143
+ "title": "Indexed",
2144
+ "type": "object",
2145
+ "properties": {
2146
+ "nested": {
2147
+ "type": "boolean"
2148
+ }
2149
+ },
2150
+ "additionalProperties": false
2151
+ },
2152
+ "graphql": {
2153
+ "title": "GraphQLConfig",
2154
+ "type": "object",
2155
+ "properties": {
2156
+ "json": {
2157
+ "type": "boolean"
2158
+ }
2159
+ },
2160
+ "additionalProperties": false
2161
+ },
2162
+ "query": {
2163
+ "title": "Query JSON",
2164
+ "type": "object",
2165
+ "properties": {
2166
+ "args": {
2167
+ "description": "The args field specifies the name of a Shape for the input arguments required by your resolver.",
2168
+ "$ref": "#/definitions/args"
2169
+ },
2170
+ "resolver": {
2171
+ "description": "Configures the resolver for your query or mutation.",
2172
+ "$ref": "#/definitions/resolver"
2173
+ },
2174
+ "shape": {
2175
+ "$ref": "#/definitions/returnShape",
2176
+ "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."
2177
+ },
2178
+ "description": {
2179
+ "type": "string",
2180
+ "description": "Provides more detail about what the query or mutation is for. This will be displayed in the automatically-generated GraphQL API docs."
2181
+ }
2182
+ },
2183
+ "required": [
2184
+ "resolver",
2185
+ "shape"
2186
+ ],
2187
+ "additionalProperties": false
2188
+ },
2189
+ "propertySchema": {
2190
+ "title": "PropertySchema",
2191
+ "type": "object",
2192
+ "properties": {
2193
+ "$ref": {
2194
+ "type": "string",
2195
+ "format": "uri-reference"
2196
+ },
2197
+ "title": {
2198
+ "type": "string"
2199
+ },
2200
+ "description": {
2201
+ "type": "string"
2202
+ },
2203
+ "default": {},
2204
+ "readOnly": {
2205
+ "type": "boolean",
2206
+ "default": false
2207
+ },
2208
+ "multipleOf": {
2209
+ "type": "number",
2210
+ "exclusiveMinimum": 0
2211
+ },
2212
+ "maximum": {
2213
+ "type": "number"
2214
+ },
2215
+ "exclusiveMaximum": {
2216
+ "type": "number"
2217
+ },
2218
+ "minimum": {
2219
+ "type": "number"
2220
+ },
2221
+ "exclusiveMinimum": {
2222
+ "type": "number"
2223
+ },
2224
+ "maxLength": {
2225
+ "$ref": "#/definitions/nonNegativeInteger"
2226
+ },
2227
+ "minLength": {
2228
+ "$ref": "#/definitions/nonNegativeIntegerDefault0"
2229
+ },
2230
+ "pattern": {
2231
+ "type": "string",
2232
+ "format": "regex"
2233
+ },
2234
+ "additionalItems": {
2235
+ "$ref": "#/definitions/propertySchema"
2236
+ },
2237
+ "items": {
2238
+ "$ref": "#/definitions/propertySchema"
2239
+ },
2240
+ "maxItems": {
2241
+ "$ref": "#/definitions/nonNegativeInteger"
2242
+ },
2243
+ "minItems": {
2244
+ "$ref": "#/definitions/nonNegativeIntegerDefault0"
2245
+ },
2246
+ "uniqueItems": {
2247
+ "type": "boolean",
2248
+ "default": false
2249
+ },
2250
+ "contains": {
2251
+ "$ref": "#/definitions/propertySchema"
2252
+ },
2253
+ "maxProperties": {
2254
+ "$ref": "#/definitions/nonNegativeInteger"
2255
+ },
2256
+ "minProperties": {
2257
+ "$ref": "#/definitions/nonNegativeIntegerDefault0"
2258
+ },
2259
+ "required": {
2260
+ "$ref": "#/definitions/stringArray"
2261
+ },
2262
+ "additionalProperties": {
2263
+ "oneOf": [
2264
+ {
2265
+ "$ref": "#/definitions/propertySchema"
2266
+ },
2267
+ {
2268
+ "enum": [
2269
+ false
2270
+ ]
2271
+ }
2272
+ ]
2273
+ },
2274
+ "definitions": {
2275
+ "type": "object",
2276
+ "additionalProperties": {
2277
+ "$ref": "#/definitions/propertySchema"
2278
+ },
2279
+ "default": {}
2280
+ },
2281
+ "properties": {
2282
+ "type": "object",
2283
+ "additionalProperties": {
2284
+ "$ref": "#/definitions/propertySchema"
2285
+ },
2286
+ "default": {}
2287
+ },
2288
+ "const": {},
2289
+ "enum": {
2290
+ "type": "array",
2291
+ "minItems": 1,
2292
+ "uniqueItems": true
2293
+ },
2294
+ "type": {
2295
+ "anyOf": [
2296
+ {
2297
+ "$ref": "#/definitions/simpleTypes"
2298
+ },
2299
+ {
2300
+ "type": "array",
2301
+ "items": {
2302
+ "$ref": "#/definitions/simpleTypes"
2303
+ },
2304
+ "minItems": 1,
2305
+ "uniqueItems": true
2306
+ }
2307
+ ]
2308
+ },
2309
+ "format": {
2310
+ "type": "string"
2311
+ },
2312
+ "contentMediaType": {
2313
+ "type": "string"
2314
+ },
2315
+ "contentEncoding": {
2316
+ "type": "string"
2317
+ },
2318
+ "allOf": {
2319
+ "$ref": "#/definitions/schemaArray"
2320
+ },
2321
+ "discriminator": {
2322
+ "type": "object",
2323
+ "properties": {
2324
+ "propertyName": {
2325
+ "type": "string"
2326
+ }
2327
+ }
2328
+ },
2329
+ "oneOf": {
2330
+ "$ref": "#/definitions/schemaArray"
2331
+ },
2332
+ "extends": {
2333
+ "$ref": "#/definitions/objectOrRefArray"
2334
+ },
2335
+ "@backreference": {
2336
+ "$ref": "#/definitions/backreference"
2337
+ },
2338
+ "@input": {
2339
+ "description": "A PropertySchema providing an alternative shape for a GraphQL input type.",
2340
+ "$ref": "#/definitions/propertySchema"
2341
+ },
2342
+ "@output": {
2343
+ "description": "A PropertySchema which is original output.",
2344
+ "$ref": "#/definitions/propertySchema"
2345
+ },
2346
+ "@syncLocaleStructure": {
2347
+ "type": "boolean"
2348
+ },
2349
+ "@sensitive": {
2350
+ "type": "boolean"
2351
+ },
2352
+ "@draftjs": {
2353
+ "type": "boolean"
2354
+ },
2355
+ "@l10n": {
2356
+ "type": "boolean"
2357
+ },
2358
+ "@key": {
2359
+ "type": "string",
2360
+ "pattern": "^[-_a-zA-Z0-9]+$"
2361
+ },
2362
+ "@workflow": {
2363
+ "type": "string"
2364
+ },
2365
+ "@mapping": {
2366
+ "$ref": "#/definitions/fieldMapping"
2367
+ },
2368
+ "@tag": {
2369
+ "type": "string"
2370
+ },
2371
+ "@tags": {
2372
+ "type": "array",
2373
+ "items": {
2374
+ "type": "string"
2375
+ }
2376
+ },
2377
+ "@deprecationReason": {
2378
+ "type": "string"
2379
+ },
2380
+ "@args": {
2381
+ "$ref": "#/definitions/args"
2382
+ },
2383
+ "@resolver": {
2384
+ "$ref": "#/definitions/resolver"
2385
+ },
2386
+ "@dependencies": {
2387
+ "$ref": "#/definitions/dependencies"
2388
+ },
2389
+ "@ref": {
2390
+ "$ref": "#/definitions/ref"
2391
+ },
2392
+ "@derivedFrom": {
2393
+ "type": "string"
2394
+ },
2395
+ "@indexed": {
2396
+ "$ref": "#/definitions/indexed"
2397
+ },
2398
+ "@graphql": {
2399
+ "$ref": "#/definitions/graphql"
2400
+ }
2401
+ },
2402
+ "additionalProperties": false
2403
+ },
2404
+ "shape": {
2405
+ "title": "Shape JSON",
2406
+ "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",
2407
+ "type": "object",
2408
+ "properties": {
2409
+ "name": {
2410
+ "type": "string",
2411
+ "pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$",
2412
+ "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"
2413
+ },
2414
+ "id": {
2415
+ "type": "string",
2416
+ "pattern": "[0-9A-Za-z_-]+",
2417
+ "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."
2418
+ },
2419
+ "title": {
2420
+ "type": "string",
2421
+ "description": "The human-readable name for a Shape for use in a UI."
2422
+ },
2423
+ "description": {
2424
+ "type": "string"
2425
+ },
2426
+ "type": {
2427
+ "enum": [
2428
+ "interface",
2429
+ "input",
2430
+ "output"
2431
+ ]
2432
+ },
2433
+ "interfaces": {
2434
+ "type": "array",
2435
+ "items": {
2436
+ "type": "string"
2437
+ }
2438
+ },
2439
+ "model": {
2440
+ "description": "Specifying a model type allows Shape data to be stored in TakeShape's built-in database",
2441
+ "type": "object",
2442
+ "properties": {
2443
+ "type": {
2444
+ "title": "Model Type",
2445
+ "type": "string",
2446
+ "enum": [
2447
+ "single",
2448
+ "multiple",
2449
+ "taxonomy"
2450
+ ]
2451
+ }
2452
+ },
2453
+ "required": [
2454
+ "type"
2455
+ ],
2456
+ "additionalProperties": false
2457
+ },
2458
+ "workflow": {
2459
+ "type": "string"
2460
+ },
2461
+ "loaders": {
2462
+ "$ref": "#/definitions/shapeLoaders"
2463
+ },
2464
+ "joins": {
2465
+ "$ref": "#/definitions/shapeJoins"
2466
+ },
2467
+ "cache": {
2468
+ "$ref": "#/definitions/shapeCacheConfig"
2469
+ },
2470
+ "schema": {
2471
+ "$ref": "#/definitions/shapeSchema"
2472
+ }
2473
+ },
2474
+ "required": [
2475
+ "name",
2476
+ "title",
2477
+ "id",
2478
+ "schema"
2479
+ ],
2480
+ "additionalProperties": false
2481
+ },
2482
+ "shapeWithObjectSchema": {
2483
+ "title": "Shape With Object Schema",
2484
+ "type": "object",
2485
+ "allOf": [
2486
+ {
2487
+ "$ref": "#/definitions/shape"
2488
+ },
2489
+ {
2490
+ "type": "object",
2491
+ "properties": {
2492
+ "schema": {
2493
+ "$ref": "#/definitions/objectSchema"
2494
+ }
2495
+ },
2496
+ "required": [
2497
+ "schema"
2498
+ ],
2499
+ "additionalProperties": false
2500
+ }
2501
+ ]
2502
+ },
2503
+ "shapeMap": {
2504
+ "title": "Shape Map",
2505
+ "type": "object",
2506
+ "patternProperties": {
2507
+ "^[0-9A-Za-z_]+$": {
2508
+ "$ref": "#/definitions/shape"
2509
+ }
2510
+ },
2511
+ "additionalProperties": false
2512
+ },
2513
+ "formMap": {
2514
+ "title": "Form Map",
2515
+ "type": "object",
2516
+ "patternProperties": {
2517
+ "[0-9A-Za-z_-]+": {
2518
+ "$ref": "#/definitions/formsConfig"
2519
+ }
2520
+ }
2521
+ },
2522
+ "shapeCacheConfig": {
2523
+ "title": "ShapeCacheConfig",
2524
+ "type": "object",
2525
+ "properties": {
2526
+ "enabled": {
2527
+ "type": "boolean"
2528
+ },
2529
+ "idField": {
2530
+ "type": "string"
2531
+ },
2532
+ "searchSummaryField": {
2533
+ "type": "string"
2534
+ },
2535
+ "fragment": {
2536
+ "$ref": "#/definitions/cachedFragmentConfig"
2537
+ },
2538
+ "triggers": {
2539
+ "type": "array",
2540
+ "items": {
2541
+ "$ref": "#/definitions/cacheTriggerConfig"
2542
+ }
2543
+ },
2544
+ "maxAge": {
2545
+ "description": "Number of seconds this Shape should be cached. Default 0.",
2546
+ "type": "number",
2547
+ "minimum": 0
2548
+ }
2549
+ },
2550
+ "additionalProperties": false,
2551
+ "required": [
2552
+ "enabled"
2553
+ ]
2554
+ },
2555
+ "shapeJoin": {
2556
+ "title": "ShapeJoin",
2557
+ "type": "object",
2558
+ "properties": {
2559
+ "resolver": {
2560
+ "oneOf": [
2561
+ {
2562
+ "$ref": "#/definitions/delegateResolver"
2563
+ },
2564
+ {
2565
+ "$ref": "#/definitions/shapedbResolver"
2566
+ }
2567
+ ]
2568
+ },
2569
+ "dependencies": {
2570
+ "type": "string"
2571
+ }
2572
+ },
2573
+ "required": [
2574
+ "resolver"
2575
+ ],
2576
+ "additionalProperties": false
2577
+ },
2578
+ "shapeJoins": {
2579
+ "title": "ShapeJoins",
2580
+ "type": "object",
2581
+ "patternProperties": {
2582
+ "[:0-9A-Za-z_-]+": {
2583
+ "$ref": "#/definitions/shapeJoin"
2584
+ }
2585
+ }
2586
+ },
2587
+ "shapeLoaders": {
2588
+ "title": "ShapeLoaders",
2589
+ "type": "object",
2590
+ "properties": {
2591
+ "list": {
2592
+ "oneOf": [
2593
+ {
2594
+ "$ref": "#/definitions/storedListQueryLoaderConfig"
2595
+ },
2596
+ {
2597
+ "type": "array",
2598
+ "items": {
2599
+ "$ref": "#/definitions/storedListQueryLoaderConfig"
2600
+ }
2601
+ }
2602
+ ]
2603
+ },
2604
+ "get": {
2605
+ "$ref": "#/definitions/getQueryLoaderConfig"
2606
+ }
2607
+ },
2608
+ "additionalProperties": false,
2609
+ "required": [
2610
+ "list"
2611
+ ]
2612
+ },
2613
+ "cachedFragmentConfig": {
2614
+ "title": "Cached Fragment Config",
2615
+ "type": "object",
2616
+ "properties": {
2617
+ "ignoreFields": {
2618
+ "type": "array",
2619
+ "items": {
2620
+ "type": "string"
2621
+ }
2622
+ },
2623
+ "maxDepth": {
2624
+ "type": "number"
2625
+ },
2626
+ "selectionSet": {
2627
+ "type": "string"
2628
+ },
2629
+ "includeDeprecated": {
2630
+ "type": "boolean"
2631
+ }
2632
+ },
2633
+ "additionalProperties": false
2634
+ },
2635
+ "listQueryLoaderConfig": {
2636
+ "title": "ListQueryLoaderConfig",
2637
+ "type": "object",
2638
+ "properties": {
2639
+ "query": {
2640
+ "type": "string"
2641
+ },
2642
+ "args": {
2643
+ "type": "object",
2644
+ "additionalProperties": true
2645
+ },
2646
+ "pagination": {
2647
+ "$ref": "#/definitions/paginationConfig"
2648
+ }
2649
+ },
2650
+ "additionalProperties": false,
2651
+ "required": [
2652
+ "query"
2653
+ ]
2654
+ },
2655
+ "storedListQueryLoaderConfig": {
2656
+ "title": "StoredListQueryLoaderConfig",
2657
+ "type": "object",
2658
+ "properties": {
2659
+ "query": {
2660
+ "type": "string"
2661
+ },
2662
+ "args": {
2663
+ "oneOf": [
2664
+ {
2665
+ "type": "object",
2666
+ "additionalProperties": true
2667
+ },
2668
+ {
2669
+ "type": "array",
2670
+ "items": {
2671
+ "type": "object",
2672
+ "additionalProperties": true
2673
+ }
2674
+ }
2675
+ ]
2676
+ },
2677
+ "pagination": {
2678
+ "$ref": "#/definitions/paginationConfig"
2679
+ }
2680
+ },
2681
+ "additionalProperties": false,
2682
+ "required": [
2683
+ "query"
2684
+ ]
2685
+ },
2686
+ "getQueryLoaderConfig": {
2687
+ "title": "GetQueryLoaderConfig",
2688
+ "type": "object",
2689
+ "properties": {
2690
+ "query": {
2691
+ "type": "string"
2692
+ },
2693
+ "args": {
2694
+ "type": "object",
2695
+ "additionalProperties": true
2696
+ },
2697
+ "idArg": {
2698
+ "type": "string"
2699
+ }
2700
+ },
2701
+ "additionalProperties": false,
2702
+ "required": [
2703
+ "query"
2704
+ ]
2705
+ },
2706
+ "paginationConfig": {
2707
+ "title": "Pagination Config",
2708
+ "oneOf": [
2709
+ {
2710
+ "$ref": "#/definitions/paginationCursorConfig"
2711
+ },
2712
+ {
2713
+ "$ref": "#/definitions/paginationPageConfig"
2714
+ },
2715
+ {
2716
+ "$ref": "#/definitions/paginationOffsetConfig"
2717
+ }
2718
+ ]
2719
+ },
2720
+ "paginationCursorConfig": {
2721
+ "title": "Pagination Cursor Config",
2722
+ "type": "object",
2723
+ "properties": {
2724
+ "type": {
2725
+ "type": "string",
2726
+ "enum": [
2727
+ "cursor"
2728
+ ]
2729
+ },
2730
+ "cursorArg": {
2731
+ "type": "string"
2732
+ },
2733
+ "cursorPath": {
2734
+ "type": "string"
2735
+ },
2736
+ "pageSize": {
2737
+ "type": "number"
2738
+ },
2739
+ "pageSizeArg": {
2740
+ "type": "string"
2741
+ },
2742
+ "hasMorePath": {
2743
+ "type": "string"
2744
+ },
2745
+ "itemsPath": {
2746
+ "type": "string"
2747
+ }
2748
+ },
2749
+ "additionalProperties": false,
2750
+ "required": [
2751
+ "type",
2752
+ "cursorArg",
2753
+ "cursorPath",
2754
+ "pageSizeArg",
2755
+ "hasMorePath",
2756
+ "itemsPath"
2757
+ ]
2758
+ },
2759
+ "paginationPageConfig": {
2760
+ "title": "Pagination Page Config",
2761
+ "type": "object",
2762
+ "properties": {
2763
+ "type": {
2764
+ "type": "string",
2765
+ "enum": [
2766
+ "page"
2767
+ ]
2768
+ },
2769
+ "pageArg": {
2770
+ "type": "string"
2771
+ },
2772
+ "pageSize": {
2773
+ "type": "number"
2774
+ },
2775
+ "pageSizeArg": {
2776
+ "type": "string"
2777
+ },
2778
+ "itemsPath": {
2779
+ "type": "string"
2780
+ },
2781
+ "pageTotalPath": {
2782
+ "type": "string"
2783
+ }
2784
+ },
2785
+ "additionalProperties": false,
2786
+ "required": [
2787
+ "type",
2788
+ "pageArg",
2789
+ "itemsPath",
2790
+ "pageTotalPath"
2791
+ ]
2792
+ },
2793
+ "paginationOffsetConfig": {
2794
+ "title": "Pagination Offset Config",
2795
+ "type": "object",
2796
+ "properties": {
2797
+ "type": {
2798
+ "type": "string",
2799
+ "enum": [
2800
+ "offset"
2801
+ ]
2802
+ },
2803
+ "offsetArg": {
2804
+ "type": "string"
2805
+ },
2806
+ "pageSize": {
2807
+ "type": "number"
2808
+ },
2809
+ "pageSizeArg": {
2810
+ "type": "string"
2811
+ },
2812
+ "itemsPath": {
2813
+ "type": "string"
2814
+ },
2815
+ "itemTotalPath": {
2816
+ "type": "string"
2817
+ }
2818
+ },
2819
+ "additionalProperties": false,
2820
+ "required": [
2821
+ "type",
2822
+ "offsetArg",
2823
+ "itemsPath",
2824
+ "itemTotalPath"
2825
+ ]
2826
+ },
2827
+ "cacheTriggerConfig": {
2828
+ "title": "CacheTriggerConfig",
2829
+ "oneOf": [
2830
+ {
2831
+ "$ref": "#/definitions/cacheScheduleTriggerConfig"
2832
+ },
2833
+ {
2834
+ "$ref": "#/definitions/cacheWebhookTriggerConfig"
2835
+ }
2836
+ ]
2837
+ },
2838
+ "cacheScheduleTriggerConfig": {
2839
+ "title": "CacheScheduleTriggerConfig",
2840
+ "type": "object",
2841
+ "properties": {
2842
+ "type": {
2843
+ "type": "string",
2844
+ "enum": [
2845
+ "schedule"
2846
+ ]
2847
+ },
2848
+ "loader": {
2849
+ "enum": [
2850
+ "get",
2851
+ "list"
2852
+ ]
2853
+ },
2854
+ "interval": {
2855
+ "type": "number"
2856
+ }
2857
+ },
2858
+ "additionalProperties": false,
2859
+ "required": [
2860
+ "type",
2861
+ "loader",
2862
+ "interval"
2863
+ ]
2864
+ },
2865
+ "cacheWebhookTriggerConfig": {
2866
+ "title": "CacheWebhookTriggerConfig",
2867
+ "type": "object",
2868
+ "properties": {
2869
+ "type": {
2870
+ "type": "string",
2871
+ "enum": [
2872
+ "webhook"
2873
+ ]
2874
+ },
2875
+ "loader": {
2876
+ "enum": [
2877
+ "get",
2878
+ "list"
2879
+ ]
2880
+ },
2881
+ "service": {
2882
+ "type": "string"
2883
+ },
2884
+ "events": {
2885
+ "type": "array",
2886
+ "items": {
2887
+ "type": "string"
2888
+ }
2889
+ }
2890
+ },
2891
+ "additionalProperties": false,
2892
+ "required": [
2893
+ "type",
2894
+ "loader",
2895
+ "service",
2896
+ "events"
2897
+ ]
2898
+ },
2899
+ "formScalarConfig": {
2900
+ "title": "Form Scalar Config",
2901
+ "type": "object",
2902
+ "properties": {
2903
+ "widget": {
2904
+ "type": "string"
2905
+ }
2906
+ },
2907
+ "additionalProperties": false,
2908
+ "required": [
2909
+ "widget"
2910
+ ]
2911
+ },
2912
+ "formObjectConfig": {
2913
+ "title": "Form Object Config",
2914
+ "type": "object",
2915
+ "properties": {
2916
+ "widget": {
2917
+ "type": "string"
2918
+ },
2919
+ "order": {
2920
+ "type": "array",
2921
+ "items": {
2922
+ "type": "string"
2923
+ }
2924
+ },
2925
+ "properties": {
2926
+ "patternProperties": {
2927
+ "[0-9A-Za-z_-]+": {
2928
+ "$ref": "#/definitions/formConfig"
2929
+ }
2930
+ }
2931
+ }
2932
+ },
2933
+ "additionalProperties": false
2934
+ },
2935
+ "formArrayConfig": {
2936
+ "title": "Form Array Config",
2937
+ "type": "object",
2938
+ "properties": {
2939
+ "widget": {
2940
+ "type": "string"
2941
+ },
2942
+ "items": {
2943
+ "$ref": "#/definitions/formConfig"
2944
+ }
2945
+ },
2946
+ "additionalProperties": false,
2947
+ "required": [
2948
+ "widget",
2949
+ "items"
2950
+ ]
2951
+ },
2952
+ "customAuthentication": {
2953
+ "title": "Custom Authentication",
2954
+ "description": "For use with a custom auth handler on a service provider.",
2955
+ "type": "object",
2956
+ "properties": {
2957
+ "type": {
2958
+ "type": "string",
2959
+ "enum": [
2960
+ "custom"
2961
+ ]
2962
+ }
2963
+ },
2964
+ "additionalProperties": true,
2965
+ "required": [
2966
+ "type"
2967
+ ]
2968
+ },
2969
+ "searchParamsAuthentication": {
2970
+ "title": "Search Params Authentication",
2971
+ "type": "object",
2972
+ "properties": {
2973
+ "type": {
2974
+ "type": "string",
2975
+ "enum": [
2976
+ "searchParams"
2977
+ ]
2978
+ },
2979
+ "params": {
2980
+ "type": "array",
2981
+ "items": {
2982
+ "properties": {
2983
+ "name": {
2984
+ "type": "string"
2985
+ },
2986
+ "value": {
2987
+ "type": "string"
2988
+ }
2989
+ },
2990
+ "required": [
2991
+ "name",
2992
+ "value"
2993
+ ],
2994
+ "additionalProperties": false
2995
+ }
2996
+ }
2997
+ },
2998
+ "additionalProperties": false,
2999
+ "required": [
3000
+ "type",
3001
+ "params"
3002
+ ]
3003
+ },
3004
+ "bearerAuthentication": {
3005
+ "title": "Bearer Authentication",
3006
+ "type": "object",
3007
+ "properties": {
3008
+ "type": {
3009
+ "type": "string",
3010
+ "enum": [
3011
+ "bearer"
3012
+ ]
3013
+ },
3014
+ "token": {
3015
+ "type": "string"
3016
+ },
3017
+ "prefix": {
3018
+ "type": "string"
3019
+ },
3020
+ "header": {
3021
+ "type": "string"
3022
+ }
3023
+ },
3024
+ "additionalProperties": false,
3025
+ "required": [
3026
+ "type",
3027
+ "token"
3028
+ ]
3029
+ },
3030
+ "oauth2BearerAuthentication": {
3031
+ "title": "OAuth 2 Bearer Authentication",
3032
+ "type": "object",
3033
+ "properties": {
3034
+ "type": {
3035
+ "type": "string",
3036
+ "enum": [
3037
+ "oauth2Bearer"
3038
+ ]
3039
+ },
3040
+ "token": {
3041
+ "type": "string"
3042
+ },
3043
+ "prefix": {
3044
+ "type": "string"
3045
+ },
3046
+ "header": {
3047
+ "type": "string"
3048
+ },
3049
+ "scope": {
3050
+ "type": "string"
3051
+ },
3052
+ "expiresAt": {
3053
+ "type": "string"
3054
+ }
3055
+ },
3056
+ "additionalProperties": false,
3057
+ "required": [
3058
+ "type",
3059
+ "token"
3060
+ ]
3061
+ },
3062
+ "basicAuthentication": {
3063
+ "title": "Basic Authentication",
3064
+ "type": "object",
3065
+ "properties": {
3066
+ "type": {
3067
+ "type": "string",
3068
+ "enum": [
3069
+ "basic"
3070
+ ]
3071
+ },
3072
+ "username": {
3073
+ "type": "string"
3074
+ },
3075
+ "password": {
3076
+ "type": "string"
3077
+ },
3078
+ "useIso8859": {
3079
+ "type": "boolean"
3080
+ }
3081
+ },
3082
+ "additionalProperties": false,
3083
+ "required": [
3084
+ "type",
3085
+ "username",
3086
+ "password"
3087
+ ]
3088
+ },
3089
+ "oauth2Authentication": {
3090
+ "title": "OAuth 2 Authentication",
3091
+ "type": "object",
3092
+ "properties": {
3093
+ "type": {
3094
+ "type": "string",
3095
+ "enum": [
3096
+ "oauth2"
3097
+ ]
3098
+ },
3099
+ "grantType": {
3100
+ "type": "string",
3101
+ "enum": [
3102
+ "authorizationCode",
3103
+ "clientCredentials"
3104
+ ]
3105
+ },
3106
+ "authorizationUrl": {
3107
+ "type": "string"
3108
+ },
3109
+ "accessTokenUrl": {
3110
+ "type": "string"
3111
+ },
3112
+ "clientId": {
3113
+ "type": "string"
3114
+ },
3115
+ "clientSecret": {
3116
+ "type": "string"
3117
+ },
3118
+ "scope": {
3119
+ "type": "string"
3120
+ },
3121
+ "usePkce": {
3122
+ "type": "boolean"
3123
+ },
3124
+ "redirectUrl": {
3125
+ "type": "string"
3126
+ },
3127
+ "headerPrefix": {
3128
+ "type": "string"
3129
+ },
3130
+ "audience": {
3131
+ "type": "string"
3132
+ },
3133
+ "resource": {
3134
+ "type": "string"
3135
+ }
3136
+ },
3137
+ "additionalProperties": false,
3138
+ "required": [
3139
+ "type",
3140
+ "grantType",
3141
+ "clientId"
3142
+ ]
3143
+ },
3144
+ "awsAuthentication": {
3145
+ "title": "AWS Authentication",
3146
+ "type": "object",
3147
+ "properties": {
3148
+ "type": {
3149
+ "type": "string",
3150
+ "enum": [
3151
+ "aws"
3152
+ ]
3153
+ },
3154
+ "awsAccessKeyId": {
3155
+ "type": "string"
3156
+ },
3157
+ "awsSecretAccessKey": {
3158
+ "type": "string"
3159
+ }
3160
+ },
3161
+ "additionalProperties": false,
3162
+ "required": [
3163
+ "type",
3164
+ "awsAccessKeyId",
3165
+ "awsSecretAccessKey"
3166
+ ]
3167
+ },
3168
+ "serviceAuthentication": {
3169
+ "title": "Service Authentication",
3170
+ "oneOf": [
3171
+ {
3172
+ "$ref": "#/definitions/oauth2Authentication"
3173
+ },
3174
+ {
3175
+ "$ref": "#/definitions/oauth2BearerAuthentication"
3176
+ },
3177
+ {
3178
+ "$ref": "#/definitions/bearerAuthentication"
3179
+ },
3180
+ {
3181
+ "$ref": "#/definitions/basicAuthentication"
3182
+ },
3183
+ {
3184
+ "$ref": "#/definitions/searchParamsAuthentication"
3185
+ },
3186
+ {
3187
+ "$ref": "#/definitions/awsAuthentication"
3188
+ },
3189
+ {
3190
+ "$ref": "#/definitions/customAuthentication"
3191
+ }
3192
+ ]
3193
+ },
3194
+ "serviceHealthCheckTrigger": {
3195
+ "title": "Service Health Check Trigger",
3196
+ "enum": ["manual", "schedule"]
3197
+ },
3198
+ "serviceHealthCheck": {
3199
+ "title": "Service Health Check",
3200
+ "description": "Configuration for ping health checks.",
3201
+ "type": "object",
3202
+ "properties": {
3203
+ "checkName": {
3204
+ "title": "Check Name",
3205
+ "description": "The name of a health check to run",
3206
+ "type": "string",
3207
+ "enum": [
3208
+ "graphqlIntrospection",
3209
+ "ping",
3210
+ "none"
3211
+ ]
3212
+ },
3213
+ "endpoint": {
3214
+ "title": "Endpoint",
3215
+ "description": "The endpoint to use when checking the service health.",
3216
+ "type": "string"
3217
+ },
3218
+ "requestMethod": {
3219
+ "title": "Request Method",
3220
+ "description": "A custom method to use for the health check request.",
3221
+ "type": "string",
3222
+ "enum": [
3223
+ "GET",
3224
+ "POST",
3225
+ "PUT",
3226
+ "PATCH",
3227
+ "DELETE"
3228
+ ]
3229
+ },
3230
+ "requestHeaders": {
3231
+ "title": "Request Headers",
3232
+ "description": "Any custom headers to set with the health check request.",
3233
+ "type": "object",
3234
+ "propertyNames": {
3235
+ "pattern": "[0-9A-Za-z_-]+"
3236
+ }
3237
+ },
3238
+ "requestSearchParams": {
3239
+ "title": "Request Search Params",
3240
+ "description": "Any custom search params to set with the health check request.",
3241
+ "type": "object",
3242
+ "propertyNames": {
3243
+ "pattern": "[0-9A-Za-z_-]+"
3244
+ }
3245
+ },
3246
+ "requestBody": {
3247
+ "title": "Request Body",
3248
+ "description": "A custom body to send along with the ping request.",
3249
+ "type": "string"
3250
+ },
3251
+ "requestBodyFormat": {
3252
+ "title": "Request Body Format",
3253
+ "description": "A custom body to send along with the ping request.",
3254
+ "type": "string",
3255
+ "enum": [
3256
+ "string",
3257
+ "form",
3258
+ "json",
3259
+ "form-data"
3260
+ ]
3261
+ },
3262
+ "requestTimeout": {
3263
+ "title": "Request Timeout",
3264
+ "description": "The amount of time to wait when receiving a response from the health check, in seconds.",
3265
+ "type": "number",
3266
+ "minimum": 2,
3267
+ "maximum": 60
3268
+ },
3269
+ "healthyResponseStatusCode": {
3270
+ "title": "Healthy Response Status Code",
3271
+ "description": "The response status code that qualifies as healthy.",
3272
+ "type": "number",
3273
+ "minimum": 200,
3274
+ "maximum": 399
3275
+ },
3276
+ "triggers": {
3277
+ "type": "array",
3278
+ "items": {
3279
+ "$ref": "#/definitions/serviceHealthCheckTrigger"
3280
+ }
3281
+ }
3282
+ },
3283
+ "required": [
3284
+ "checkName"
3285
+ ],
3286
+ "additionalProperties": false
3287
+ },
3288
+ "serviceType": {
3289
+ "title": "Service Type",
3290
+ "description": "The general type of this service, specifying how and where it will be utilized.",
3291
+ "type": "string",
3292
+ "enum": [
3293
+ "deployment",
3294
+ "authentication",
3295
+ "takeshape",
3296
+ "rest",
3297
+ "graphql",
3298
+ "openapi",
3299
+ "aws",
3300
+ "unknown"
3301
+ ]
3302
+ },
3303
+ "serviceConfig": {
3304
+ "title": "Service Config",
3305
+ "type": "object",
3306
+ "properties": {
3307
+ "id": {
3308
+ "type": "string",
3309
+ "description": "Machine-readable identifier, should typically be the same as the property name on the services object."
3310
+ },
3311
+ "title": {
3312
+ "type": "string",
3313
+ "description": "Human-readable name for this service."
3314
+ },
3315
+ "provider": {
3316
+ "description": "The service provider id.",
3317
+ "type": "string"
3318
+ },
3319
+ "namespace": {
3320
+ "type": "string",
3321
+ "description": "A namespace to use for the imported types tied to this service."
3322
+ },
3323
+ "serviceType": {
3324
+ "$ref": "#/definitions/serviceType"
3325
+ },
3326
+ "authenticationType": {
3327
+ "type": "string",
3328
+ "enum": [
3329
+ "oauth2",
3330
+ "basic",
3331
+ "bearer",
3332
+ "searchParams",
3333
+ "oauth2Bearer",
3334
+ "custom",
3335
+ "aws",
3336
+ "none",
3337
+ "unknown"
3338
+ ]
3339
+ },
3340
+ "authentication": {
3341
+ "$ref": "#/definitions/serviceAuthentication"
3342
+ },
3343
+ "healthCheck": {
3344
+ "$ref": "#/definitions/serviceHealthCheck"
3345
+ },
3346
+ "webhookId": {
3347
+ "type": "string"
3348
+ },
3349
+ "options": {
3350
+ "type": "object",
3351
+ "description": "Configuration options passed to and handled by the provider."
3352
+ }
3353
+ },
3354
+ "required": [
3355
+ "id",
3356
+ "title",
3357
+ "provider",
3358
+ "serviceType",
3359
+ "authenticationType"
3360
+ ],
3361
+ "additionalProperties": false
3362
+ },
3363
+ "storedServiceConfig": {
3364
+ "title": "Service Config JSON",
3365
+ "type": "object",
3366
+ "properties": {
3367
+ "id": {
3368
+ "type": "string",
3369
+ "description": "Machine-readable identifier, should typically be the same as the property name on the services object."
3370
+ },
3371
+ "title": {
3372
+ "type": "string",
3373
+ "description": "Human-readable name for this service."
3374
+ },
3375
+ "provider": {
3376
+ "type": "string",
3377
+ "description": "The service provider id."
3378
+ },
3379
+ "namespace": {
3380
+ "type": "string",
3381
+ "description": "A namespace to use for the imported types tied to this service."
3382
+ },
3383
+ "serviceType": {
3384
+ "$ref": "#/definitions/serviceType"
3385
+ },
3386
+ "authenticationType": {
3387
+ "type": "string",
3388
+ "enum": [
3389
+ "oauth2",
3390
+ "basic",
3391
+ "bearer",
3392
+ "searchParams",
3393
+ "oauth2Bearer",
3394
+ "custom",
3395
+ "aws",
3396
+ "none",
3397
+ "unknown"
3398
+ ]
3399
+ },
3400
+ "authentication": {
3401
+ "type": "string"
3402
+ },
3403
+ "healthCheck": {
3404
+ "$ref": "#/definitions/serviceHealthCheck"
3405
+ },
3406
+ "webhookId": {
3407
+ "type": "string"
3408
+ },
3409
+ "options": {
3410
+ "type": "object",
3411
+ "description": "Configuration options passed to and handled by the provider."
3412
+ }
3413
+ },
3414
+ "required": [
3415
+ "id",
3416
+ "title",
3417
+ "provider",
3418
+ "serviceType",
3419
+ "authenticationType"
3420
+ ],
3421
+ "additionalProperties": false
3422
+ },
3423
+ "anyServiceConfig": {
3424
+ "title": "Any Service Config",
3425
+ "oneOf": [
3426
+ {
3427
+ "$ref": "#/definitions/storedServiceConfig"
3428
+ },
3429
+ {
3430
+ "$ref": "#/definitions/serviceConfig"
3431
+ }
3432
+ ]
3433
+ },
3434
+ "storedServiceMap": {
3435
+ "title": "Service Map JSON",
3436
+ "type": "object",
3437
+ "patternProperties": {
3438
+ "[0-9A-Za-z_-]+": {
3439
+ "$ref": "#/definitions/storedServiceConfig"
3440
+ }
3441
+ }
3442
+ },
3443
+ "workflowStep": {
3444
+ "title": "Workflow Step",
3445
+ "type": "object",
3446
+ "properties": {
3447
+ "name": {
3448
+ "type": "string",
3449
+ "title": "Name",
3450
+ "pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$",
3451
+ "description": "machine-readable slug"
3452
+ },
3453
+ "title": {
3454
+ "title": "Title",
3455
+ "type": "string",
3456
+ "description": "Human-readable id for use in the UI"
3457
+ },
3458
+ "description": {
3459
+ "title": "Description",
3460
+ "type": "string"
3461
+ },
3462
+ "color": {
3463
+ "title": "Color",
3464
+ "type": "string",
3465
+ "description": "Hex color code"
3466
+ },
3467
+ "live": {
3468
+ "title": "Live",
3469
+ "type": "boolean",
3470
+ "description": "Value to indicate whether items in the state should be returned in list queries"
3471
+ },
3472
+ "key": {
3473
+ "title": "Key",
3474
+ "type": "string",
3475
+ "description": "machine-readable id"
3476
+ }
3477
+ },
3478
+ "required": [
3479
+ "name",
3480
+ "title",
3481
+ "color",
3482
+ "live",
3483
+ "key"
3484
+ ],
3485
+ "additionalProperties": false
3486
+ },
3487
+ "workflow": {
3488
+ "title": "Workflow",
3489
+ "type": "object",
3490
+ "properties": {
3491
+ "name": {
3492
+ "type": "string",
3493
+ "pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$",
3494
+ "description": "machine-readable id"
3495
+ },
3496
+ "title": {
3497
+ "type": "string",
3498
+ "title": "Workflow Name",
3499
+ "minLength": 1,
3500
+ "description": "Human-readable id for use in the UI"
3501
+ },
3502
+ "steps": {
3503
+ "type": "array",
3504
+ "title": "Steps",
3505
+ "items": {
3506
+ "$ref": "#/definitions/workflowStep"
3507
+ },
3508
+ "minItems": 1
3509
+ }
3510
+ },
3511
+ "required": [
3512
+ "name",
3513
+ "title",
3514
+ "steps"
3515
+ ]
3516
+ },
3517
+ "workflowMap": {
3518
+ "title": "Workflow Map",
3519
+ "type": "object",
3520
+ "patternProperties": {
3521
+ "[0-9A-Za-z_-]+": {
3522
+ "$ref": "#/definitions/workflow"
3523
+ }
3524
+ }
3525
+ },
3526
+ "formConfig": {
3527
+ "title": "Form Config",
3528
+ "type": "object"
3529
+ },
3530
+ "formsConfig": {
3531
+ "title": "Forms Config",
3532
+ "type": "object",
3533
+ "properties": {
3534
+ "default": {
3535
+ "$ref": "#/definitions/formConfig"
3536
+ }
3537
+ },
3538
+ "patternProperties": {
3539
+ "[0-9A-Za-z_-]+": {
3540
+ "$ref": "#/definitions/formConfig"
3541
+ }
3542
+ },
3543
+ "required": [
3544
+ "default"
3545
+ ]
3546
+ }
3547
+ },
3548
+ "properties": {
3549
+ "$schema": {
3550
+ "type": "string"
3551
+ },
3552
+ "apiVersion": {
3553
+ "type": "string",
3554
+ "description": "The version of the TakeShape API your project is using. We increase the version as we make breaking changes to the API endpoints."
3555
+ },
3556
+ "schemaVersion": {
3557
+ "type": "string",
3558
+ "enum": [
3559
+ "3.47.0"
3560
+ ],
3561
+ "description": "The version of the schema format your project is using. We increase the version as we make breaking changes to the schema format."
3562
+ },
3563
+ "projectId": {
3564
+ "type": "string",
3565
+ "description": "The ID of the TakeShape project this schema belongs to."
3566
+ },
3567
+ "author": {
3568
+ "type": "string",
3569
+ "description": "The ID of the TakeShape user who created the schema."
3570
+ },
3571
+ "deactivated": {
3572
+ "type": "number"
3573
+ },
3574
+ "defaultLocale": {
3575
+ "type": "string",
3576
+ "minLength": 1,
3577
+ "pattern": "^[a-zA-Z]{2,3}(-[a-zA-Z]{2,3})?$",
3578
+ "description": "The locale that should be preferred when creating new Shape items. This must be an entry in the locales array."
3579
+ },
3580
+ "locales": {
3581
+ "type": "array",
3582
+ "minItems": 1,
3583
+ "items": {
3584
+ "type": "string",
3585
+ "minLength": 1,
3586
+ "pattern": "^[a-zA-Z]{2,3}(-[a-zA-Z]{2,3})?$"
3587
+ }
3588
+ },
3589
+ "queries": {
3590
+ "$ref": "#/definitions/queryMap",
3591
+ "description": "Queries map directly to queries your project's GraphQL API"
3592
+ },
3593
+ "mutations": {
3594
+ "$ref": "#/definitions/queryMap",
3595
+ "description": "Mutations map directly to mutations your project's GraphQL API"
3596
+ },
3597
+ "shapes": {
3598
+ "$ref": "#/definitions/shapeMap",
3599
+ "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."
3600
+ },
3601
+ "forms": {
3602
+ "$ref": "#/definitions/formMap",
3603
+ "description": "Forms define a visual interface for editing Shapes in the TakeShape UI."
3604
+ },
3605
+ "workflows": {
3606
+ "$ref": "#/definitions/workflowMap",
3607
+ "description": "Workflows describe the status of a shape item. Every schema starts with a default workflow with two steps, Disabled and Enabled"
3608
+ },
3609
+ "services": {
3610
+ "$ref": "#/definitions/storedServiceMap",
3611
+ "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."
3612
+ }
3613
+ },
3614
+ "additionalProperties": false,
3615
+ "required": [
3616
+ "projectId",
3617
+ "apiVersion",
3618
+ "schemaVersion",
3619
+ "defaultLocale",
3620
+ "locales",
3621
+ "shapes",
3622
+ "queries",
3623
+ "mutations",
3624
+ "workflows"
3625
+ ]
3626
+ }