@takeshape/schema 11.144.1 → 11.154.2

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 (537) hide show
  1. package/examples/latest/all-fields-shapes-inline.json +1 -1
  2. package/examples/latest/all-fields-shapes.json +1 -1
  3. package/examples/latest/betzino.json +1 -1
  4. package/examples/latest/blog-schema.json +1 -1
  5. package/examples/latest/brewery-schema.json +1 -1
  6. package/examples/latest/chat-agent-schema.json +1 -1
  7. package/examples/latest/clear-cache-schema.json +1 -1
  8. package/examples/latest/complex-project-schema.json +1 -1
  9. package/examples/latest/complex-schema.json +1 -1
  10. package/examples/latest/edit-schema.json +1 -1
  11. package/examples/latest/frank-and-fred-schema.json +1 -1
  12. package/examples/latest/generate-agent-schema.json +1 -1
  13. package/examples/latest/klirr-schema.json +1 -1
  14. package/examples/latest/layers/rick-and-morty-layer.json +1 -1
  15. package/examples/latest/layers/shopify-layer-2023-01.json +1 -1
  16. package/examples/latest/layers/shopify-storefront-2023-04.json +1 -1
  17. package/examples/latest/layers/wordpress-2024-01.json +1 -1
  18. package/examples/latest/massive-schema.json +1 -1
  19. package/examples/latest/mill-components-schema.json +1 -1
  20. package/examples/latest/nested-shape-arrays.json +1 -1
  21. package/examples/latest/one-earth.json +1 -1
  22. package/examples/latest/pet-oneof-array.json +1 -1
  23. package/examples/latest/post-schema.json +1 -1
  24. package/examples/latest/pruned-shopify-product-schema.json +1 -1
  25. package/examples/latest/rag-example.json +1 -1
  26. package/examples/latest/real-world-schema.json +1 -1
  27. package/examples/latest/recursive-repeater-schema.json +1 -1
  28. package/examples/latest/recursive-schema.json +1 -1
  29. package/examples/latest/rick-and-morty-ast.json +1 -1
  30. package/examples/latest/rick-and-morty-graphql.json +1 -1
  31. package/examples/latest/rick-and-morty-rest.json +1 -1
  32. package/examples/latest/rick-and-morty-user-schema.json +1 -1
  33. package/examples/latest/rick-and-morty-with-indexing.json +1 -1
  34. package/examples/latest/schema-where-filter.json +1 -1
  35. package/examples/latest/schema-with-repeater-draftjs.json +1 -1
  36. package/examples/latest/schema-with-rick-and-morty.json +1 -1
  37. package/examples/latest/shape-books-v3_2_0.json +1 -1
  38. package/examples/latest/shape-books.json +1 -1
  39. package/examples/latest/shape-editor-schema-edited.json +1 -1
  40. package/examples/latest/shape-editor-schema-initial.json +1 -1
  41. package/examples/latest/shapedb-crud-every-prop-type.json +1 -1
  42. package/examples/latest/shopify-lookbook.json +1 -1
  43. package/examples/latest/shopify-product-2022-07.json +1 -1
  44. package/examples/latest/shopify-product-2023-04.json +1 -1
  45. package/examples/latest/shopify-store-with-widget.json +1 -1
  46. package/examples/latest/stripe-product-runtime-schema.json +1 -1
  47. package/examples/latest/stripe-starter-resolved.json +1 -1
  48. package/examples/latest/user-schema-no-required.json +1 -1
  49. package/examples/latest/user-schema-with-defaults.json +1 -1
  50. package/examples/latest/valvoline-ai-demo.json +1461 -1421
  51. package/examples/latest/vector-search-schema.json +1 -1
  52. package/package.json +10 -9
  53. package/dist/agents.d.ts +0 -62
  54. package/dist/agents.js +0 -338
  55. package/dist/api-version.d.ts +0 -5
  56. package/dist/api-version.js +0 -17
  57. package/dist/auth-schemas.d.ts +0 -128
  58. package/dist/auth-schemas.js +0 -7
  59. package/dist/auth-utils.d.ts +0 -5
  60. package/dist/auth-utils.js +0 -6
  61. package/dist/builtin-schema.d.ts +0 -18
  62. package/dist/builtin-schema.js +0 -683
  63. package/dist/constants.d.ts +0 -1
  64. package/dist/constants.js +0 -1
  65. package/dist/content-schema-transform.d.ts +0 -35
  66. package/dist/content-schema-transform.js +0 -162
  67. package/dist/create-input-schema.d.ts +0 -9
  68. package/dist/create-input-schema.js +0 -68
  69. package/dist/enum.d.ts +0 -2
  70. package/dist/enum.js +0 -9
  71. package/dist/flatten-templates.d.ts +0 -2
  72. package/dist/flatten-templates.js +0 -20
  73. package/dist/get-is-leaf.d.ts +0 -3
  74. package/dist/get-is-leaf.js +0 -56
  75. package/dist/index.d.ts +0 -62
  76. package/dist/index.js +0 -59
  77. package/dist/interfaces.d.ts +0 -14
  78. package/dist/interfaces.js +0 -86
  79. package/dist/layers/layers.d.ts +0 -26
  80. package/dist/layers/layers.js +0 -301
  81. package/dist/layers/refs.d.ts +0 -102
  82. package/dist/layers/refs.js +0 -220
  83. package/dist/layers/type-utils.d.ts +0 -59
  84. package/dist/layers/type-utils.js +0 -118
  85. package/dist/layers/visitor.d.ts +0 -5
  86. package/dist/layers/visitor.js +0 -38
  87. package/dist/migration/index.d.ts +0 -73
  88. package/dist/migration/index.js +0 -103
  89. package/dist/migration/to/v3.0.0.d.ts +0 -4
  90. package/dist/migration/to/v3.0.0.js +0 -212
  91. package/dist/migration/to/v3.1.0.d.ts +0 -4
  92. package/dist/migration/to/v3.1.0.js +0 -194
  93. package/dist/migration/to/v3.10.0.d.ts +0 -4
  94. package/dist/migration/to/v3.10.0.js +0 -67
  95. package/dist/migration/to/v3.11.0.d.ts +0 -4
  96. package/dist/migration/to/v3.11.0.js +0 -85
  97. package/dist/migration/to/v3.12.3.d.ts +0 -4
  98. package/dist/migration/to/v3.12.3.js +0 -87
  99. package/dist/migration/to/v3.13.0.d.ts +0 -4
  100. package/dist/migration/to/v3.13.0.js +0 -17
  101. package/dist/migration/to/v3.17.0.d.ts +0 -4
  102. package/dist/migration/to/v3.17.0.js +0 -22
  103. package/dist/migration/to/v3.18.0.d.ts +0 -4
  104. package/dist/migration/to/v3.18.0.js +0 -64
  105. package/dist/migration/to/v3.18.1.d.ts +0 -4
  106. package/dist/migration/to/v3.18.1.js +0 -12
  107. package/dist/migration/to/v3.18.2.d.ts +0 -4
  108. package/dist/migration/to/v3.18.2.js +0 -19
  109. package/dist/migration/to/v3.20.0.d.ts +0 -4
  110. package/dist/migration/to/v3.20.0.js +0 -24
  111. package/dist/migration/to/v3.22.0.d.ts +0 -4
  112. package/dist/migration/to/v3.22.0.js +0 -25
  113. package/dist/migration/to/v3.24.0.d.ts +0 -4
  114. package/dist/migration/to/v3.24.0.js +0 -11
  115. package/dist/migration/to/v3.25.0.d.ts +0 -4
  116. package/dist/migration/to/v3.25.0.js +0 -11
  117. package/dist/migration/to/v3.3.0.d.ts +0 -4
  118. package/dist/migration/to/v3.3.0.js +0 -13
  119. package/dist/migration/to/v3.31.0.d.ts +0 -4
  120. package/dist/migration/to/v3.31.0.js +0 -38
  121. package/dist/migration/to/v3.32.0.d.ts +0 -4
  122. package/dist/migration/to/v3.32.0.js +0 -59
  123. package/dist/migration/to/v3.34.0.d.ts +0 -6
  124. package/dist/migration/to/v3.34.0.js +0 -111
  125. package/dist/migration/to/v3.36.0.d.ts +0 -4
  126. package/dist/migration/to/v3.36.0.js +0 -22
  127. package/dist/migration/to/v3.39.0.d.ts +0 -4
  128. package/dist/migration/to/v3.39.0.js +0 -45
  129. package/dist/migration/to/v3.40.0.d.ts +0 -4
  130. package/dist/migration/to/v3.40.0.js +0 -26
  131. package/dist/migration/to/v3.46.0.d.ts +0 -4
  132. package/dist/migration/to/v3.46.0.js +0 -35
  133. package/dist/migration/to/v3.57.0.d.ts +0 -4
  134. package/dist/migration/to/v3.57.0.js +0 -18
  135. package/dist/migration/to/v3.9.0.d.ts +0 -4
  136. package/dist/migration/to/v3.9.0.js +0 -79
  137. package/dist/migration/types.d.ts +0 -26
  138. package/dist/migration/types.js +0 -3
  139. package/dist/migration/utils.d.ts +0 -2
  140. package/dist/migration/utils.js +0 -6
  141. package/dist/mocks.d.ts +0 -14
  142. package/dist/mocks.js +0 -58
  143. package/dist/models/agent.d.ts +0 -3
  144. package/dist/models/agent.js +0 -29
  145. package/dist/models/project-schema.d.ts +0 -18
  146. package/dist/models/project-schema.js +0 -119
  147. package/dist/models/query.d.ts +0 -3
  148. package/dist/models/query.js +0 -38
  149. package/dist/models/runtime-schema.d.ts +0 -9
  150. package/dist/models/runtime-schema.js +0 -20
  151. package/dist/models/shape.d.ts +0 -4
  152. package/dist/models/shape.js +0 -36
  153. package/dist/models/types.d.ts +0 -36
  154. package/dist/models/types.js +0 -1
  155. package/dist/models/user-schema.d.ts +0 -7
  156. package/dist/models/user-schema.js +0 -9
  157. package/dist/patterns.d.ts +0 -12
  158. package/dist/patterns.js +0 -1
  159. package/dist/project-schema/index.d.ts +0 -211
  160. package/dist/project-schema/index.js +0 -83
  161. package/dist/project-schema/latest.d.ts +0 -2619
  162. package/dist/project-schema/latest.js +0 -7
  163. package/dist/project-schema/migrate.d.ts +0 -4
  164. package/dist/project-schema/migrate.js +0 -218
  165. package/dist/project-schema/v1.0.0.d.ts +0 -299
  166. package/dist/project-schema/v1.0.0.js +0 -7
  167. package/dist/project-schema/v3.0.0.d.ts +0 -478
  168. package/dist/project-schema/v3.0.0.js +0 -7
  169. package/dist/project-schema/v3.1.0.d.ts +0 -621
  170. package/dist/project-schema/v3.1.0.js +0 -7
  171. package/dist/project-schema/v3.10.0.d.ts +0 -1201
  172. package/dist/project-schema/v3.10.0.js +0 -7
  173. package/dist/project-schema/v3.11.0.d.ts +0 -1210
  174. package/dist/project-schema/v3.11.0.js +0 -7
  175. package/dist/project-schema/v3.12.0.d.ts +0 -1214
  176. package/dist/project-schema/v3.12.0.js +0 -7
  177. package/dist/project-schema/v3.12.1.d.ts +0 -1273
  178. package/dist/project-schema/v3.12.1.js +0 -7
  179. package/dist/project-schema/v3.12.2.d.ts +0 -1283
  180. package/dist/project-schema/v3.12.2.js +0 -7
  181. package/dist/project-schema/v3.12.3.d.ts +0 -1306
  182. package/dist/project-schema/v3.12.3.js +0 -7
  183. package/dist/project-schema/v3.13.0.d.ts +0 -1317
  184. package/dist/project-schema/v3.13.0.js +0 -7
  185. package/dist/project-schema/v3.13.1.d.ts +0 -1412
  186. package/dist/project-schema/v3.13.1.js +0 -7
  187. package/dist/project-schema/v3.14.0.d.ts +0 -1436
  188. package/dist/project-schema/v3.14.0.js +0 -7
  189. package/dist/project-schema/v3.15.0.d.ts +0 -1458
  190. package/dist/project-schema/v3.15.0.js +0 -7
  191. package/dist/project-schema/v3.16.0.d.ts +0 -1470
  192. package/dist/project-schema/v3.16.0.js +0 -7
  193. package/dist/project-schema/v3.17.0.d.ts +0 -1467
  194. package/dist/project-schema/v3.17.0.js +0 -7
  195. package/dist/project-schema/v3.17.1.d.ts +0 -1468
  196. package/dist/project-schema/v3.17.1.js +0 -7
  197. package/dist/project-schema/v3.18.0.d.ts +0 -1333
  198. package/dist/project-schema/v3.18.0.js +0 -7
  199. package/dist/project-schema/v3.18.1.d.ts +0 -1332
  200. package/dist/project-schema/v3.18.1.js +0 -7
  201. package/dist/project-schema/v3.18.2.d.ts +0 -1332
  202. package/dist/project-schema/v3.18.2.js +0 -7
  203. package/dist/project-schema/v3.19.0.d.ts +0 -1336
  204. package/dist/project-schema/v3.19.0.js +0 -7
  205. package/dist/project-schema/v3.2.0.d.ts +0 -632
  206. package/dist/project-schema/v3.2.0.js +0 -7
  207. package/dist/project-schema/v3.20.0.d.ts +0 -1336
  208. package/dist/project-schema/v3.20.0.js +0 -7
  209. package/dist/project-schema/v3.21.0.d.ts +0 -1338
  210. package/dist/project-schema/v3.21.0.js +0 -7
  211. package/dist/project-schema/v3.22.0.d.ts +0 -1344
  212. package/dist/project-schema/v3.22.0.js +0 -7
  213. package/dist/project-schema/v3.23.0.d.ts +0 -1376
  214. package/dist/project-schema/v3.23.0.js +0 -7
  215. package/dist/project-schema/v3.24.0.d.ts +0 -1364
  216. package/dist/project-schema/v3.24.0.js +0 -7
  217. package/dist/project-schema/v3.25.0.d.ts +0 -1363
  218. package/dist/project-schema/v3.25.0.js +0 -7
  219. package/dist/project-schema/v3.26.0.d.ts +0 -1388
  220. package/dist/project-schema/v3.26.0.js +0 -7
  221. package/dist/project-schema/v3.27.0.d.ts +0 -1397
  222. package/dist/project-schema/v3.27.0.js +0 -7
  223. package/dist/project-schema/v3.28.0.d.ts +0 -1416
  224. package/dist/project-schema/v3.28.0.js +0 -7
  225. package/dist/project-schema/v3.29.0.d.ts +0 -1423
  226. package/dist/project-schema/v3.29.0.js +0 -7
  227. package/dist/project-schema/v3.3.0.d.ts +0 -632
  228. package/dist/project-schema/v3.3.0.js +0 -7
  229. package/dist/project-schema/v3.30.0.d.ts +0 -1416
  230. package/dist/project-schema/v3.30.0.js +0 -7
  231. package/dist/project-schema/v3.31.0.d.ts +0 -1448
  232. package/dist/project-schema/v3.31.0.js +0 -7
  233. package/dist/project-schema/v3.32.0.d.ts +0 -1439
  234. package/dist/project-schema/v3.32.0.js +0 -7
  235. package/dist/project-schema/v3.33.0.d.ts +0 -1445
  236. package/dist/project-schema/v3.33.0.js +0 -7
  237. package/dist/project-schema/v3.34.0.d.ts +0 -1445
  238. package/dist/project-schema/v3.34.0.js +0 -7
  239. package/dist/project-schema/v3.35.0.d.ts +0 -1464
  240. package/dist/project-schema/v3.35.0.js +0 -7
  241. package/dist/project-schema/v3.36.0.d.ts +0 -1470
  242. package/dist/project-schema/v3.36.0.js +0 -7
  243. package/dist/project-schema/v3.37.0.d.ts +0 -1522
  244. package/dist/project-schema/v3.37.0.js +0 -7
  245. package/dist/project-schema/v3.38.0.d.ts +0 -1522
  246. package/dist/project-schema/v3.38.0.js +0 -7
  247. package/dist/project-schema/v3.39.0.d.ts +0 -1529
  248. package/dist/project-schema/v3.39.0.js +0 -7
  249. package/dist/project-schema/v3.4.0.d.ts +0 -624
  250. package/dist/project-schema/v3.4.0.js +0 -7
  251. package/dist/project-schema/v3.40.0.d.ts +0 -1530
  252. package/dist/project-schema/v3.40.0.js +0 -7
  253. package/dist/project-schema/v3.41.0.d.ts +0 -1530
  254. package/dist/project-schema/v3.41.0.js +0 -7
  255. package/dist/project-schema/v3.42.0.d.ts +0 -1534
  256. package/dist/project-schema/v3.42.0.js +0 -7
  257. package/dist/project-schema/v3.43.0.d.ts +0 -1536
  258. package/dist/project-schema/v3.43.0.js +0 -7
  259. package/dist/project-schema/v3.44.0.d.ts +0 -1621
  260. package/dist/project-schema/v3.44.0.js +0 -7
  261. package/dist/project-schema/v3.45.0.d.ts +0 -1650
  262. package/dist/project-schema/v3.45.0.js +0 -7
  263. package/dist/project-schema/v3.46.0.d.ts +0 -1703
  264. package/dist/project-schema/v3.46.0.js +0 -7
  265. package/dist/project-schema/v3.47.0.d.ts +0 -1736
  266. package/dist/project-schema/v3.47.0.js +0 -7
  267. package/dist/project-schema/v3.48.0.d.ts +0 -2208
  268. package/dist/project-schema/v3.48.0.js +0 -7
  269. package/dist/project-schema/v3.49.0.d.ts +0 -2217
  270. package/dist/project-schema/v3.49.0.js +0 -7
  271. package/dist/project-schema/v3.5.0.d.ts +0 -649
  272. package/dist/project-schema/v3.5.0.js +0 -7
  273. package/dist/project-schema/v3.5.1.d.ts +0 -649
  274. package/dist/project-schema/v3.5.1.js +0 -7
  275. package/dist/project-schema/v3.50.0.d.ts +0 -2269
  276. package/dist/project-schema/v3.50.0.js +0 -7
  277. package/dist/project-schema/v3.51.0.d.ts +0 -2269
  278. package/dist/project-schema/v3.51.0.js +0 -7
  279. package/dist/project-schema/v3.52.0.d.ts +0 -2269
  280. package/dist/project-schema/v3.52.0.js +0 -7
  281. package/dist/project-schema/v3.53.0.d.ts +0 -2350
  282. package/dist/project-schema/v3.53.0.js +0 -7
  283. package/dist/project-schema/v3.54.0.d.ts +0 -2369
  284. package/dist/project-schema/v3.54.0.js +0 -7
  285. package/dist/project-schema/v3.55.0.d.ts +0 -2369
  286. package/dist/project-schema/v3.55.0.js +0 -7
  287. package/dist/project-schema/v3.56.0.d.ts +0 -2405
  288. package/dist/project-schema/v3.56.0.js +0 -7
  289. package/dist/project-schema/v3.57.0.d.ts +0 -2601
  290. package/dist/project-schema/v3.57.0.js +0 -7
  291. package/dist/project-schema/v3.58.0.d.ts +0 -2601
  292. package/dist/project-schema/v3.58.0.js +0 -7
  293. package/dist/project-schema/v3.59.0.d.ts +0 -2619
  294. package/dist/project-schema/v3.59.0.js +0 -7
  295. package/dist/project-schema/v3.6.0.d.ts +0 -658
  296. package/dist/project-schema/v3.6.0.js +0 -7
  297. package/dist/project-schema/v3.7.0.d.ts +0 -961
  298. package/dist/project-schema/v3.7.0.js +0 -7
  299. package/dist/project-schema/v3.8.0.d.ts +0 -979
  300. package/dist/project-schema/v3.8.0.js +0 -7
  301. package/dist/project-schema/v3.9.0.d.ts +0 -1178
  302. package/dist/project-schema/v3.9.0.js +0 -7
  303. package/dist/project-schema/v4.0.0.d.ts +0 -1328
  304. package/dist/project-schema/v4.0.0.js +0 -7
  305. package/dist/refs.d.ts +0 -218
  306. package/dist/refs.js +0 -616
  307. package/dist/relationships.d.ts +0 -40
  308. package/dist/relationships.js +0 -302
  309. package/dist/resolvers/ai/abort-agent-message-args.d.ts +0 -16
  310. package/dist/resolvers/ai/abort-agent-message-args.js +0 -13
  311. package/dist/resolvers/ai/abort-agent-message-response.d.ts +0 -39
  312. package/dist/resolvers/ai/abort-agent-message-response.js +0 -19
  313. package/dist/resolvers/ai/agent-chat-args.d.ts +0 -17
  314. package/dist/resolvers/ai/agent-chat-args.js +0 -14
  315. package/dist/resolvers/ai/agent-chat-payload.d.ts +0 -35
  316. package/dist/resolvers/ai/agent-chat-payload.js +0 -26
  317. package/dist/resolvers/ai/agent-chat-response.d.ts +0 -289
  318. package/dist/resolvers/ai/agent-chat-response.js +0 -21
  319. package/dist/resolvers/ai/agent-generate-args.d.ts +0 -17
  320. package/dist/resolvers/ai/agent-generate-args.js +0 -14
  321. package/dist/resolvers/ai/agent-message-input.d.ts +0 -73
  322. package/dist/resolvers/ai/agent-message-input.js +0 -39
  323. package/dist/resolvers/ai/agent-message-output.d.ts +0 -169
  324. package/dist/resolvers/ai/agent-message-output.js +0 -77
  325. package/dist/resolvers/ai/agent-message-payload.d.ts +0 -507
  326. package/dist/resolvers/ai/agent-message-payload.js +0 -156
  327. package/dist/resolvers/ai/agent-run-mode.d.ts +0 -7
  328. package/dist/resolvers/ai/agent-run-mode.js +0 -9
  329. package/dist/resolvers/ai/agent-session-payload.d.ts +0 -515
  330. package/dist/resolvers/ai/agent-session-payload.js +0 -175
  331. package/dist/resolvers/ai/create-agent-session-response.d.ts +0 -199
  332. package/dist/resolvers/ai/create-agent-session-response.js +0 -9
  333. package/dist/resolvers/ai/embedding-search.d.ts +0 -54
  334. package/dist/resolvers/ai/embedding-search.js +0 -46
  335. package/dist/resolvers/ai/get-agent-message-args.d.ts +0 -16
  336. package/dist/resolvers/ai/get-agent-message-args.js +0 -13
  337. package/dist/resolvers/ai/get-agent-message-response.d.ts +0 -805
  338. package/dist/resolvers/ai/get-agent-message-response.js +0 -63
  339. package/dist/resolvers/ai/inspect-agent-args.d.ts +0 -16
  340. package/dist/resolvers/ai/inspect-agent-args.js +0 -13
  341. package/dist/resolvers/ai/inspect-agent-response.d.ts +0 -504
  342. package/dist/resolvers/ai/inspect-agent-response.js +0 -48
  343. package/dist/resolvers/ai/send-agent-feedback-args.d.ts +0 -52
  344. package/dist/resolvers/ai/send-agent-feedback-args.js +0 -16
  345. package/dist/resolvers/ai/send-agent-message-args.d.ts +0 -48
  346. package/dist/resolvers/ai/send-agent-message-args.js +0 -36
  347. package/dist/resolvers/ai/send-agent-message-response.d.ts +0 -353
  348. package/dist/resolvers/ai/send-agent-message-response.js +0 -51
  349. package/dist/resolvers/ai/types.d.ts +0 -6
  350. package/dist/resolvers/ai/types.js +0 -1
  351. package/dist/resolvers/takeshape/assets/asset-image-meta.d.ts +0 -79
  352. package/dist/resolvers/takeshape/assets/asset-image-meta.js +0 -98
  353. package/dist/resolvers/takeshape/assets/asset-image-params.d.ts +0 -901
  354. package/dist/resolvers/takeshape/assets/asset-image-params.js +0 -726
  355. package/dist/resolvers/takeshape/assets/asset-image.d.ts +0 -17
  356. package/dist/resolvers/takeshape/assets/asset-image.js +0 -15
  357. package/dist/resolvers/takeshape/assets/asset.d.ts +0 -125
  358. package/dist/resolvers/takeshape/assets/asset.js +0 -107
  359. package/dist/resolvers/takeshape/assets/constants.d.ts +0 -11
  360. package/dist/resolvers/takeshape/assets/constants.js +0 -11
  361. package/dist/resolvers/takeshape/builtins/constants.d.ts +0 -1
  362. package/dist/resolvers/takeshape/builtins/constants.js +0 -1
  363. package/dist/runtime-schema.d.ts +0 -6
  364. package/dist/runtime-schema.js +0 -85
  365. package/dist/scalars.d.ts +0 -2
  366. package/dist/scalars.js +0 -4
  367. package/dist/schema-transform.d.ts +0 -19
  368. package/dist/schema-transform.js +0 -74
  369. package/dist/schema-util.d.ts +0 -266
  370. package/dist/schema-util.js +0 -1127
  371. package/dist/schemas/auth-schemas.json +0 -374
  372. package/dist/schemas/index.d.ts +0 -4
  373. package/dist/schemas/index.js +0 -170
  374. package/dist/schemas/project-schema/experimental-2025-07.json +0 -1297
  375. package/dist/schemas/project-schema/latest.d.ts +0 -180
  376. package/dist/schemas/project-schema/latest.js +0 -11
  377. package/dist/schemas/project-schema/latest.json +0 -4846
  378. package/dist/schemas/project-schema/meta-schema-v1.0.0.json +0 -193
  379. package/dist/schemas/project-schema/meta-schema-v3.0.0.json +0 -608
  380. package/dist/schemas/project-schema/meta-schema-v3.1.0.json +0 -608
  381. package/dist/schemas/project-schema/meta-schema-v3.2.0.json +0 -612
  382. package/dist/schemas/project-schema/meta-schema-v3.3.0.json +0 -612
  383. package/dist/schemas/project-schema/meta-schema-v3.4.0.json +0 -637
  384. package/dist/schemas/project-schema/meta-schema-v3.5.0.json +0 -626
  385. package/dist/schemas/project-schema/meta-schema-v3.5.1.json +0 -626
  386. package/dist/schemas/project-schema/meta-schema-v3.6.0.json +0 -629
  387. package/dist/schemas/project-schema/meta-schema-v3.7.0.json +0 -1137
  388. package/dist/schemas/project-schema/meta-schema-v3.8.0.json +0 -1137
  389. package/dist/schemas/project-schema/meta-schema-v3.9.0.json +0 -1477
  390. package/dist/schemas/project-schema/v1.0.0.json +0 -321
  391. package/dist/schemas/project-schema/v3.0.0.json +0 -414
  392. package/dist/schemas/project-schema/v3.1.0.json +0 -572
  393. package/dist/schemas/project-schema/v3.10.0.json +0 -2097
  394. package/dist/schemas/project-schema/v3.11.0.json +0 -2141
  395. package/dist/schemas/project-schema/v3.12.0.json +0 -2144
  396. package/dist/schemas/project-schema/v3.12.1.json +0 -2282
  397. package/dist/schemas/project-schema/v3.12.2.json +0 -2304
  398. package/dist/schemas/project-schema/v3.12.3.json +0 -2357
  399. package/dist/schemas/project-schema/v3.13.0.json +0 -2377
  400. package/dist/schemas/project-schema/v3.14.0.json +0 -2385
  401. package/dist/schemas/project-schema/v3.15.0.json +0 -2365
  402. package/dist/schemas/project-schema/v3.16.0.json +0 -2373
  403. package/dist/schemas/project-schema/v3.17.0.json +0 -2378
  404. package/dist/schemas/project-schema/v3.17.1.json +0 -2380
  405. package/dist/schemas/project-schema/v3.18.0.json +0 -2356
  406. package/dist/schemas/project-schema/v3.18.1.json +0 -2357
  407. package/dist/schemas/project-schema/v3.18.2.json +0 -2357
  408. package/dist/schemas/project-schema/v3.19.0.json +0 -2369
  409. package/dist/schemas/project-schema/v3.2.0.json +0 -580
  410. package/dist/schemas/project-schema/v3.20.0.json +0 -2369
  411. package/dist/schemas/project-schema/v3.21.0.json +0 -2376
  412. package/dist/schemas/project-schema/v3.22.0.json +0 -2381
  413. package/dist/schemas/project-schema/v3.23.0.json +0 -2456
  414. package/dist/schemas/project-schema/v3.24.0.json +0 -2556
  415. package/dist/schemas/project-schema/v3.25.0.json +0 -2552
  416. package/dist/schemas/project-schema/v3.26.0.json +0 -2599
  417. package/dist/schemas/project-schema/v3.27.0.json +0 -2611
  418. package/dist/schemas/project-schema/v3.28.0.json +0 -2656
  419. package/dist/schemas/project-schema/v3.29.0.json +0 -2670
  420. package/dist/schemas/project-schema/v3.3.0.json +0 -581
  421. package/dist/schemas/project-schema/v3.30.0.json +0 -2656
  422. package/dist/schemas/project-schema/v3.31.0.json +0 -2714
  423. package/dist/schemas/project-schema/v3.32.0.json +0 -2708
  424. package/dist/schemas/project-schema/v3.33.0.json +0 -2715
  425. package/dist/schemas/project-schema/v3.34.0.json +0 -2715
  426. package/dist/schemas/project-schema/v3.35.0.json +0 -2748
  427. package/dist/schemas/project-schema/v3.36.0.json +0 -2756
  428. package/dist/schemas/project-schema/v3.37.0.json +0 -2821
  429. package/dist/schemas/project-schema/v3.38.0.json +0 -2819
  430. package/dist/schemas/project-schema/v3.39.0.json +0 -2827
  431. package/dist/schemas/project-schema/v3.4.0.json +0 -571
  432. package/dist/schemas/project-schema/v3.40.0.json +0 -2830
  433. package/dist/schemas/project-schema/v3.41.0.json +0 -2830
  434. package/dist/schemas/project-schema/v3.42.0.json +0 -2835
  435. package/dist/schemas/project-schema/v3.43.0.json +0 -2841
  436. package/dist/schemas/project-schema/v3.44.0.json +0 -3013
  437. package/dist/schemas/project-schema/v3.45.0.json +0 -3064
  438. package/dist/schemas/project-schema/v3.46.0.json +0 -3136
  439. package/dist/schemas/project-schema/v3.47.0.json +0 -3189
  440. package/dist/schemas/project-schema/v3.48.0.json +0 -3196
  441. package/dist/schemas/project-schema/v3.49.0.json +0 -3239
  442. package/dist/schemas/project-schema/v3.5.0.json +0 -571
  443. package/dist/schemas/project-schema/v3.5.1.json +0 -571
  444. package/dist/schemas/project-schema/v3.50.0.json +0 -3320
  445. package/dist/schemas/project-schema/v3.51.0.json +0 -3326
  446. package/dist/schemas/project-schema/v3.52.0.json +0 -3326
  447. package/dist/schemas/project-schema/v3.53.0.json +0 -3476
  448. package/dist/schemas/project-schema/v3.54.0.json +0 -3512
  449. package/dist/schemas/project-schema/v3.55.0.json +0 -3515
  450. package/dist/schemas/project-schema/v3.56.0.json +0 -3530
  451. package/dist/schemas/project-schema/v3.57.0.json +0 -4815
  452. package/dist/schemas/project-schema/v3.58.0.json +0 -4815
  453. package/dist/schemas/project-schema/v3.59.0.json +0 -4846
  454. package/dist/schemas/project-schema/v3.6.0.json +0 -587
  455. package/dist/schemas/project-schema/v3.7.0.json +0 -587
  456. package/dist/schemas/project-schema/v3.8.0.json +0 -604
  457. package/dist/schemas/project-schema/v3.9.0.json +0 -604
  458. package/dist/schemas/project-schema/v4.0.0.json +0 -2316
  459. package/dist/schemas/project-schema.json +0 -214
  460. package/dist/service-dependencies.d.ts +0 -13
  461. package/dist/service-dependencies.js +0 -165
  462. package/dist/services/services.d.ts +0 -31
  463. package/dist/services/services.js +0 -145
  464. package/dist/services/types.d.ts +0 -11
  465. package/dist/services/types.js +0 -1
  466. package/dist/services/util.d.ts +0 -16
  467. package/dist/services/util.js +0 -36
  468. package/dist/shape-paths.d.ts +0 -7
  469. package/dist/shape-paths.js +0 -28
  470. package/dist/taxonomies.d.ts +0 -15
  471. package/dist/taxonomies.js +0 -24
  472. package/dist/template-shapes/index.d.ts +0 -7
  473. package/dist/template-shapes/index.js +0 -33
  474. package/dist/template-shapes/names.d.ts +0 -10
  475. package/dist/template-shapes/names.js +0 -21
  476. package/dist/template-shapes/templates.d.ts +0 -32
  477. package/dist/template-shapes/templates.js +0 -316
  478. package/dist/template-shapes/types.d.ts +0 -15
  479. package/dist/template-shapes/types.js +0 -7
  480. package/dist/template-shapes/where.d.ts +0 -37
  481. package/dist/template-shapes/where.js +0 -400
  482. package/dist/types/index.d.ts +0 -3
  483. package/dist/types/index.js +0 -2
  484. package/dist/types/transforms.d.ts +0 -15
  485. package/dist/types/transforms.js +0 -1
  486. package/dist/types/types.d.ts +0 -200
  487. package/dist/types/types.js +0 -10
  488. package/dist/types/utils.d.ts +0 -112
  489. package/dist/types/utils.js +0 -269
  490. package/dist/unions.d.ts +0 -14
  491. package/dist/unions.js +0 -77
  492. package/dist/util/ai-tools.d.ts +0 -2
  493. package/dist/util/ai-tools.js +0 -14
  494. package/dist/util/api-indexing.d.ts +0 -9
  495. package/dist/util/api-indexing.js +0 -57
  496. package/dist/util/coerce-value.d.ts +0 -9
  497. package/dist/util/coerce-value.js +0 -32
  498. package/dist/util/detect-cycles.d.ts +0 -7
  499. package/dist/util/detect-cycles.js +0 -45
  500. package/dist/util/expressions.d.ts +0 -34
  501. package/dist/util/expressions.js +0 -350
  502. package/dist/util/find-shape-at-path.d.ts +0 -21
  503. package/dist/util/find-shape-at-path.js +0 -53
  504. package/dist/util/form-config.d.ts +0 -11
  505. package/dist/util/form-config.js +0 -62
  506. package/dist/util/get-conflicting-properties.d.ts +0 -6
  507. package/dist/util/get-conflicting-properties.js +0 -55
  508. package/dist/util/get-return-shape.d.ts +0 -4
  509. package/dist/util/get-return-shape.js +0 -30
  510. package/dist/util/has-arg.d.ts +0 -6
  511. package/dist/util/has-arg.js +0 -25
  512. package/dist/util/is-asset-property.d.ts +0 -3
  513. package/dist/util/is-asset-property.js +0 -11
  514. package/dist/util/mcp.d.ts +0 -8
  515. package/dist/util/mcp.js +0 -21
  516. package/dist/util/merge.d.ts +0 -15
  517. package/dist/util/merge.js +0 -254
  518. package/dist/util/patch-schema.d.ts +0 -8
  519. package/dist/util/patch-schema.js +0 -51
  520. package/dist/util/query-field-path.d.ts +0 -9
  521. package/dist/util/query-field-path.js +0 -23
  522. package/dist/util/shapes.d.ts +0 -5
  523. package/dist/util/shapes.js +0 -22
  524. package/dist/validate/ai.d.ts +0 -6
  525. package/dist/validate/ai.js +0 -183
  526. package/dist/validate/errors.d.ts +0 -3
  527. package/dist/validate/errors.js +0 -20
  528. package/dist/validate/types.d.ts +0 -1
  529. package/dist/validate/types.js +0 -1
  530. package/dist/validate/util.d.ts +0 -3
  531. package/dist/validate/util.js +0 -28
  532. package/dist/validate/validate.d.ts +0 -80
  533. package/dist/validate/validate.js +0 -1058
  534. package/dist/versions.d.ts +0 -4
  535. package/dist/versions.js +0 -4
  536. package/dist/workflows.d.ts +0 -14
  537. package/dist/workflows.js +0 -66
@@ -1,4815 +0,0 @@
1
- {
2
- "$schema": "http://json-schema.org/draft-07/schema#",
3
- "$id": "https://schema.takeshape.io/project-schema/v3.57.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": ["array", "boolean", "integer", "null", "number", "object", "string"]
33
- },
34
- "stringArray": {
35
- "title": "String Array",
36
- "type": "array",
37
- "items": {
38
- "type": "string"
39
- },
40
- "uniqueItems": true,
41
- "default": []
42
- },
43
- "backreference": {
44
- "title": "Back Reference",
45
- "description": "A configuration object for a reverse reference in a relationship.",
46
- "type": "object",
47
- "properties": {
48
- "enabled": {
49
- "type": "boolean"
50
- },
51
- "name": {
52
- "type": "string",
53
- "pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$"
54
- }
55
- },
56
- "additionalProperties": false,
57
- "required": ["enabled"]
58
- },
59
- "mappingString": {
60
- "title": "Mapping String",
61
- "type": "string",
62
- "pattern": "^[\\w-]+(?::[\\w-]+)+(?:\\.[\\w%-]+)+$"
63
- },
64
- "fieldMapping": {
65
- "title": "Field Mapping",
66
- "oneOf": [
67
- {
68
- "$ref": "#/definitions/mappingString"
69
- },
70
- {
71
- "type": "array",
72
- "items": {
73
- "$ref": "#/definitions/mappingString"
74
- }
75
- }
76
- ]
77
- },
78
- "refSchema": {
79
- "title": "Ref Schema",
80
- "type": "object",
81
- "properties": {
82
- "@ref": {
83
- "$ref": "#/definitions/ref"
84
- }
85
- },
86
- "required": ["@ref"]
87
- },
88
- "refSchemaLegacy": {
89
- "title": "Ref Schema Legacy",
90
- "type": "object",
91
- "properties": {
92
- "$ref": {
93
- "$ref": "#/definitions/ref"
94
- }
95
- },
96
- "required": ["$ref"]
97
- },
98
- "shapeSchemaEnum": {
99
- "title": "Shape Schema Enum",
100
- "type": "object",
101
- "properties": {
102
- "enum": {
103
- "type": "array",
104
- "minItems": 1,
105
- "uniqueItems": true
106
- }
107
- },
108
- "additionalProperties": false,
109
- "required": ["enum"]
110
- },
111
- "objectSchema": {
112
- "title": "Object Schema",
113
- "type": "object",
114
- "allOf": [
115
- {
116
- "$ref": "#/definitions/propertySchema"
117
- },
118
- {
119
- "properties": {
120
- "type": {
121
- "type": "string",
122
- "const": "object"
123
- },
124
- "properties": {
125
- "type": "object",
126
- "additionalProperties": {
127
- "$ref": "#/definitions/propertySchema"
128
- }
129
- }
130
- },
131
- "required": ["type", "properties"]
132
- }
133
- ]
134
- },
135
- "returnShapeArraySchema": {
136
- "title": "Return Shape Array Schema",
137
- "type": "object",
138
- "allOf": [
139
- {
140
- "$ref": "#/definitions/propertySchema"
141
- },
142
- {
143
- "properties": {
144
- "type": {
145
- "type": "string",
146
- "const": "array"
147
- },
148
- "items": {
149
- "oneOf": [
150
- {
151
- "$ref": "#/definitions/refSchema"
152
- },
153
- {
154
- "type": "object",
155
- "properties": {
156
- "type": {
157
- "enum": ["boolean", "integer", "number", "string", "object"]
158
- }
159
- },
160
- "required": ["type"]
161
- }
162
- ]
163
- }
164
- },
165
- "required": ["type", "items"]
166
- }
167
- ]
168
- },
169
- "objectOrRefArray": {
170
- "title": "ObjectOrRefArray",
171
- "type": "array",
172
- "items": {
173
- "oneOf": [
174
- {
175
- "$ref": "#/definitions/refSchema"
176
- },
177
- {
178
- "$ref": "#/definitions/refSchemaLegacy"
179
- },
180
- {
181
- "$ref": "#/definitions/objectSchema"
182
- }
183
- ],
184
- "unevaluatedProperties": true
185
- }
186
- },
187
- "shapeSchemaAllOf": {
188
- "title": "Shape Schema All Of",
189
- "type": "object",
190
- "properties": {
191
- "allOf": {
192
- "$ref": "#/definitions/objectOrRefArray"
193
- }
194
- },
195
- "required": ["allOf"],
196
- "additionalProperties": false
197
- },
198
- "allOfSchema": {
199
- "title": "AllOfSchema",
200
- "allOf": [
201
- {
202
- "$ref": "#/definitions/propertySchema"
203
- },
204
- {
205
- "type": "object",
206
- "properties": {
207
- "allOf": {
208
- "$ref": "#/definitions/objectOrRefArray"
209
- }
210
- },
211
- "required": ["allOf"]
212
- }
213
- ]
214
- },
215
- "shapeSchemaExtends": {
216
- "title": "ShapeSchemaExtends",
217
- "type": "object",
218
- "properties": {
219
- "extends": {
220
- "$ref": "#/definitions/objectOrRefArray"
221
- }
222
- },
223
- "required": ["extends"],
224
- "additionalProperties": false
225
- },
226
- "extendsSchema": {
227
- "title": "ExtendsSchema",
228
- "allOf": [
229
- {
230
- "$ref": "#/definitions/propertySchema"
231
- },
232
- {
233
- "type": "object",
234
- "properties": {
235
- "extends": {
236
- "$ref": "#/definitions/objectOrRefArray"
237
- }
238
- },
239
- "required": ["extends"]
240
- }
241
- ]
242
- },
243
- "shapeSchemaOneOf": {
244
- "title": "Shape Schema One Of",
245
- "type": "object",
246
- "properties": {
247
- "oneOf": {
248
- "$ref": "#/definitions/objectOrRefArray"
249
- }
250
- },
251
- "required": ["oneOf"],
252
- "additionalProperties": false
253
- },
254
- "oneOfSchema": {
255
- "title": "OneOfSchema",
256
- "allOf": [
257
- {
258
- "$ref": "#/definitions/propertySchema"
259
- },
260
- {
261
- "type": "object",
262
- "properties": {
263
- "oneOf": {
264
- "$ref": "#/definitions/objectOrRefArray"
265
- }
266
- },
267
- "required": ["oneOf"],
268
- "additionalProperties": false
269
- }
270
- ]
271
- },
272
- "shapeSchemaAny": {
273
- "type": "object",
274
- "title": "ShapeSchemaAny",
275
- "additionalProperties": false
276
- },
277
- "shapeSchema": {
278
- "title": "Shape Schema",
279
- "type": "object",
280
- "oneOf": [
281
- {
282
- "$ref": "#/definitions/shapeSchemaAllOf"
283
- },
284
- {
285
- "$ref": "#/definitions/shapeSchemaExtends"
286
- },
287
- {
288
- "$ref": "#/definitions/shapeSchemaOneOf"
289
- },
290
- {
291
- "$ref": "#/definitions/shapeSchemaEnum"
292
- },
293
- {
294
- "$ref": "#/definitions/objectSchema"
295
- },
296
- {
297
- "$ref": "#/definitions/shapeSchemaAny"
298
- }
299
- ]
300
- },
301
- "queryMap": {
302
- "title": "Query Map",
303
- "type": "object",
304
- "patternProperties": {
305
- "^[0-9A-Za-z_]+$": {
306
- "$ref": "#/definitions/query"
307
- }
308
- },
309
- "additionalProperties": false
310
- },
311
- "args": {
312
- "title": "Args",
313
- "oneOf": [
314
- {
315
- "type": "string"
316
- },
317
- {
318
- "$ref": "#/definitions/objectSchema"
319
- },
320
- {
321
- "$ref": "#/definitions/extendsSchema"
322
- }
323
- ]
324
- },
325
- "returnShape": {
326
- "title": "Return Shape",
327
- "oneOf": [
328
- {
329
- "type": "string"
330
- },
331
- {
332
- "$ref": "#/definitions/returnShapeArraySchema"
333
- }
334
- ]
335
- },
336
- "directiveConfigItem": {
337
- "title": "Directive Config Item",
338
- "description": "A tuple with a string directive name, and options to pass to the directive",
339
- "type": "array",
340
- "items": [
341
- {
342
- "title": "Directive Name",
343
- "type": "string"
344
- },
345
- {
346
- "title": "Directive Options",
347
- "type": "object",
348
- "propertyNames": {
349
- "pattern": "[0-9A-Za-z_-]+"
350
- }
351
- }
352
- ]
353
- },
354
- "parameterSerializeStyleOptions": {
355
- "title": "Parameter Serialize Style Options",
356
- "description": "All possible options for the more specific ParameterSerializeStyleOptions types.",
357
- "type": "object",
358
- "properties": {
359
- "style": {
360
- "type": "string",
361
- "enum": ["simple", "label", "matrix", "form", "spaceDelimited", "pipeDelimited", "deepObject", "none"]
362
- },
363
- "explode": {
364
- "type": "boolean"
365
- },
366
- "allowEmptyValue": {
367
- "type": "boolean"
368
- },
369
- "allowReserved": {
370
- "description": "The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.",
371
- "type": "boolean"
372
- },
373
- "skipEncoding": {
374
- "type": "boolean"
375
- }
376
- },
377
- "required": ["style"],
378
- "additionalProperties": false
379
- },
380
- "parameterSerializeStyleOptionsForPathParams": {
381
- "title": "Parameter Serialize Style Options For Path Params",
382
- "description": "Options to be passed to the serialization routine.",
383
- "type": "object",
384
- "properties": {
385
- "style": {
386
- "type": "string",
387
- "enum": ["simple", "label", "matrix", "none"]
388
- },
389
- "explode": {
390
- "type": "boolean"
391
- },
392
- "allowEmptyValue": {
393
- "type": "boolean"
394
- },
395
- "allowReserved": {
396
- "description": "The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.",
397
- "type": "boolean"
398
- },
399
- "skipEncoding": {
400
- "type": "boolean"
401
- }
402
- },
403
- "required": ["style"],
404
- "additionalProperties": false
405
- },
406
- "parameterSerializeStyleOptionsForSearchParams": {
407
- "title": "Parameter Serialize Style Options For Search Params",
408
- "description": "Options to be passed to the serialization routine.",
409
- "type": "object",
410
- "properties": {
411
- "style": {
412
- "type": "string",
413
- "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject", "none"]
414
- },
415
- "explode": {
416
- "type": "boolean"
417
- },
418
- "allowEmptyValue": {
419
- "type": "boolean"
420
- },
421
- "allowReserved": {
422
- "description": "The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.",
423
- "type": "boolean"
424
- },
425
- "skipEncoding": {
426
- "type": "boolean"
427
- }
428
- },
429
- "required": ["style"],
430
- "additionalProperties": false
431
- },
432
- "parameterSerializeStyleOptionsForHeaders": {
433
- "title": "Parameter Serialize Style Options For Headers",
434
- "description": "Options to be passed to the serialization routine.",
435
- "type": "object",
436
- "properties": {
437
- "style": {
438
- "type": "string",
439
- "enum": ["simple", "none"]
440
- },
441
- "explode": {
442
- "type": "boolean"
443
- }
444
- },
445
- "required": ["style"],
446
- "additionalProperties": false
447
- },
448
- "parameterSerializeContentOptions": {
449
- "title": "Parameter Serialize Content Options",
450
- "description": "Options to be passed to the serialization routine.",
451
- "type": "object",
452
- "properties": {
453
- "contentType": {
454
- "type": "string"
455
- },
456
- "allowReserved": {
457
- "description": "The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.",
458
- "type": "boolean"
459
- },
460
- "skipEncoding": {
461
- "type": "boolean"
462
- },
463
- "options": {
464
- "description": "Options to be passed directly to the content serializer library. Valid options depend upon your contentType.",
465
- "type": "object"
466
- }
467
- },
468
- "required": ["contentType"],
469
- "additionalProperties": false
470
- },
471
- "parameterSerializeOptions": {
472
- "title": "Parameter Serialize Options",
473
- "description": "Options to be passed to the serialization routine.",
474
- "type": "object",
475
- "oneOf": [
476
- {
477
- "$ref": "#/definitions/parameterSerializeStyleOptions"
478
- },
479
- {
480
- "$ref": "#/definitions/parameterSerializeContentOptions"
481
- }
482
- ]
483
- },
484
- "parameterSerializeConfig": {
485
- "title": "Parameter Serialize Config",
486
- "description": "All possible options for the more specific ParameterSerializeConfig types.",
487
- "type": "object",
488
- "properties": {
489
- "content": {
490
- "$ref": "#/definitions/parameterSerializeContentOptions"
491
- },
492
- "defaults": {
493
- "$ref": "#/definitions/parameterSerializeOptions"
494
- },
495
- "paths": {
496
- "type": "object",
497
- "patternProperties": {
498
- "^[^\\n\\r]*$": {
499
- "$ref": "#/definitions/parameterSerializeOptions"
500
- }
501
- }
502
- }
503
- },
504
- "additionalProperties": false
505
- },
506
- "parameterSerializeConfigForBody": {
507
- "title": "Parameter Serialize Config For Body",
508
- "description": "Top-level paths to use serialization options for.",
509
- "type": "object",
510
- "properties": {
511
- "content": {
512
- "$ref": "#/definitions/parameterSerializeContentOptions"
513
- }
514
- },
515
- "additionalProperties": false
516
- },
517
- "parameterSerializeConfigForPathParams": {
518
- "title": "Parameter Serialize Config For Path Params",
519
- "description": "Top-level paths to use path params serialization options for.",
520
- "type": "object",
521
- "properties": {
522
- "template": {
523
- "description": "For generating the path using tokens frpm the ParameterOps, e.g., '/products/{productId}'",
524
- "type": "string"
525
- },
526
- "defaults": {
527
- "oneOf": [
528
- {
529
- "$ref": "#/definitions/parameterSerializeStyleOptionsForPathParams"
530
- },
531
- {
532
- "$ref": "#/definitions/parameterSerializeContentOptions"
533
- }
534
- ]
535
- },
536
- "paths": {
537
- "type": "object",
538
- "patternProperties": {
539
- "^[^\\n\\r]*$": {
540
- "oneOf": [
541
- {
542
- "$ref": "#/definitions/parameterSerializeStyleOptionsForPathParams"
543
- },
544
- {
545
- "$ref": "#/definitions/parameterSerializeContentOptions"
546
- }
547
- ]
548
- }
549
- }
550
- }
551
- },
552
- "required": ["template"],
553
- "additionalProperties": false
554
- },
555
- "parameterSerializeConfigForSearchParams": {
556
- "title": "Parameter Serialize Config For Search Params",
557
- "description": "Top-level paths to use search params serialization options for.",
558
- "type": "object",
559
- "properties": {
560
- "defaults": {
561
- "oneOf": [
562
- {
563
- "$ref": "#/definitions/parameterSerializeStyleOptionsForSearchParams"
564
- },
565
- {
566
- "$ref": "#/definitions/parameterSerializeContentOptions"
567
- }
568
- ]
569
- },
570
- "paths": {
571
- "type": "object",
572
- "patternProperties": {
573
- "^[^\\n\\r]*$": {
574
- "oneOf": [
575
- {
576
- "$ref": "#/definitions/parameterSerializeStyleOptionsForSearchParams"
577
- },
578
- {
579
- "$ref": "#/definitions/parameterSerializeContentOptions"
580
- }
581
- ]
582
- }
583
- }
584
- }
585
- },
586
- "additionalProperties": false
587
- },
588
- "parameterSerializeConfigForHeaders": {
589
- "title": "Parameter Serialize Config For Headers",
590
- "description": "Top-level paths to use headers serialization options for.",
591
- "type": "object",
592
- "properties": {
593
- "defaults": {
594
- "oneOf": [
595
- {
596
- "$ref": "#/definitions/parameterSerializeStyleOptionsForHeaders"
597
- },
598
- {
599
- "$ref": "#/definitions/parameterSerializeContentOptions"
600
- }
601
- ]
602
- },
603
- "paths": {
604
- "type": "object",
605
- "patternProperties": {
606
- "^[^\\n\\r]*$": {
607
- "oneOf": [
608
- {
609
- "$ref": "#/definitions/parameterSerializeStyleOptionsForHeaders"
610
- },
611
- {
612
- "$ref": "#/definitions/parameterSerializeContentOptions"
613
- }
614
- ]
615
- }
616
- }
617
- }
618
- },
619
- "additionalProperties": false
620
- },
621
- "parameterOpNested": {
622
- "title": "Parameter Op Nested",
623
- "description": "An object describing an operation to generate a parameter, using a nested OpList.",
624
- "type": "object",
625
- "properties": {
626
- "path": {
627
- "description": "A path to the parameter for this operation.",
628
- "type": "string",
629
- "minLength": 1,
630
- "pattern": "^[^\\n\\r]*$"
631
- },
632
- "op": {
633
- "description": "A mode for this parameter's operation.",
634
- "type": "string",
635
- "enum": ["set", "concat", "extend", "remove"]
636
- },
637
- "ops": {
638
- "description": "A nested op list.",
639
- "$ref": "#/definitions/parameterOpList"
640
- }
641
- },
642
- "required": ["path", "ops"],
643
- "additionalProperties": false
644
- },
645
- "parameterOpValue": {
646
- "title": "Parameter Op Value",
647
- "description": "An object describing an operation to generate a parameter using a value.",
648
- "type": "object",
649
- "properties": {
650
- "path": {
651
- "description": "A path to the parameter for this operation.",
652
- "type": "string",
653
- "minLength": 1,
654
- "pattern": "^[^\\n\\r]*$"
655
- },
656
- "op": {
657
- "description": "A mode for this parameter's operation.",
658
- "type": "string",
659
- "enum": ["set", "concat", "extend", "remove"]
660
- },
661
- "value": {
662
- "description": "A value to set directly at this path.",
663
- "type": ["number", "string", "boolean", "object", "array", "null"]
664
- }
665
- },
666
- "required": ["path", "value"],
667
- "additionalProperties": false
668
- },
669
- "parameterOpMapping": {
670
- "title": "Parameter Op Mapping",
671
- "description": "An object describing an operation to generate a parameter using a mapping.",
672
- "type": "object",
673
- "properties": {
674
- "path": {
675
- "description": "A path to the parameter for this operation.",
676
- "type": "string",
677
- "minLength": 1,
678
- "pattern": "^[^\\n\\r]*$"
679
- },
680
- "op": {
681
- "description": "A mode for this parameter's operation.",
682
- "type": "string",
683
- "enum": ["set", "concat", "extend", "remove"]
684
- },
685
- "mapping": {
686
- "description": "Either a valid JSONPath or a directive pipeline to evaluate against the query context.",
687
- "oneOf": [
688
- {
689
- "type": "string",
690
- "minLength": 1
691
- },
692
- {
693
- "$ref": "#/definitions/directiveConfig"
694
- }
695
- ]
696
- }
697
- },
698
- "required": ["path", "mapping"],
699
- "additionalProperties": false
700
- },
701
- "parameterOpOp": {
702
- "title": "Parameter Op Op",
703
- "description": "An object describing an operation to generate a parameter using a mapping.",
704
- "type": "object",
705
- "properties": {
706
- "path": {
707
- "description": "A path to the parameter for this operation.",
708
- "type": "string",
709
- "minLength": 1,
710
- "pattern": "^[^\\n\\r]*$"
711
- },
712
- "op": {
713
- "description": "A mode for this parameter's operation.",
714
- "type": "string",
715
- "enum": ["set", "concat", "extend", "remove"]
716
- }
717
- },
718
- "required": ["path", "op"],
719
- "additionalProperties": false
720
- },
721
- "parameterOp": {
722
- "title": "Parameter Op",
723
- "description": "An object describing an operation to generate a parameter.",
724
- "oneOf": [
725
- {
726
- "$ref": "#/definitions/parameterOpNested"
727
- },
728
- {
729
- "$ref": "#/definitions/parameterOpValue"
730
- },
731
- {
732
- "$ref": "#/definitions/parameterOpMapping"
733
- },
734
- {
735
- "$ref": "#/definitions/parameterOpOp"
736
- }
737
- ]
738
- },
739
- "parameterOpList": {
740
- "title": "Parameter Op List",
741
- "type": "array",
742
- "items": {
743
- "$ref": "#/definitions/parameterOp"
744
- },
745
- "minItems": 1
746
- },
747
- "parameterConfig": {
748
- "title": "Parameter Config",
749
- "description": "All possible options for the more specific ParameterConfig types.",
750
- "type": "object",
751
- "properties": {
752
- "ops": {
753
- "$ref": "#/definitions/parameterOpList"
754
- },
755
- "serialize": {
756
- "$ref": "#/definitions/parameterSerializeConfig"
757
- }
758
- },
759
- "required": ["ops"],
760
- "additionalProperties": false
761
- },
762
- "parameterConfigForBody": {
763
- "title": "Parameter Config For Body",
764
- "type": "object",
765
- "properties": {
766
- "ops": {
767
- "$ref": "#/definitions/parameterOpList"
768
- },
769
- "serialize": {
770
- "$ref": "#/definitions/parameterSerializeConfigForBody"
771
- }
772
- },
773
- "required": ["ops"],
774
- "additionalProperties": false
775
- },
776
- "parameterConfigForPathParams": {
777
- "title": "Parameter Config For Path Params",
778
- "type": "object",
779
- "properties": {
780
- "ops": {
781
- "$ref": "#/definitions/parameterOpList"
782
- },
783
- "serialize": {
784
- "$ref": "#/definitions/parameterSerializeConfigForPathParams"
785
- }
786
- },
787
- "required": ["ops", "serialize"],
788
- "additionalProperties": false
789
- },
790
- "parameterConfigForAwsLambda": {
791
- "title": "ParameterConfigForAwsLambda",
792
- "type": "object",
793
- "properties": {
794
- "ops": {
795
- "$ref": "#/definitions/parameterOpList"
796
- },
797
- "serialize": {
798
- "$ref": "#/definitions/parameterSerializeConfigForPathParams"
799
- }
800
- },
801
- "required": ["ops", "serialize"],
802
- "additionalProperties": false
803
- },
804
- "parameterConfigForSearchParams": {
805
- "title": "Parameter Config For Search Params",
806
- "type": "object",
807
- "properties": {
808
- "ops": {
809
- "$ref": "#/definitions/parameterOpList"
810
- },
811
- "serialize": {
812
- "$ref": "#/definitions/parameterSerializeConfigForSearchParams"
813
- }
814
- },
815
- "required": ["ops"],
816
- "additionalProperties": false
817
- },
818
- "parameterConfigForHeaders": {
819
- "title": "Parameter Config For Headers",
820
- "type": "object",
821
- "properties": {
822
- "ops": {
823
- "$ref": "#/definitions/parameterOpList"
824
- },
825
- "serialize": {
826
- "$ref": "#/definitions/parameterSerializeConfigForHeaders"
827
- }
828
- },
829
- "required": ["ops"],
830
- "additionalProperties": false
831
- },
832
- "parameterConfigForJson": {
833
- "title": "Parameter Config For Json",
834
- "type": "object",
835
- "properties": {
836
- "ops": {
837
- "$ref": "#/definitions/parameterOpList"
838
- }
839
- },
840
- "required": ["ops"],
841
- "additionalProperties": false
842
- },
843
- "directiveConfig": {
844
- "title": "Directive Config",
845
- "description": "An array of individual directive config items to process in order",
846
- "type": "array",
847
- "items": {
848
- "$ref": "#/definitions/directiveConfigItem"
849
- },
850
- "minItems": 1
851
- },
852
- "directiveMappingMap": {
853
- "title": "Directive Mapping Map",
854
- "description": "An map of object keys / key paths to directive configs",
855
- "type": "object",
856
- "patternProperties": {
857
- "[0-9A-Za-z_-]+": {
858
- "$ref": "#/definitions/directiveConfig"
859
- }
860
- }
861
- },
862
- "directiveMappingArrayItem": {
863
- "title": "Directive Mapping Array Item",
864
- "description": "A tuple with a string key and a directive config to evaluate",
865
- "type": "array",
866
- "items": [
867
- {
868
- "type": "string"
869
- },
870
- {
871
- "$ref": "#/definitions/directiveConfig"
872
- }
873
- ]
874
- },
875
- "directiveMappingArray": {
876
- "title": "Directive Mapping Array",
877
- "description": "An array of key / value or directive config tuples",
878
- "type": "array",
879
- "items": {
880
- "$ref": "#/definitions/directiveMappingArrayItem"
881
- }
882
- },
883
- "basicResolver": {
884
- "title": "BasicResolver",
885
- "description": "A single resolver, can be composed with the ComposeResolver.",
886
- "discriminator": {
887
- "propertyName": "name"
888
- },
889
- "oneOf": [
890
- {
891
- "$ref": "#/definitions/utilResolver"
892
- },
893
- {
894
- "$ref": "#/definitions/delegateResolver"
895
- },
896
- {
897
- "$ref": "#/definitions/takeshapeResolver"
898
- },
899
- {
900
- "$ref": "#/definitions/shapedbResolver"
901
- },
902
- {
903
- "$ref": "#/definitions/shapedbResolverShapeNameNotRequired"
904
- },
905
- {
906
- "$ref": "#/definitions/graphqlResolver"
907
- },
908
- {
909
- "$ref": "#/definitions/restResolver"
910
- },
911
- {
912
- "$ref": "#/definitions/awsLambdaResolver"
913
- },
914
- {
915
- "$ref": "#/definitions/salsifyResolver"
916
- },
917
- {
918
- "$ref": "#/definitions/syndigoResolver"
919
- },
920
- {
921
- "$ref": "#/definitions/functionResolver"
922
- },
923
- {
924
- "$ref": "#/definitions/aiGenerateTextResolver"
925
- },
926
- {
927
- "$ref": "#/definitions/aiGeneratePropertyResolver"
928
- },
929
- {
930
- "$ref": "#/definitions/aiEmbeddingResolver"
931
- },
932
- {
933
- "$ref": "#/definitions/aiEmbeddingSearchResolver"
934
- },
935
- {
936
- "$ref": "#/definitions/aiParseFileResolver"
937
- },
938
- {
939
- "$ref": "#/definitions/utilChunkResolver"
940
- },
941
- {
942
- "$ref": "#/definitions/aiRunAgentResolver"
943
- },
944
- {
945
- "$ref": "#/definitions/aiInspectAgentResolver"
946
- },
947
- {
948
- "$ref": "#/definitions/aiCreateAgentSessionResolver"
949
- },
950
- {
951
- "$ref": "#/definitions/aiGetAgentMessageResolver"
952
- },
953
- {
954
- "$ref": "#/definitions/aiAbortAgentMessageResolver"
955
- },
956
- {
957
- "$ref": "#/definitions/aiSendAgentFeedbackResolver"
958
- }
959
- ]
960
- },
961
- "serviceResolver": {
962
- "title": "ServiceResolver",
963
- "description": "A resolver which references a specific service",
964
- "discriminator": {
965
- "propertyName": "name"
966
- },
967
- "oneOf": [
968
- {
969
- "$ref": "#/definitions/takeshapeResolver"
970
- },
971
- {
972
- "$ref": "#/definitions/shapedbResolverShapeNameNotRequired"
973
- },
974
- {
975
- "$ref": "#/definitions/shapedbResolver"
976
- },
977
- {
978
- "$ref": "#/definitions/graphqlResolver"
979
- },
980
- {
981
- "$ref": "#/definitions/restResolver"
982
- },
983
- {
984
- "$ref": "#/definitions/awsLambdaResolver"
985
- }
986
- ]
987
- },
988
- "argsMapping": {
989
- "title": "ArgsMapping",
990
- "description": "Maps a query's input args to the input expected by the service's endpoint.",
991
- "oneOf": [
992
- {
993
- "$ref": "#/definitions/directiveMappingMap"
994
- },
995
- {
996
- "$ref": "#/definitions/directiveConfig"
997
- }
998
- ]
999
- },
1000
- "searchParamsMapping": {
1001
- "title": "SearchParamsMapping",
1002
- "description": "Set or evaluate directives to generate searchParams for the service endpoint.",
1003
- "$ref": "#/definitions/directiveMappingArray"
1004
- },
1005
- "resultsMapping": {
1006
- "title": "ResultsMapping",
1007
- "description": "Maps a service endpoint's response results to the expected shape of the query's response.",
1008
- "oneOf": [
1009
- {
1010
- "$ref": "#/definitions/directiveMappingMap"
1011
- },
1012
- {
1013
- "$ref": "#/definitions/directiveConfig"
1014
- }
1015
- ]
1016
- },
1017
- "utilResolver": {
1018
- "title": "UtilResolver",
1019
- "type": "object",
1020
- "properties": {
1021
- "if": {
1022
- "type": "string"
1023
- },
1024
- "id": {
1025
- "type": "string",
1026
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1027
- },
1028
- "name": {
1029
- "title": "UtilResolverName",
1030
- "type": "string",
1031
- "description": "Name of the resolver function.",
1032
- "enum": ["util:noop", "util:wrap"]
1033
- },
1034
- "options": {
1035
- "title": "UtilResolverOptions",
1036
- "type": "object",
1037
- "additionalProperties": true
1038
- },
1039
- "value": {
1040
- "description": "Optional value to return from the noop resolver.",
1041
- "type": ["number", "string", "boolean", "object", "array", "null"]
1042
- },
1043
- "args": {
1044
- "description": "Mapping and serialization configuration for args.",
1045
- "$ref": "#/definitions/parameterConfigForJson"
1046
- },
1047
- "results": {
1048
- "description": "Mapping configuration for the results of this resolver step.",
1049
- "$ref": "#/definitions/parameterConfigForJson"
1050
- },
1051
- "argsMapping": {
1052
- "$ref": "#/definitions/argsMapping"
1053
- },
1054
- "resultsMapping": {
1055
- "$ref": "#/definitions/resultsMapping"
1056
- }
1057
- },
1058
- "required": ["name"],
1059
- "additionalProperties": false
1060
- },
1061
- "utilChunkResolver": {
1062
- "title": "ChunkResolver",
1063
- "type": "object",
1064
- "properties": {
1065
- "if": {
1066
- "type": "string"
1067
- },
1068
- "id": {
1069
- "type": "string",
1070
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1071
- },
1072
- "name": {
1073
- "title": "UtilResolverName",
1074
- "type": "string",
1075
- "description": "Name of the resolver function.",
1076
- "enum": ["util:chunk"]
1077
- },
1078
- "options": {
1079
- "$ref": "#/definitions/utilChunkResolverOptions"
1080
- },
1081
- "args": {
1082
- "description": "Mapping and serialization configuration for args.",
1083
- "$ref": "#/definitions/parameterConfigForJson"
1084
- },
1085
- "results": {
1086
- "description": "Mapping configuration for the results of this resolver step.",
1087
- "$ref": "#/definitions/parameterConfigForJson"
1088
- }
1089
- },
1090
- "required": ["name", "options"],
1091
- "additionalProperties": false
1092
- },
1093
- "utilChunkResolverOptions": {
1094
- "title": "UtilChunkResolverOptions",
1095
- "oneOf": [
1096
- {
1097
- "$ref": "#/definitions/utilChunkResolverOptionsCharacterCount"
1098
- },
1099
- {
1100
- "$ref": "#/definitions/utilChunkResolverOptionsSeparators"
1101
- },
1102
- {
1103
- "$ref": "#/definitions/utilChunkResolverOptionsMarkdown"
1104
- },
1105
- {
1106
- "$ref": "#/definitions/utilChunkResolverOptionsSemantic"
1107
- }
1108
- ]
1109
- },
1110
- "utilChunkResolverOptionsCharacterCount": {
1111
- "title": "UtilChunkResolverOptionsCharacterCount",
1112
- "type": "object",
1113
- "properties": {
1114
- "type": {
1115
- "enum": ["characterCount"]
1116
- },
1117
- "characterCount": {
1118
- "type": "integer",
1119
- "minimum": 1
1120
- }
1121
- },
1122
- "required": ["type", "characterCount"],
1123
- "additionalProperties": false
1124
- },
1125
- "utilChunkResolverOptionsSeparators": {
1126
- "title": "UtilChunkResolverOptionsSeparators",
1127
- "type": "object",
1128
- "properties": {
1129
- "type": {
1130
- "enum": ["separators"]
1131
- },
1132
- "separators": {
1133
- "type": "array",
1134
- "minItems": 1,
1135
- "items": {
1136
- "type": "string",
1137
- "minLength": 1
1138
- }
1139
- }
1140
- },
1141
- "required": ["type", "separators"],
1142
- "additionalProperties": false
1143
- },
1144
- "utilChunkResolverOptionsMarkdown": {
1145
- "title": "UtilChunkResolverOptionsMarkdown",
1146
- "type": "object",
1147
- "properties": {
1148
- "type": {
1149
- "enum": ["markdown"]
1150
- },
1151
- "headerLevel": {
1152
- "description": "New chunks will be created at headers for this level or lower. Default 2.",
1153
- "type": "integer",
1154
- "minimum": 1
1155
- },
1156
- "maxCharacters": {
1157
- "description": "A new chunk will be started when this number of characters is reached, regardless of markup.",
1158
- "type": "integer",
1159
- "minimum": 1
1160
- }
1161
- },
1162
- "required": ["type"],
1163
- "additionalProperties": false
1164
- },
1165
- "utilChunkResolverOptionsSemantic": {
1166
- "title": "UtilChunkResolverOptionsSemantic",
1167
- "type": "object",
1168
- "properties": {
1169
- "type": {
1170
- "enum": ["semantic"]
1171
- },
1172
- "serviceId": {
1173
- "type": "string"
1174
- },
1175
- "modelId": {
1176
- "type": "string"
1177
- },
1178
- "similarityThreshold": {
1179
- "description": "Similarity below which two embeddings are considered different.",
1180
- "type": "number",
1181
- "minimum": 0,
1182
- "maximum": 1
1183
- },
1184
- "stride": {
1185
- "description": "Advanced. How many sentences to advance when grouping sentences to create embeddings. Default 1.",
1186
- "type": "integer",
1187
- "minimum": 1
1188
- },
1189
- "sentenceCount": {
1190
- "description": "Advanced. How many sentences are grouped together to create embeddings. Default 3.",
1191
- "type": "integer",
1192
- "minimum": 1
1193
- },
1194
- "maxCharacters": {
1195
- "description": "The maximum number of characters in a chunk.",
1196
- "type": "integer",
1197
- "min": 1
1198
- },
1199
- "maxTokens": {
1200
- "description": "The maximum number of tokens in a chunk.",
1201
- "type": "integer",
1202
- "min": 1
1203
- }
1204
- },
1205
- "required": ["type", "serviceId", "modelId"],
1206
- "additionalProperties": false
1207
- },
1208
- "functionResolver": {
1209
- "title": "FunctionResolver",
1210
- "type": "object",
1211
- "properties": {
1212
- "if": {
1213
- "type": "string"
1214
- },
1215
- "id": {
1216
- "type": "string",
1217
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1218
- },
1219
- "name": {
1220
- "title": "FunctionResolverName",
1221
- "type": "string",
1222
- "description": "Name of the resolver function.",
1223
- "enum": ["function:run"]
1224
- },
1225
- "options": {
1226
- "title": "FunctionResolverOptions",
1227
- "type": "object",
1228
- "additionalProperties": true
1229
- },
1230
- "args": {
1231
- "description": "Mapping and serialization configuration for args.",
1232
- "$ref": "#/definitions/parameterConfigForJson"
1233
- },
1234
- "results": {
1235
- "description": "Mapping configuration for the results of this resolver step.",
1236
- "$ref": "#/definitions/parameterConfigForJson"
1237
- },
1238
- "argsMapping": {
1239
- "$ref": "#/definitions/argsMapping"
1240
- },
1241
- "resultsMapping": {
1242
- "$ref": "#/definitions/resultsMapping"
1243
- },
1244
- "javascript": {
1245
- "title": "FunctionResolverJavascript",
1246
- "type": "string"
1247
- }
1248
- },
1249
- "required": ["name"],
1250
- "additionalProperties": false
1251
- },
1252
- "delegateResolver": {
1253
- "title": "DelegateResolver",
1254
- "type": "object",
1255
- "properties": {
1256
- "if": {
1257
- "type": "string"
1258
- },
1259
- "id": {
1260
- "type": "string",
1261
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1262
- },
1263
- "name": {
1264
- "title": "Delegate Resolver Name",
1265
- "type": "string",
1266
- "description": "Name of the resolver function.",
1267
- "enum": ["delegate"]
1268
- },
1269
- "options": {
1270
- "title": "DelegateResolverOptions",
1271
- "type": "object",
1272
- "additionalProperties": true
1273
- },
1274
- "argsMapping": {
1275
- "$ref": "#/definitions/argsMapping"
1276
- },
1277
- "resultsMapping": {
1278
- "$ref": "#/definitions/resultsMapping"
1279
- },
1280
- "to": {
1281
- "description": "A ref to a query/mutation/property to delegate to.",
1282
- "type": "string",
1283
- "minLength": 1
1284
- },
1285
- "args": {
1286
- "description": "Mapping and serialization configuration for args.",
1287
- "$ref": "#/definitions/parameterConfigForJson"
1288
- },
1289
- "results": {
1290
- "description": "Mapping configuration for the results of this resolver step.",
1291
- "$ref": "#/definitions/parameterConfigForJson"
1292
- }
1293
- },
1294
- "required": ["name", "to"],
1295
- "additionalProperties": false
1296
- },
1297
- "salsifyResolver": {
1298
- "title": "SalsifyResolver",
1299
- "type": "object",
1300
- "properties": {
1301
- "if": {
1302
- "type": "string"
1303
- },
1304
- "id": {
1305
- "type": "string",
1306
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1307
- },
1308
- "name": {
1309
- "title": "Salsify Resolver Name",
1310
- "type": "string",
1311
- "description": "Name of the resolver function.",
1312
- "enum": ["salsify:listChannelProducts"]
1313
- },
1314
- "service": {
1315
- "type": "string",
1316
- "description": "Configuration for a service to use with this resolver."
1317
- },
1318
- "options": {
1319
- "title": "SalsifyResolverOptions",
1320
- "type": "object",
1321
- "additionalProperties": true
1322
- },
1323
- "args": {
1324
- "description": "Mapping and serialization configuration for args.",
1325
- "$ref": "#/definitions/parameterConfigForJson"
1326
- },
1327
- "results": {
1328
- "description": "Mapping configuration for the results of this resolver step.",
1329
- "$ref": "#/definitions/parameterConfigForJson"
1330
- },
1331
- "argsMapping": {
1332
- "$ref": "#/definitions/argsMapping"
1333
- },
1334
- "resultsMapping": {
1335
- "$ref": "#/definitions/resultsMapping"
1336
- }
1337
- },
1338
- "required": ["name", "service"],
1339
- "additionalProperties": false
1340
- },
1341
- "syndigoResolver": {
1342
- "title": "SyndigoResolver",
1343
- "type": "object",
1344
- "properties": {
1345
- "if": {
1346
- "type": "string"
1347
- },
1348
- "id": {
1349
- "type": "string",
1350
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1351
- },
1352
- "name": {
1353
- "title": "Syndigo Resolver Name",
1354
- "type": "string",
1355
- "description": "Name of the resolver function.",
1356
- "enum": ["syndigo:searchProducts"]
1357
- },
1358
- "service": {
1359
- "type": "string",
1360
- "description": "Configuration for a service to use with this resolver."
1361
- },
1362
- "options": {
1363
- "title": "SyndigoResolverOptions",
1364
- "type": "object",
1365
- "additionalProperties": true
1366
- },
1367
- "args": {
1368
- "description": "Mapping and serialization configuration for args.",
1369
- "$ref": "#/definitions/parameterConfigForJson"
1370
- },
1371
- "results": {
1372
- "description": "Mapping configuration for the results of this resolver step.",
1373
- "$ref": "#/definitions/parameterConfigForJson"
1374
- },
1375
- "argsMapping": {
1376
- "$ref": "#/definitions/argsMapping"
1377
- },
1378
- "resultsMapping": {
1379
- "$ref": "#/definitions/resultsMapping"
1380
- }
1381
- },
1382
- "required": ["name", "service"],
1383
- "additionalProperties": false
1384
- },
1385
- "shapedbResolver": {
1386
- "title": "ShapedbResolver",
1387
- "type": "object",
1388
- "properties": {
1389
- "if": {
1390
- "type": "string"
1391
- },
1392
- "id": {
1393
- "type": "string",
1394
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1395
- },
1396
- "name": {
1397
- "title": "ShapedbResolverName",
1398
- "type": "string",
1399
- "description": "Name of the resolver function.",
1400
- "enum": [
1401
- "shapedb:get",
1402
- "shapedb:create",
1403
- "shapedb:update",
1404
- "shapedb:delete",
1405
- "shapedb:duplicate",
1406
- "shapedb:find"
1407
- ]
1408
- },
1409
- "service": {
1410
- "type": "string",
1411
- "description": "Internal service identifier.",
1412
- "enum": ["shapedb"]
1413
- },
1414
- "options": {
1415
- "title": "ShapedbResolverOptions",
1416
- "type": "object",
1417
- "additionalProperties": true
1418
- },
1419
- "argsMapping": {
1420
- "$ref": "#/definitions/argsMapping"
1421
- },
1422
- "resultsMapping": {
1423
- "$ref": "#/definitions/resultsMapping"
1424
- },
1425
- "shapeName": {
1426
- "description": "A Shape name for the resolver to use.",
1427
- "type": "string",
1428
- "minLength": 1
1429
- },
1430
- "args": {
1431
- "description": "Mapping and serialization configuration for args.",
1432
- "$ref": "#/definitions/parameterConfigForJson"
1433
- },
1434
- "results": {
1435
- "description": "Mapping configuration for the results of this resolver step.",
1436
- "$ref": "#/definitions/parameterConfigForJson"
1437
- }
1438
- },
1439
- "required": ["name", "service", "shapeName"],
1440
- "additionalProperties": false
1441
- },
1442
- "shapedbResolverShapeNameNotRequired": {
1443
- "title": "ShapedbResolverShapeNameNotRequired",
1444
- "type": "object",
1445
- "properties": {
1446
- "if": {
1447
- "type": "string"
1448
- },
1449
- "id": {
1450
- "type": "string",
1451
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1452
- },
1453
- "name": {
1454
- "title": "ShapedbResolverShapeNameNotRequiredName",
1455
- "type": "string",
1456
- "description": "Name of the resolver function.",
1457
- "enum": ["shapedb:list", "shapedb:taxonomySuggest", "shapedb:getRelated"]
1458
- },
1459
- "service": {
1460
- "type": "string",
1461
- "description": "Internal service identifier.",
1462
- "enum": ["shapedb"]
1463
- },
1464
- "options": {
1465
- "title": "ShapedbResolverShapeNameNotRequiredOptions",
1466
- "type": "object",
1467
- "additionalProperties": true
1468
- },
1469
- "shapeName": {
1470
- "description": "An optional Shape name for the resolver.",
1471
- "type": "string",
1472
- "minLength": 1
1473
- },
1474
- "args": {
1475
- "description": "Mapping and serialization configuration for args.",
1476
- "$ref": "#/definitions/parameterConfigForJson"
1477
- },
1478
- "results": {
1479
- "description": "Mapping configuration for the results of this resolver step.",
1480
- "$ref": "#/definitions/parameterConfigForJson"
1481
- },
1482
- "argsMapping": {
1483
- "$ref": "#/definitions/argsMapping"
1484
- },
1485
- "resultsMapping": {
1486
- "$ref": "#/definitions/resultsMapping"
1487
- }
1488
- },
1489
- "required": ["name", "service"],
1490
- "additionalProperties": false
1491
- },
1492
- "aiToolConfig": {
1493
- "title": "AIToolConfig",
1494
- "type": "object",
1495
- "properties": {
1496
- "ref": {
1497
- "type": "string"
1498
- },
1499
- "selectionSet": {
1500
- "type": "string"
1501
- }
1502
- },
1503
- "required": ["ref"],
1504
- "additionalProperties": false
1505
- },
1506
- "aiSimilarityGuardrail": {
1507
- "title": "AISimilarityGuardrail",
1508
- "type": "object",
1509
- "properties": {
1510
- "name": {
1511
- "enum": ["similarity"]
1512
- },
1513
- "shape": {
1514
- "type": "string"
1515
- },
1516
- "defaultResponse": {
1517
- "type": "string"
1518
- },
1519
- "threshold": {
1520
- "type": "number"
1521
- }
1522
- },
1523
- "required": ["name", "shape", "defaultResponse"],
1524
- "additionalProperties": false
1525
- },
1526
- "aiGuardrail": {
1527
- "title": "AIGuardrail",
1528
- "discriminator": {
1529
- "propertyName": "name"
1530
- },
1531
- "oneOf": [
1532
- {
1533
- "$ref": "#/definitions/aiSimilarityGuardrail"
1534
- }
1535
- ]
1536
- },
1537
- "aiGenerateTextResolverOptions": {
1538
- "title": "AIGenerateTextResolverOptions",
1539
- "type": "object",
1540
- "properties": {
1541
- "history": {
1542
- "title": "history",
1543
- "type": "boolean"
1544
- },
1545
- "maxTokens": {
1546
- "type": "integer",
1547
- "title": "Maximum Tokens",
1548
- "description": "Maximum number of tokens to generate."
1549
- },
1550
- "temperature": {
1551
- "type": "number",
1552
- "title": "Temperature",
1553
- "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",
1554
- "minimum": 0,
1555
- "maximum": 1
1556
- },
1557
- "topP": {
1558
- "type": "number",
1559
- "title": "Top P",
1560
- "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.",
1561
- "minimum": 0,
1562
- "maximum": 1
1563
- },
1564
- "topK": {
1565
- "type": "number",
1566
- "title": "Top K",
1567
- "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."
1568
- },
1569
- "presencePenalty": {
1570
- "type": "number",
1571
- "title": "Presence penalty setting",
1572
- "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.",
1573
- "minimum": -1,
1574
- "maximum": 1
1575
- },
1576
- "frequencyPenalty": {
1577
- "type": "number",
1578
- "title": "Frequency penalty setting",
1579
- "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.",
1580
- "minimum": -1,
1581
- "maximum": 1
1582
- },
1583
- "stopSequences": {
1584
- "title": "Stop sequences",
1585
- "description": "If set, the model will stop generating text when one of the stop sequences is generated.",
1586
- "type": "array",
1587
- "items": {
1588
- "type": "string"
1589
- }
1590
- },
1591
- "seed": {
1592
- "type": "integer",
1593
- "title": "Seed",
1594
- "description": " The seed (integer) to use for random sampling. If set and supported by the model, calls will generate deterministic results."
1595
- },
1596
- "maxRetries": {
1597
- "type": "integer",
1598
- "description": "Maximum number of retries. Set to 0 to disable retries. Defaults to 2"
1599
- },
1600
- "toolChoice": {
1601
- "type": "string",
1602
- "description": "The tool choice strategy. Default: 'auto'",
1603
- "anyOf": [
1604
- {
1605
- "enum": ["auto", "none", "required"]
1606
- },
1607
- {
1608
- "type": "string"
1609
- }
1610
- ]
1611
- },
1612
- "maxToolRoundtrips": {
1613
- "type": "integer",
1614
- "description": "Maximal number of automatic roundtrips for tool calls."
1615
- }
1616
- }
1617
- },
1618
- "aiGenerateTextResolver": {
1619
- "title": "AIGenerateTextResolver",
1620
- "type": "object",
1621
- "properties": {
1622
- "if": {
1623
- "type": "string"
1624
- },
1625
- "id": {
1626
- "type": "string",
1627
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1628
- },
1629
- "name": {
1630
- "title": "AI Resolver Name",
1631
- "type": "string",
1632
- "description": "Name of the resolver function.",
1633
- "enum": ["ai:generateText", "ai:chat"]
1634
- },
1635
- "service": {
1636
- "type": "string",
1637
- "description": "Configuration for a service to use with this resolver."
1638
- },
1639
- "options": {
1640
- "$ref": "#/definitions/aiGenerateTextResolverOptions"
1641
- },
1642
- "systemPrompt": {
1643
- "type": "string"
1644
- },
1645
- "inputTemplate": {
1646
- "type": "string"
1647
- },
1648
- "model": {
1649
- "type": "string"
1650
- },
1651
- "tools": {
1652
- "type": "array",
1653
- "items": {
1654
- "oneOf": [
1655
- {
1656
- "type": "string"
1657
- },
1658
- {
1659
- "$ref": "#/definitions/aiToolConfig"
1660
- }
1661
- ]
1662
- }
1663
- },
1664
- "guardrails": {
1665
- "type": "array",
1666
- "items": {
1667
- "$ref": "#/definitions/aiGuardrail"
1668
- }
1669
- },
1670
- "context": {
1671
- "description": "Mapping and serialization configuration for prompt context.",
1672
- "$ref": "#/definitions/parameterConfigForJson"
1673
- },
1674
- "results": {
1675
- "description": "Mapping configuration for the results of this resolver step.",
1676
- "$ref": "#/definitions/parameterConfigForJson"
1677
- }
1678
- },
1679
- "required": ["name", "service", "model", "systemPrompt"],
1680
- "additionalProperties": false
1681
- },
1682
- "aiGeneratePropertyResolver": {
1683
- "title": "AIGeneratePropertyResolver",
1684
- "type": "object",
1685
- "properties": {
1686
- "id": {
1687
- "type": "string",
1688
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1689
- },
1690
- "name": {
1691
- "title": "AI Resolver Name",
1692
- "type": "string",
1693
- "description": "Name of the resolver function.",
1694
- "enum": ["ai:generateProperty"]
1695
- },
1696
- "service": {
1697
- "type": "string",
1698
- "description": "Configuration for a service to use with this resolver."
1699
- },
1700
- "model": {
1701
- "type": "string"
1702
- },
1703
- "systemPrompt": {
1704
- "type": "string"
1705
- }
1706
- },
1707
- "required": ["name", "service", "model"],
1708
- "additionalProperties": false
1709
- },
1710
- "aiEmbeddingResolverOptions": {
1711
- "title": "AIEmbeddingResolverOptions",
1712
- "type": "object",
1713
- "properties": {
1714
- "useDependencies": {
1715
- "type": "boolean"
1716
- }
1717
- }
1718
- },
1719
- "aiEmbeddingResolver": {
1720
- "title": "AIEmbeddingResolver",
1721
- "type": "object",
1722
- "properties": {
1723
- "if": {
1724
- "type": "string"
1725
- },
1726
- "id": {
1727
- "type": "string",
1728
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1729
- },
1730
- "name": {
1731
- "title": "AI Resolver Name",
1732
- "type": "string",
1733
- "description": "Name of the resolver function.",
1734
- "enum": ["ai:createEmbedding"]
1735
- },
1736
- "service": {
1737
- "type": "string",
1738
- "description": "Configuration for a service to use with this resolver."
1739
- },
1740
- "options": {
1741
- "$ref": "#/definitions/aiEmbeddingResolverOptions"
1742
- },
1743
- "model": {
1744
- "type": "string"
1745
- },
1746
- "args": {
1747
- "description": "Mapping and serialization configuration for prompt context.",
1748
- "$ref": "#/definitions/parameterConfigForJson"
1749
- },
1750
- "results": {
1751
- "description": "Mapping configuration for the results of this resolver step.",
1752
- "$ref": "#/definitions/parameterConfigForJson"
1753
- }
1754
- },
1755
- "required": ["name", "service", "model"],
1756
- "additionalProperties": false
1757
- },
1758
- "aiEmbeddingSearchResolver": {
1759
- "title": "AIEmbeddingSearchResolver",
1760
- "type": "object",
1761
- "properties": {
1762
- "if": {
1763
- "type": "string"
1764
- },
1765
- "id": {
1766
- "type": "string",
1767
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1768
- },
1769
- "name": {
1770
- "title": "AI Resolver Name",
1771
- "type": "string",
1772
- "description": "Name of the resolver function.",
1773
- "enum": ["ai:embeddingSearch"]
1774
- },
1775
- "vectorProperty": {
1776
- "type": "string",
1777
- "description": "A vector property ref to use for the query."
1778
- },
1779
- "args": {
1780
- "description": "Mapping and serialization configuration for prompt context.",
1781
- "$ref": "#/definitions/parameterConfigForJson"
1782
- },
1783
- "results": {
1784
- "description": "Mapping configuration for the results of this resolver step.",
1785
- "$ref": "#/definitions/parameterConfigForJson"
1786
- }
1787
- },
1788
- "required": ["name", "vectorProperty"],
1789
- "additionalProperties": false
1790
- },
1791
- "aiParseFileResolverOptions": {
1792
- "title": "AIParseFileResolverOptions",
1793
- "type": "object"
1794
- },
1795
- "aiParseFileResolver": {
1796
- "title": "AIParseFileResolver",
1797
- "type": "object",
1798
- "properties": {
1799
- "if": {
1800
- "type": "string"
1801
- },
1802
- "id": {
1803
- "type": "string",
1804
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1805
- },
1806
- "name": {
1807
- "title": "AI Resolver Name",
1808
- "type": "string",
1809
- "description": "Name of the resolver function.",
1810
- "enum": ["ai:parseFile"]
1811
- },
1812
- "service": {
1813
- "type": "string",
1814
- "description": "Configuration for a service to use with this resolver."
1815
- },
1816
- "options": {
1817
- "$ref": "#/definitions/aiEmbeddingResolverOptions"
1818
- },
1819
- "args": {
1820
- "description": "Mapping and serialization configuration for prompt context.",
1821
- "$ref": "#/definitions/parameterConfigForJson"
1822
- },
1823
- "results": {
1824
- "description": "Mapping configuration for the results of this resolver step.",
1825
- "$ref": "#/definitions/parameterConfigForJson"
1826
- }
1827
- },
1828
- "required": ["name", "service"],
1829
- "additionalProperties": false
1830
- },
1831
- "takeshapeResolver": {
1832
- "title": "TakeshapeResolver",
1833
- "type": "object",
1834
- "properties": {
1835
- "if": {
1836
- "type": "string"
1837
- },
1838
- "id": {
1839
- "type": "string",
1840
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1841
- },
1842
- "name": {
1843
- "title": "TakeshapeResolverName",
1844
- "type": "string",
1845
- "description": "Name of the resolver function.",
1846
- "enum": [
1847
- "takeshape:get",
1848
- "takeshape:getUser",
1849
- "takeshape:search",
1850
- "takeshape:vectorSearch",
1851
- "takeshape:queryApiIndex",
1852
- "takeshape:assetUrl",
1853
- "takeshape:assetImage",
1854
- "takeshape:assetImageMeta"
1855
- ]
1856
- },
1857
- "service": {
1858
- "type": "string",
1859
- "description": "Internal service identifier.",
1860
- "enum": ["takeshape"]
1861
- },
1862
- "options": {
1863
- "title": "TakeshapeResolverOptions",
1864
- "type": "object",
1865
- "additionalProperties": true
1866
- },
1867
- "shapeName": {
1868
- "description": "An optional Shape name for the resolver.",
1869
- "type": "string",
1870
- "minLength": 1
1871
- },
1872
- "args": {
1873
- "description": "Mapping and serialization configuration for args.",
1874
- "$ref": "#/definitions/parameterConfigForJson"
1875
- },
1876
- "results": {
1877
- "description": "Mapping configuration for the results of this resolver step.",
1878
- "$ref": "#/definitions/parameterConfigForJson"
1879
- },
1880
- "argsMapping": {
1881
- "$ref": "#/definitions/argsMapping"
1882
- },
1883
- "resultsMapping": {
1884
- "$ref": "#/definitions/resultsMapping"
1885
- }
1886
- },
1887
- "required": ["name", "service"],
1888
- "additionalProperties": false
1889
- },
1890
- "graphqlResolver": {
1891
- "title": "GraphqlResolver",
1892
- "type": "object",
1893
- "properties": {
1894
- "if": {
1895
- "type": "string"
1896
- },
1897
- "id": {
1898
- "type": "string",
1899
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1900
- },
1901
- "name": {
1902
- "title": "GraphqlResolverName",
1903
- "type": "string",
1904
- "description": "Name of the resolver function.",
1905
- "enum": ["graphql:query", "graphql:mutation", "shopify:bulkQuery"]
1906
- },
1907
- "service": {
1908
- "type": "string",
1909
- "description": "Configuration for a service to use with this resolver."
1910
- },
1911
- "argsMapping": {
1912
- "$ref": "#/definitions/argsMapping"
1913
- },
1914
- "resultsMapping": {
1915
- "$ref": "#/definitions/resultsMapping"
1916
- },
1917
- "options": {
1918
- "title": "GraphqlResolverOptions",
1919
- "type": "object",
1920
- "properties": {
1921
- "selectionSet": {
1922
- "type": "string"
1923
- },
1924
- "unboxParentSelectionSet": {
1925
- "type": "boolean"
1926
- },
1927
- "ignoreErrors": {
1928
- "type": "boolean"
1929
- },
1930
- "skipWhenMissingArgs": {
1931
- "type": "boolean"
1932
- },
1933
- "ttl": {
1934
- "type": "number"
1935
- },
1936
- "timeout": {
1937
- "type": "number"
1938
- },
1939
- "allowStream": {
1940
- "type": "boolean"
1941
- },
1942
- "retry": {
1943
- "oneOf": [
1944
- {
1945
- "type": "number"
1946
- },
1947
- {
1948
- "type": "object"
1949
- }
1950
- ]
1951
- }
1952
- },
1953
- "additionalProperties": true
1954
- },
1955
- "fieldName": {
1956
- "description": "A fieldname to use in queries.",
1957
- "type": "string"
1958
- },
1959
- "headers": {
1960
- "description": "Mapping and serialization configuration for headers.",
1961
- "$ref": "#/definitions/parameterConfigForHeaders"
1962
- },
1963
- "searchParams": {
1964
- "description": "Mapping and serialization configuration for searchParams.",
1965
- "$ref": "#/definitions/parameterConfigForSearchParams"
1966
- },
1967
- "args": {
1968
- "description": "Mapping and serialization configuration for args.",
1969
- "$ref": "#/definitions/parameterConfigForJson"
1970
- },
1971
- "results": {
1972
- "description": "Mapping configuration for the results of this resolver step.",
1973
- "$ref": "#/definitions/parameterConfigForJson"
1974
- }
1975
- },
1976
- "required": ["name", "service", "fieldName"],
1977
- "additionalProperties": false
1978
- },
1979
- "restResolver": {
1980
- "title": "RestResolver",
1981
- "type": "object",
1982
- "properties": {
1983
- "if": {
1984
- "type": "string"
1985
- },
1986
- "id": {
1987
- "type": "string",
1988
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
1989
- },
1990
- "name": {
1991
- "title": "RestResolverName",
1992
- "type": "string",
1993
- "description": "Name of the resolver function.",
1994
- "enum": ["rest:get", "rest:head", "rest:post", "rest:put", "rest:patch", "rest:delete"]
1995
- },
1996
- "service": {
1997
- "type": "string",
1998
- "description": "Configuration for a service to use with this resolver."
1999
- },
2000
- "argsMapping": {
2001
- "$ref": "#/definitions/argsMapping"
2002
- },
2003
- "searchParamsMapping": {
2004
- "$ref": "#/definitions/searchParamsMapping"
2005
- },
2006
- "resultsMapping": {
2007
- "$ref": "#/definitions/resultsMapping"
2008
- },
2009
- "options": {
2010
- "title": "RestResolverOptions",
2011
- "type": "object",
2012
- "properties": {
2013
- "trailingSlash": {
2014
- "type": "boolean"
2015
- },
2016
- "allowStream": {
2017
- "type": "boolean"
2018
- },
2019
- "ttl": {
2020
- "type": "number"
2021
- },
2022
- "timeout": {
2023
- "type": "number"
2024
- },
2025
- "retry": {
2026
- "oneOf": [
2027
- {
2028
- "type": "number"
2029
- },
2030
- {
2031
- "type": "object"
2032
- }
2033
- ]
2034
- }
2035
- },
2036
- "additionalProperties": true
2037
- },
2038
- "body": {
2039
- "description": "Mapping and serialization configuration for a request body.",
2040
- "$ref": "#/definitions/parameterConfigForBody"
2041
- },
2042
- "form": {
2043
- "description": "Mapping and serialization configuration for form data.",
2044
- "$ref": "#/definitions/parameterConfigForSearchParams"
2045
- },
2046
- "headers": {
2047
- "description": "Mapping and serialization configuration for headers.",
2048
- "$ref": "#/definitions/parameterConfigForHeaders"
2049
- },
2050
- "json": {
2051
- "description": "Mapping and serialization configuration for a json request body.",
2052
- "$ref": "#/definitions/parameterConfigForJson"
2053
- },
2054
- "path": {
2055
- "description": "Mapping and serialization configuration for the path, or a simple string.",
2056
- "oneOf": [
2057
- {
2058
- "$ref": "#/definitions/parameterConfigForPathParams"
2059
- },
2060
- {
2061
- "type": "string"
2062
- }
2063
- ]
2064
- },
2065
- "searchParams": {
2066
- "description": "Mapping and serialization configuration for searchParams.",
2067
- "$ref": "#/definitions/parameterConfigForSearchParams"
2068
- },
2069
- "args": {
2070
- "description": "Mapping and serialization configuration for args.",
2071
- "$ref": "#/definitions/parameterConfigForJson"
2072
- },
2073
- "results": {
2074
- "description": "Mapping configuration for the results of this resolver step.",
2075
- "$ref": "#/definitions/parameterConfigForJson"
2076
- }
2077
- },
2078
- "required": ["name", "service", "path"],
2079
- "additionalProperties": false
2080
- },
2081
- "awsLambdaResolver": {
2082
- "title": "AwsLambdaResolver",
2083
- "type": "object",
2084
- "properties": {
2085
- "if": {
2086
- "type": "string"
2087
- },
2088
- "id": {
2089
- "type": "string",
2090
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
2091
- },
2092
- "name": {
2093
- "title": "AwsLambdaResolverName",
2094
- "type": "string",
2095
- "description": "Name of the resolver function.",
2096
- "enum": ["awsLambda:invoke"]
2097
- },
2098
- "service": {
2099
- "type": "string",
2100
- "description": "Configuration for a service to use with this resolver."
2101
- },
2102
- "options": {
2103
- "title": "AwsLambdaResolverOptions",
2104
- "type": "object",
2105
- "additionalProperties": true
2106
- },
2107
- "payload": {
2108
- "description": "Mapping configuration the Payload.",
2109
- "$ref": "#/definitions/parameterConfigForJson"
2110
- },
2111
- "functionName": {
2112
- "description": "Mapping configuration for the FunctionName.",
2113
- "oneOf": [
2114
- {
2115
- "type": "string"
2116
- },
2117
- {
2118
- "$ref": "#/definitions/parameterConfigForAwsLambda"
2119
- }
2120
- ]
2121
- },
2122
- "clientContext": {
2123
- "description": "Mapping configuration for the ClientContext.",
2124
- "$ref": "#/definitions/parameterConfigForJson"
2125
- },
2126
- "args": {
2127
- "description": "Mapping and serialization configuration for args.",
2128
- "$ref": "#/definitions/parameterConfigForJson"
2129
- },
2130
- "results": {
2131
- "description": "Mapping configuration for the results of this resolver step.",
2132
- "$ref": "#/definitions/parameterConfigForJson"
2133
- },
2134
- "argsMapping": {
2135
- "$ref": "#/definitions/argsMapping"
2136
- },
2137
- "searchParamsMapping": {
2138
- "description": "Set or evaluate directives to generate searchParams for the service endpoint.",
2139
- "$ref": "#/definitions/searchParamsMapping"
2140
- },
2141
- "resultsMapping": {
2142
- "$ref": "#/definitions/resultsMapping"
2143
- }
2144
- },
2145
- "required": ["name", "service", "functionName"],
2146
- "additionalProperties": false
2147
- },
2148
- "composeResolver": {
2149
- "title": "ComposeResolver",
2150
- "type": "object",
2151
- "properties": {
2152
- "compose": {
2153
- "type": "array",
2154
- "items": {
2155
- "$ref": "#/definitions/basicResolver"
2156
- }
2157
- },
2158
- "resultsMapping": {
2159
- "oneOf": [
2160
- {
2161
- "$ref": "#/definitions/directiveMappingMap"
2162
- },
2163
- {
2164
- "$ref": "#/definitions/directiveConfig"
2165
- }
2166
- ]
2167
- },
2168
- "results": {
2169
- "description": "Mapping configuration for final query results.",
2170
- "$ref": "#/definitions/parameterConfigForJson"
2171
- }
2172
- },
2173
- "required": ["compose"],
2174
- "additionalProperties": false
2175
- },
2176
- "resolver": {
2177
- "title": "Resolver",
2178
- "oneOf": [
2179
- {
2180
- "$ref": "#/definitions/basicResolver"
2181
- },
2182
- {
2183
- "$ref": "#/definitions/composeResolver"
2184
- }
2185
- ]
2186
- },
2187
- "dependencies": {
2188
- "title": "Dependencies",
2189
- "type": "string"
2190
- },
2191
- "ref": {
2192
- "title": "Ref",
2193
- "type": "string"
2194
- },
2195
- "indexed": {
2196
- "title": "Indexed",
2197
- "type": "object",
2198
- "properties": {
2199
- "nested": {
2200
- "type": "boolean"
2201
- }
2202
- },
2203
- "additionalProperties": false
2204
- },
2205
- "graphql": {
2206
- "title": "GraphQLConfig",
2207
- "type": "object",
2208
- "properties": {
2209
- "json": {
2210
- "type": "boolean"
2211
- }
2212
- },
2213
- "additionalProperties": false
2214
- },
2215
- "query": {
2216
- "title": "Query JSON",
2217
- "type": "object",
2218
- "properties": {
2219
- "args": {
2220
- "description": "The args field specifies the name of a Shape for the input arguments required by your resolver.",
2221
- "$ref": "#/definitions/args"
2222
- },
2223
- "resolver": {
2224
- "description": "Configures the resolver for your query or mutation.",
2225
- "$ref": "#/definitions/resolver"
2226
- },
2227
- "shape": {
2228
- "$ref": "#/definitions/returnShape",
2229
- "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."
2230
- },
2231
- "description": {
2232
- "type": "string",
2233
- "description": "Provides more detail about what the query or mutation is for. This will be displayed in the automatically-generated GraphQL API docs."
2234
- }
2235
- },
2236
- "required": ["resolver", "shape"],
2237
- "additionalProperties": false
2238
- },
2239
- "propertySchema": {
2240
- "title": "PropertySchema",
2241
- "type": "object",
2242
- "properties": {
2243
- "$ref": {
2244
- "type": "string",
2245
- "format": "uri-reference"
2246
- },
2247
- "title": {
2248
- "type": "string"
2249
- },
2250
- "description": {
2251
- "type": "string"
2252
- },
2253
- "default": {},
2254
- "readOnly": {
2255
- "type": "boolean",
2256
- "default": false
2257
- },
2258
- "multipleOf": {
2259
- "type": "number",
2260
- "exclusiveMinimum": 0
2261
- },
2262
- "maximum": {
2263
- "type": "number"
2264
- },
2265
- "exclusiveMaximum": {
2266
- "type": "number"
2267
- },
2268
- "minimum": {
2269
- "type": "number"
2270
- },
2271
- "exclusiveMinimum": {
2272
- "type": "number"
2273
- },
2274
- "maxLength": {
2275
- "$ref": "#/definitions/nonNegativeInteger"
2276
- },
2277
- "minLength": {
2278
- "$ref": "#/definitions/nonNegativeIntegerDefault0"
2279
- },
2280
- "pattern": {
2281
- "type": "string",
2282
- "format": "regex"
2283
- },
2284
- "additionalItems": {
2285
- "$ref": "#/definitions/propertySchema"
2286
- },
2287
- "items": {
2288
- "$ref": "#/definitions/propertySchema"
2289
- },
2290
- "maxItems": {
2291
- "$ref": "#/definitions/nonNegativeInteger"
2292
- },
2293
- "minItems": {
2294
- "$ref": "#/definitions/nonNegativeIntegerDefault0"
2295
- },
2296
- "uniqueItems": {
2297
- "type": "boolean",
2298
- "default": false
2299
- },
2300
- "contains": {
2301
- "$ref": "#/definitions/propertySchema"
2302
- },
2303
- "maxProperties": {
2304
- "$ref": "#/definitions/nonNegativeInteger"
2305
- },
2306
- "minProperties": {
2307
- "$ref": "#/definitions/nonNegativeIntegerDefault0"
2308
- },
2309
- "required": {
2310
- "$ref": "#/definitions/stringArray"
2311
- },
2312
- "additionalProperties": {
2313
- "oneOf": [
2314
- {
2315
- "$ref": "#/definitions/propertySchema"
2316
- },
2317
- {
2318
- "enum": [false]
2319
- }
2320
- ]
2321
- },
2322
- "definitions": {
2323
- "type": "object",
2324
- "additionalProperties": {
2325
- "$ref": "#/definitions/propertySchema"
2326
- },
2327
- "default": {}
2328
- },
2329
- "properties": {
2330
- "type": "object",
2331
- "additionalProperties": {
2332
- "$ref": "#/definitions/propertySchema"
2333
- },
2334
- "default": {}
2335
- },
2336
- "const": {},
2337
- "enum": {
2338
- "type": "array",
2339
- "minItems": 1,
2340
- "uniqueItems": true
2341
- },
2342
- "type": {
2343
- "anyOf": [
2344
- {
2345
- "$ref": "#/definitions/simpleTypes"
2346
- },
2347
- {
2348
- "type": "array",
2349
- "items": {
2350
- "$ref": "#/definitions/simpleTypes"
2351
- },
2352
- "minItems": 1,
2353
- "uniqueItems": true
2354
- }
2355
- ]
2356
- },
2357
- "format": {
2358
- "type": "string"
2359
- },
2360
- "contentMediaType": {
2361
- "type": "string"
2362
- },
2363
- "contentEncoding": {
2364
- "type": "string"
2365
- },
2366
- "allOf": {
2367
- "$ref": "#/definitions/schemaArray"
2368
- },
2369
- "discriminator": {
2370
- "type": "object",
2371
- "properties": {
2372
- "propertyName": {
2373
- "type": "string"
2374
- }
2375
- }
2376
- },
2377
- "oneOf": {
2378
- "$ref": "#/definitions/schemaArray"
2379
- },
2380
- "extends": {
2381
- "$ref": "#/definitions/objectOrRefArray"
2382
- },
2383
- "@backreference": {
2384
- "$ref": "#/definitions/backreference"
2385
- },
2386
- "@input": {
2387
- "description": "A PropertySchema providing an alternative shape for a GraphQL input type.",
2388
- "$ref": "#/definitions/propertySchema"
2389
- },
2390
- "@output": {
2391
- "description": "A PropertySchema which is original output.",
2392
- "$ref": "#/definitions/propertySchema"
2393
- },
2394
- "@syncLocaleStructure": {
2395
- "type": "boolean"
2396
- },
2397
- "@sensitive": {
2398
- "type": "boolean"
2399
- },
2400
- "@draftjs": {
2401
- "type": "boolean"
2402
- },
2403
- "@l10n": {
2404
- "type": "boolean"
2405
- },
2406
- "@key": {
2407
- "type": "string",
2408
- "pattern": "^[-_a-zA-Z0-9]+$"
2409
- },
2410
- "@workflow": {
2411
- "type": "string"
2412
- },
2413
- "@mapping": {
2414
- "$ref": "#/definitions/fieldMapping"
2415
- },
2416
- "@tag": {
2417
- "type": "string"
2418
- },
2419
- "@tags": {
2420
- "type": "array",
2421
- "items": {
2422
- "type": "string"
2423
- }
2424
- },
2425
- "@deprecationReason": {
2426
- "type": "string"
2427
- },
2428
- "@args": {
2429
- "$ref": "#/definitions/args"
2430
- },
2431
- "@resolver": {
2432
- "$ref": "#/definitions/resolver"
2433
- },
2434
- "@dependencies": {
2435
- "$ref": "#/definitions/dependencies"
2436
- },
2437
- "@ref": {
2438
- "$ref": "#/definitions/ref"
2439
- },
2440
- "@derivedFrom": {
2441
- "type": "string"
2442
- },
2443
- "@indexed": {
2444
- "$ref": "#/definitions/indexed"
2445
- },
2446
- "@graphql": {
2447
- "$ref": "#/definitions/graphql"
2448
- }
2449
- },
2450
- "additionalProperties": false
2451
- },
2452
- "shape": {
2453
- "title": "Shape JSON",
2454
- "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",
2455
- "type": "object",
2456
- "properties": {
2457
- "name": {
2458
- "type": "string",
2459
- "pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$",
2460
- "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"
2461
- },
2462
- "id": {
2463
- "type": "string",
2464
- "pattern": "[0-9A-Za-z_-]+",
2465
- "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."
2466
- },
2467
- "title": {
2468
- "type": "string",
2469
- "description": "The human-readable name for a Shape for use in a UI."
2470
- },
2471
- "description": {
2472
- "type": "string"
2473
- },
2474
- "type": {
2475
- "enum": ["interface", "input", "output"]
2476
- },
2477
- "interfaces": {
2478
- "type": "array",
2479
- "items": {
2480
- "type": "string"
2481
- }
2482
- },
2483
- "model": {
2484
- "description": "Specifying a model type allows Shape data to be stored in TakeShape's built-in database",
2485
- "type": "object",
2486
- "properties": {
2487
- "type": {
2488
- "title": "Model Type",
2489
- "type": "string",
2490
- "enum": ["single", "multiple", "taxonomy"]
2491
- }
2492
- },
2493
- "required": ["type"],
2494
- "additionalProperties": false
2495
- },
2496
- "workflow": {
2497
- "type": "string"
2498
- },
2499
- "loaders": {
2500
- "$ref": "#/definitions/shapeLoaders"
2501
- },
2502
- "joins": {
2503
- "$ref": "#/definitions/shapeJoins"
2504
- },
2505
- "cache": {
2506
- "$ref": "#/definitions/shapeCacheConfig"
2507
- },
2508
- "schema": {
2509
- "$ref": "#/definitions/shapeSchema"
2510
- }
2511
- },
2512
- "required": ["name", "title", "id", "schema"],
2513
- "additionalProperties": false
2514
- },
2515
- "shapeWithObjectSchema": {
2516
- "title": "Shape With Object Schema",
2517
- "type": "object",
2518
- "allOf": [
2519
- {
2520
- "$ref": "#/definitions/shape"
2521
- },
2522
- {
2523
- "type": "object",
2524
- "properties": {
2525
- "schema": {
2526
- "$ref": "#/definitions/objectSchema"
2527
- }
2528
- },
2529
- "required": ["schema"],
2530
- "additionalProperties": false
2531
- }
2532
- ]
2533
- },
2534
- "shapeMap": {
2535
- "title": "Shape Map",
2536
- "type": "object",
2537
- "patternProperties": {
2538
- "^[0-9A-Za-z_]+$": {
2539
- "$ref": "#/definitions/shape"
2540
- }
2541
- },
2542
- "additionalProperties": false
2543
- },
2544
- "formMap": {
2545
- "title": "Form Map",
2546
- "type": "object",
2547
- "patternProperties": {
2548
- "[0-9A-Za-z_-]+": {
2549
- "$ref": "#/definitions/formsConfig"
2550
- }
2551
- }
2552
- },
2553
- "shapeCacheConfig": {
2554
- "title": "ShapeCacheConfig",
2555
- "type": "object",
2556
- "properties": {
2557
- "enabled": {
2558
- "type": "boolean"
2559
- },
2560
- "idField": {
2561
- "type": "string"
2562
- },
2563
- "searchSummaryField": {
2564
- "type": "string"
2565
- },
2566
- "fragment": {
2567
- "$ref": "#/definitions/cachedFragmentConfig"
2568
- },
2569
- "triggers": {
2570
- "type": "array",
2571
- "items": {
2572
- "$ref": "#/definitions/cacheTriggerConfig"
2573
- }
2574
- },
2575
- "maxAge": {
2576
- "description": "Number of seconds this Shape should be cached. Default 0.",
2577
- "type": "number",
2578
- "minimum": 0
2579
- },
2580
- "staleWhileRevalidate": {
2581
- "description": "Requests after maxAge will send a request to origin to revalidate while serving stale content for this duration in the meantime.",
2582
- "type": "number",
2583
- "minimum": 0
2584
- }
2585
- },
2586
- "additionalProperties": false,
2587
- "required": ["enabled"]
2588
- },
2589
- "shapeJoin": {
2590
- "title": "ShapeJoin",
2591
- "type": "object",
2592
- "properties": {
2593
- "resolver": {
2594
- "oneOf": [
2595
- {
2596
- "$ref": "#/definitions/delegateResolver"
2597
- },
2598
- {
2599
- "$ref": "#/definitions/shapedbResolver"
2600
- }
2601
- ]
2602
- },
2603
- "dependencies": {
2604
- "type": "string"
2605
- }
2606
- },
2607
- "required": ["resolver"],
2608
- "additionalProperties": false
2609
- },
2610
- "shapeJoins": {
2611
- "title": "ShapeJoins",
2612
- "type": "object",
2613
- "patternProperties": {
2614
- "[:0-9A-Za-z_-]+": {
2615
- "$ref": "#/definitions/shapeJoin"
2616
- }
2617
- }
2618
- },
2619
- "shapeLoaders": {
2620
- "title": "ShapeLoaders",
2621
- "type": "object",
2622
- "properties": {
2623
- "list": {
2624
- "oneOf": [
2625
- {
2626
- "$ref": "#/definitions/storedListQueryLoaderConfig"
2627
- },
2628
- {
2629
- "type": "array",
2630
- "items": {
2631
- "$ref": "#/definitions/storedListQueryLoaderConfig"
2632
- }
2633
- }
2634
- ]
2635
- },
2636
- "get": {
2637
- "$ref": "#/definitions/getQueryLoaderConfig"
2638
- }
2639
- },
2640
- "additionalProperties": false,
2641
- "required": ["list"]
2642
- },
2643
- "cachedFragmentConfig": {
2644
- "title": "Cached Fragment Config",
2645
- "type": "object",
2646
- "properties": {
2647
- "ignoreFields": {
2648
- "type": "array",
2649
- "items": {
2650
- "type": "string"
2651
- }
2652
- },
2653
- "maxDepth": {
2654
- "type": "number"
2655
- },
2656
- "selectionSet": {
2657
- "type": "string"
2658
- },
2659
- "includeDeprecated": {
2660
- "type": "boolean"
2661
- }
2662
- },
2663
- "additionalProperties": false
2664
- },
2665
- "listQueryLoaderConfig": {
2666
- "title": "ListQueryLoaderConfig",
2667
- "type": "object",
2668
- "properties": {
2669
- "query": {
2670
- "type": "string"
2671
- },
2672
- "args": {
2673
- "type": "object",
2674
- "additionalProperties": true
2675
- },
2676
- "pagination": {
2677
- "$ref": "#/definitions/paginationConfig"
2678
- }
2679
- },
2680
- "additionalProperties": false,
2681
- "required": ["query"]
2682
- },
2683
- "storedListQueryLoaderConfig": {
2684
- "title": "StoredListQueryLoaderConfig",
2685
- "type": "object",
2686
- "properties": {
2687
- "query": {
2688
- "type": "string"
2689
- },
2690
- "args": {
2691
- "oneOf": [
2692
- {
2693
- "type": "object",
2694
- "additionalProperties": true
2695
- },
2696
- {
2697
- "type": "array",
2698
- "items": {
2699
- "type": "object",
2700
- "additionalProperties": true
2701
- }
2702
- }
2703
- ]
2704
- },
2705
- "pagination": {
2706
- "$ref": "#/definitions/paginationConfig"
2707
- }
2708
- },
2709
- "additionalProperties": false,
2710
- "required": ["query"]
2711
- },
2712
- "getQueryLoaderConfig": {
2713
- "title": "GetQueryLoaderConfig",
2714
- "type": "object",
2715
- "properties": {
2716
- "query": {
2717
- "type": "string"
2718
- },
2719
- "args": {
2720
- "type": "object",
2721
- "additionalProperties": true
2722
- },
2723
- "idArg": {
2724
- "type": "string"
2725
- }
2726
- },
2727
- "additionalProperties": false,
2728
- "required": ["query"]
2729
- },
2730
- "paginationConfig": {
2731
- "title": "Pagination Config",
2732
- "oneOf": [
2733
- {
2734
- "$ref": "#/definitions/paginationCursorConfig"
2735
- },
2736
- {
2737
- "$ref": "#/definitions/paginationPageConfig"
2738
- },
2739
- {
2740
- "$ref": "#/definitions/paginationOffsetConfig"
2741
- }
2742
- ]
2743
- },
2744
- "paginationCursorConfig": {
2745
- "title": "Pagination Cursor Config",
2746
- "type": "object",
2747
- "properties": {
2748
- "type": {
2749
- "type": "string",
2750
- "enum": ["cursor"]
2751
- },
2752
- "cursorArg": {
2753
- "type": "string"
2754
- },
2755
- "cursorPath": {
2756
- "type": "string"
2757
- },
2758
- "pageSize": {
2759
- "type": "number"
2760
- },
2761
- "pageSizeArg": {
2762
- "type": "string"
2763
- },
2764
- "hasMorePath": {
2765
- "type": "string"
2766
- },
2767
- "itemsPath": {
2768
- "type": "string"
2769
- }
2770
- },
2771
- "additionalProperties": false,
2772
- "required": ["type", "cursorArg", "cursorPath", "pageSizeArg", "hasMorePath", "itemsPath"]
2773
- },
2774
- "paginationPageConfig": {
2775
- "title": "Pagination Page Config",
2776
- "type": "object",
2777
- "properties": {
2778
- "type": {
2779
- "type": "string",
2780
- "enum": ["page"]
2781
- },
2782
- "pageArg": {
2783
- "type": "string"
2784
- },
2785
- "pageSize": {
2786
- "type": "number"
2787
- },
2788
- "pageSizeArg": {
2789
- "type": "string"
2790
- },
2791
- "itemsPath": {
2792
- "type": "string"
2793
- },
2794
- "pageTotalPath": {
2795
- "type": "string"
2796
- }
2797
- },
2798
- "additionalProperties": false,
2799
- "required": ["type", "pageArg", "itemsPath", "pageTotalPath"]
2800
- },
2801
- "paginationOffsetConfig": {
2802
- "title": "Pagination Offset Config",
2803
- "type": "object",
2804
- "properties": {
2805
- "type": {
2806
- "type": "string",
2807
- "enum": ["offset"]
2808
- },
2809
- "offsetArg": {
2810
- "type": "string"
2811
- },
2812
- "pageSize": {
2813
- "type": "number"
2814
- },
2815
- "pageSizeArg": {
2816
- "type": "string"
2817
- },
2818
- "itemsPath": {
2819
- "type": "string"
2820
- },
2821
- "itemTotalPath": {
2822
- "type": "string"
2823
- }
2824
- },
2825
- "additionalProperties": false,
2826
- "required": ["type", "offsetArg", "itemsPath", "itemTotalPath"]
2827
- },
2828
- "cacheTriggerConfig": {
2829
- "title": "CacheTriggerConfig",
2830
- "oneOf": [
2831
- {
2832
- "$ref": "#/definitions/cacheScheduleTriggerConfig"
2833
- },
2834
- {
2835
- "$ref": "#/definitions/cacheWebhookTriggerConfig"
2836
- }
2837
- ]
2838
- },
2839
- "cacheScheduleTriggerConfig": {
2840
- "title": "CacheScheduleTriggerConfig",
2841
- "type": "object",
2842
- "properties": {
2843
- "type": {
2844
- "type": "string",
2845
- "enum": ["schedule"]
2846
- },
2847
- "loader": {
2848
- "enum": ["get", "list"]
2849
- },
2850
- "interval": {
2851
- "type": "number"
2852
- }
2853
- },
2854
- "additionalProperties": false,
2855
- "required": ["type", "loader", "interval"]
2856
- },
2857
- "cacheWebhookTriggerConfig": {
2858
- "title": "CacheWebhookTriggerConfig",
2859
- "type": "object",
2860
- "properties": {
2861
- "type": {
2862
- "type": "string",
2863
- "enum": ["webhook"]
2864
- },
2865
- "loader": {
2866
- "enum": ["get", "list"]
2867
- },
2868
- "service": {
2869
- "type": "string"
2870
- },
2871
- "events": {
2872
- "type": "array",
2873
- "items": {
2874
- "type": "string"
2875
- }
2876
- }
2877
- },
2878
- "additionalProperties": false,
2879
- "required": ["type", "loader", "service", "events"]
2880
- },
2881
- "formScalarConfig": {
2882
- "title": "Form Scalar Config",
2883
- "type": "object",
2884
- "properties": {
2885
- "widget": {
2886
- "type": "string"
2887
- }
2888
- },
2889
- "additionalProperties": false,
2890
- "required": ["widget"]
2891
- },
2892
- "formObjectConfig": {
2893
- "title": "Form Object Config",
2894
- "type": "object",
2895
- "properties": {
2896
- "widget": {
2897
- "type": "string"
2898
- },
2899
- "order": {
2900
- "type": "array",
2901
- "items": {
2902
- "type": "string"
2903
- }
2904
- },
2905
- "properties": {
2906
- "patternProperties": {
2907
- "[0-9A-Za-z_-]+": {
2908
- "$ref": "#/definitions/formConfig"
2909
- }
2910
- }
2911
- }
2912
- },
2913
- "additionalProperties": false
2914
- },
2915
- "formArrayConfig": {
2916
- "title": "Form Array Config",
2917
- "type": "object",
2918
- "properties": {
2919
- "widget": {
2920
- "type": "string"
2921
- },
2922
- "items": {
2923
- "$ref": "#/definitions/formConfig"
2924
- }
2925
- },
2926
- "additionalProperties": false,
2927
- "required": ["widget", "items"]
2928
- },
2929
- "customAuthentication": {
2930
- "title": "Custom Authentication",
2931
- "description": "For use with a custom auth handler on a service provider.",
2932
- "type": "object",
2933
- "properties": {
2934
- "type": {
2935
- "type": "string",
2936
- "enum": ["custom"]
2937
- }
2938
- },
2939
- "additionalProperties": true,
2940
- "required": ["type"]
2941
- },
2942
- "searchParamsAuthentication": {
2943
- "title": "Search Params Authentication",
2944
- "type": "object",
2945
- "properties": {
2946
- "type": {
2947
- "type": "string",
2948
- "enum": ["searchParams"]
2949
- },
2950
- "params": {
2951
- "type": "array",
2952
- "items": {
2953
- "properties": {
2954
- "name": {
2955
- "type": "string"
2956
- },
2957
- "value": {
2958
- "type": "string"
2959
- }
2960
- },
2961
- "required": ["name", "value"],
2962
- "additionalProperties": false
2963
- }
2964
- }
2965
- },
2966
- "additionalProperties": false,
2967
- "required": ["type", "params"]
2968
- },
2969
- "bearerAuthentication": {
2970
- "title": "Bearer Authentication",
2971
- "type": "object",
2972
- "properties": {
2973
- "type": {
2974
- "type": "string",
2975
- "enum": ["bearer"]
2976
- },
2977
- "token": {
2978
- "type": "string"
2979
- },
2980
- "prefix": {
2981
- "type": "string"
2982
- },
2983
- "header": {
2984
- "type": "string"
2985
- }
2986
- },
2987
- "additionalProperties": false,
2988
- "required": ["type", "token"]
2989
- },
2990
- "oauth2BearerAuthentication": {
2991
- "title": "OAuth 2 Bearer Authentication",
2992
- "type": "object",
2993
- "properties": {
2994
- "type": {
2995
- "type": "string",
2996
- "enum": ["oauth2Bearer"]
2997
- },
2998
- "token": {
2999
- "type": "string"
3000
- },
3001
- "prefix": {
3002
- "type": "string"
3003
- },
3004
- "header": {
3005
- "type": "string"
3006
- },
3007
- "scope": {
3008
- "type": "string"
3009
- },
3010
- "expiresAt": {
3011
- "type": "string"
3012
- }
3013
- },
3014
- "additionalProperties": false,
3015
- "required": ["type", "token"]
3016
- },
3017
- "basicAuthentication": {
3018
- "title": "Basic Authentication",
3019
- "type": "object",
3020
- "properties": {
3021
- "type": {
3022
- "type": "string",
3023
- "enum": ["basic"]
3024
- },
3025
- "username": {
3026
- "type": "string"
3027
- },
3028
- "password": {
3029
- "type": "string"
3030
- },
3031
- "useIso8859": {
3032
- "type": "boolean"
3033
- }
3034
- },
3035
- "additionalProperties": false,
3036
- "required": ["type", "username", "password"]
3037
- },
3038
- "oauth2Authentication": {
3039
- "title": "OAuth 2 Authentication",
3040
- "type": "object",
3041
- "properties": {
3042
- "type": {
3043
- "type": "string",
3044
- "enum": ["oauth2"]
3045
- },
3046
- "grantType": {
3047
- "type": "string",
3048
- "enum": ["authorizationCode", "clientCredentials"]
3049
- },
3050
- "authorizationUrl": {
3051
- "type": "string"
3052
- },
3053
- "accessTokenUrl": {
3054
- "type": "string"
3055
- },
3056
- "clientId": {
3057
- "type": "string"
3058
- },
3059
- "clientSecret": {
3060
- "type": "string"
3061
- },
3062
- "scope": {
3063
- "type": "string"
3064
- },
3065
- "usePkce": {
3066
- "type": "boolean"
3067
- },
3068
- "redirectUrl": {
3069
- "type": "string"
3070
- },
3071
- "headerPrefix": {
3072
- "type": "string"
3073
- },
3074
- "audience": {
3075
- "type": "string"
3076
- },
3077
- "resource": {
3078
- "type": "string"
3079
- }
3080
- },
3081
- "additionalProperties": false,
3082
- "required": ["type", "grantType", "clientId"]
3083
- },
3084
- "awsAuthentication": {
3085
- "title": "AWS Authentication",
3086
- "type": "object",
3087
- "properties": {
3088
- "type": {
3089
- "type": "string",
3090
- "enum": ["aws"]
3091
- },
3092
- "awsAccessKeyId": {
3093
- "type": "string"
3094
- },
3095
- "awsSecretAccessKey": {
3096
- "type": "string"
3097
- }
3098
- },
3099
- "additionalProperties": false,
3100
- "required": ["type", "awsAccessKeyId", "awsSecretAccessKey"]
3101
- },
3102
- "googleAuthentication": {
3103
- "title": "Google Authentication",
3104
- "type": "object",
3105
- "properties": {
3106
- "type": {
3107
- "type": "string",
3108
- "enum": ["google"]
3109
- },
3110
- "clientEmail": {
3111
- "type": "string"
3112
- },
3113
- "privateKey": {
3114
- "type": "string"
3115
- }
3116
- },
3117
- "additionalProperties": false,
3118
- "required": ["type", "clientEmail", "privateKey"]
3119
- },
3120
- "serviceAuthentication": {
3121
- "title": "Service Authentication",
3122
- "oneOf": [
3123
- {
3124
- "$ref": "#/definitions/oauth2Authentication"
3125
- },
3126
- {
3127
- "$ref": "#/definitions/oauth2BearerAuthentication"
3128
- },
3129
- {
3130
- "$ref": "#/definitions/bearerAuthentication"
3131
- },
3132
- {
3133
- "$ref": "#/definitions/basicAuthentication"
3134
- },
3135
- {
3136
- "$ref": "#/definitions/searchParamsAuthentication"
3137
- },
3138
- {
3139
- "$ref": "#/definitions/awsAuthentication"
3140
- },
3141
- {
3142
- "$ref": "#/definitions/googleAuthentication"
3143
- },
3144
- {
3145
- "$ref": "#/definitions/customAuthentication"
3146
- }
3147
- ]
3148
- },
3149
- "serviceHealthCheckTrigger": {
3150
- "title": "Service Health Check Trigger",
3151
- "enum": ["manual", "schedule"]
3152
- },
3153
- "serviceHealthCheck": {
3154
- "title": "Service Health Check",
3155
- "description": "Configuration for ping health checks.",
3156
- "type": "object",
3157
- "properties": {
3158
- "checkName": {
3159
- "title": "Check Name",
3160
- "description": "The name of a health check to run",
3161
- "type": "string",
3162
- "enum": ["graphqlIntrospection", "ping", "none"]
3163
- },
3164
- "endpoint": {
3165
- "title": "Endpoint",
3166
- "description": "The endpoint to use when checking the service health.",
3167
- "type": "string"
3168
- },
3169
- "requestMethod": {
3170
- "title": "Request Method",
3171
- "description": "A custom method to use for the health check request.",
3172
- "type": "string",
3173
- "enum": ["GET", "POST", "PUT", "PATCH", "DELETE"]
3174
- },
3175
- "requestHeaders": {
3176
- "title": "Request Headers",
3177
- "description": "Any custom headers to set with the health check request.",
3178
- "type": "object",
3179
- "propertyNames": {
3180
- "pattern": "[0-9A-Za-z_-]+"
3181
- }
3182
- },
3183
- "requestSearchParams": {
3184
- "title": "Request Search Params",
3185
- "description": "Any custom search params to set with the health check request.",
3186
- "type": "object",
3187
- "propertyNames": {
3188
- "pattern": "[0-9A-Za-z_-]+"
3189
- }
3190
- },
3191
- "requestBody": {
3192
- "title": "Request Body",
3193
- "description": "A custom body to send along with the ping request.",
3194
- "type": "string"
3195
- },
3196
- "requestBodyFormat": {
3197
- "title": "Request Body Format",
3198
- "description": "A custom body to send along with the ping request.",
3199
- "type": "string",
3200
- "enum": ["string", "form", "json", "form-data"]
3201
- },
3202
- "requestTimeout": {
3203
- "title": "Request Timeout",
3204
- "description": "The amount of time to wait when receiving a response from the health check, in seconds.",
3205
- "type": "number",
3206
- "minimum": 2,
3207
- "maximum": 60
3208
- },
3209
- "healthyResponseStatusCode": {
3210
- "title": "Healthy Response Status Code",
3211
- "description": "The response status code that qualifies as healthy.",
3212
- "type": "number",
3213
- "minimum": 200,
3214
- "maximum": 399
3215
- },
3216
- "triggers": {
3217
- "type": "array",
3218
- "items": {
3219
- "$ref": "#/definitions/serviceHealthCheckTrigger"
3220
- }
3221
- }
3222
- },
3223
- "required": ["checkName"],
3224
- "additionalProperties": false
3225
- },
3226
- "serviceType": {
3227
- "title": "Service Type",
3228
- "description": "The general type of this service, specifying how and where it will be utilized.",
3229
- "type": "string",
3230
- "enum": ["deployment", "authentication", "takeshape", "rest", "graphql", "openapi", "aws", "unknown"]
3231
- },
3232
- "serviceConfig": {
3233
- "title": "Service Config",
3234
- "type": "object",
3235
- "properties": {
3236
- "id": {
3237
- "type": "string",
3238
- "description": "Machine-readable identifier, should typically be the same as the property name on the services object."
3239
- },
3240
- "title": {
3241
- "type": "string",
3242
- "description": "Human-readable name for this service."
3243
- },
3244
- "provider": {
3245
- "description": "The service provider id.",
3246
- "type": "string"
3247
- },
3248
- "namespace": {
3249
- "type": "string",
3250
- "description": "A namespace to use for the imported types tied to this service."
3251
- },
3252
- "serviceType": {
3253
- "$ref": "#/definitions/serviceType"
3254
- },
3255
- "authenticationType": {
3256
- "type": "string",
3257
- "enum": [
3258
- "oauth2",
3259
- "basic",
3260
- "bearer",
3261
- "searchParams",
3262
- "oauth2Bearer",
3263
- "custom",
3264
- "aws",
3265
- "google",
3266
- "none",
3267
- "unknown"
3268
- ]
3269
- },
3270
- "authentication": {
3271
- "$ref": "#/definitions/serviceAuthentication"
3272
- },
3273
- "healthCheck": {
3274
- "$ref": "#/definitions/serviceHealthCheck"
3275
- },
3276
- "webhookId": {
3277
- "type": "string"
3278
- },
3279
- "options": {
3280
- "type": "object",
3281
- "description": "Configuration options passed to and handled by the provider."
3282
- }
3283
- },
3284
- "required": ["id", "title", "provider", "serviceType", "authenticationType"],
3285
- "additionalProperties": false
3286
- },
3287
- "storedServiceConfig": {
3288
- "title": "Service Config JSON",
3289
- "type": "object",
3290
- "properties": {
3291
- "id": {
3292
- "type": "string",
3293
- "description": "Machine-readable identifier, should typically be the same as the property name on the services object."
3294
- },
3295
- "title": {
3296
- "type": "string",
3297
- "description": "Human-readable name for this service."
3298
- },
3299
- "provider": {
3300
- "type": "string",
3301
- "description": "The service provider id."
3302
- },
3303
- "namespace": {
3304
- "type": "string",
3305
- "description": "A namespace to use for the imported types tied to this service."
3306
- },
3307
- "serviceType": {
3308
- "$ref": "#/definitions/serviceType"
3309
- },
3310
- "authenticationType": {
3311
- "type": "string",
3312
- "enum": [
3313
- "oauth2",
3314
- "basic",
3315
- "bearer",
3316
- "searchParams",
3317
- "oauth2Bearer",
3318
- "custom",
3319
- "aws",
3320
- "google",
3321
- "none",
3322
- "unknown"
3323
- ]
3324
- },
3325
- "authentication": {
3326
- "type": "string"
3327
- },
3328
- "healthCheck": {
3329
- "$ref": "#/definitions/serviceHealthCheck"
3330
- },
3331
- "webhookId": {
3332
- "type": "string"
3333
- },
3334
- "options": {
3335
- "type": "object",
3336
- "description": "Configuration options passed to and handled by the provider."
3337
- }
3338
- },
3339
- "required": ["id", "title", "provider", "serviceType", "authenticationType"],
3340
- "additionalProperties": false
3341
- },
3342
- "anyServiceConfig": {
3343
- "title": "Any Service Config",
3344
- "oneOf": [
3345
- {
3346
- "$ref": "#/definitions/storedServiceConfig"
3347
- },
3348
- {
3349
- "$ref": "#/definitions/serviceConfig"
3350
- }
3351
- ]
3352
- },
3353
- "storedServiceMap": {
3354
- "title": "Service Map JSON",
3355
- "type": "object",
3356
- "patternProperties": {
3357
- "[0-9A-Za-z_-]+": {
3358
- "$ref": "#/definitions/storedServiceConfig"
3359
- }
3360
- }
3361
- },
3362
- "workflowStep": {
3363
- "title": "Workflow Step",
3364
- "type": "object",
3365
- "properties": {
3366
- "name": {
3367
- "type": "string",
3368
- "title": "Name",
3369
- "pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$",
3370
- "description": "machine-readable slug"
3371
- },
3372
- "title": {
3373
- "title": "Title",
3374
- "type": "string",
3375
- "description": "Human-readable id for use in the UI"
3376
- },
3377
- "description": {
3378
- "title": "Description",
3379
- "type": "string"
3380
- },
3381
- "color": {
3382
- "title": "Color",
3383
- "type": "string",
3384
- "description": "Hex color code"
3385
- },
3386
- "live": {
3387
- "title": "Live",
3388
- "type": "boolean",
3389
- "description": "Value to indicate whether items in the state should be returned in list queries"
3390
- },
3391
- "key": {
3392
- "title": "Key",
3393
- "type": "string",
3394
- "description": "machine-readable id"
3395
- }
3396
- },
3397
- "required": ["name", "title", "color", "live", "key"],
3398
- "additionalProperties": false
3399
- },
3400
- "workflow": {
3401
- "title": "Workflow",
3402
- "type": "object",
3403
- "properties": {
3404
- "name": {
3405
- "type": "string",
3406
- "pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$",
3407
- "description": "machine-readable id"
3408
- },
3409
- "title": {
3410
- "type": "string",
3411
- "title": "Workflow Name",
3412
- "minLength": 1,
3413
- "description": "Human-readable id for use in the UI"
3414
- },
3415
- "steps": {
3416
- "type": "array",
3417
- "title": "Steps",
3418
- "items": {
3419
- "$ref": "#/definitions/workflowStep"
3420
- },
3421
- "minItems": 1
3422
- }
3423
- },
3424
- "required": ["name", "title", "steps"]
3425
- },
3426
- "workflowMap": {
3427
- "title": "Workflow Map",
3428
- "type": "object",
3429
- "patternProperties": {
3430
- "[0-9A-Za-z_-]+": {
3431
- "$ref": "#/definitions/workflow"
3432
- }
3433
- }
3434
- },
3435
- "formConfig": {
3436
- "title": "Form Config",
3437
- "type": "object"
3438
- },
3439
- "formsConfig": {
3440
- "title": "Forms Config",
3441
- "type": "object",
3442
- "properties": {
3443
- "default": {
3444
- "$ref": "#/definitions/formConfig"
3445
- }
3446
- },
3447
- "patternProperties": {
3448
- "[0-9A-Za-z_-]+": {
3449
- "$ref": "#/definitions/formConfig"
3450
- }
3451
- },
3452
- "required": ["default"]
3453
- },
3454
- "agent": {
3455
- "title": "Agent JSON",
3456
- "description": "An Agent is a configuration for an AI service such as a chat bot or a search engine.",
3457
- "type": "object",
3458
- "properties": {
3459
- "description": {
3460
- "type": "string"
3461
- },
3462
- "systemPrompt": {
3463
- "type": "string"
3464
- },
3465
- "api": {
3466
- "$ref": "#/definitions/agentApi"
3467
- },
3468
- "memory": {
3469
- "$ref": "#/definitions/agentMemory"
3470
- },
3471
- "start": {
3472
- "$ref": "#/definitions/agentStart"
3473
- },
3474
- "states": {
3475
- "$ref": "#/definitions/agentStateMap"
3476
- },
3477
- "guards": {
3478
- "type": "array",
3479
- "items": {
3480
- "$ref": "#/definitions/agentGuard"
3481
- }
3482
- },
3483
- "historyStrategies": {
3484
- "$ref": "#/definitions/historyStrategyMap"
3485
- }
3486
- },
3487
- "required": ["start", "states", "api"],
3488
- "additionalProperties": false
3489
- },
3490
- "historyStrategyMap": {
3491
- "title": "History Strategy Map",
3492
- "type": "object",
3493
- "patternProperties": {
3494
- "^[0-9A-Za-z_]+$": {
3495
- "$ref": "#/definitions/historyStrategy"
3496
- }
3497
- },
3498
- "additionalProperties": false
3499
- },
3500
- "historyStrategy": {
3501
- "title": "History Strategy",
3502
- "type": "object",
3503
- "properties": {
3504
- "name": {
3505
- "type": "string"
3506
- },
3507
- "variables": {
3508
- "title": "Variables",
3509
- "type": "array",
3510
- "items": {
3511
- "$ref": "#/definitions/agentVariable"
3512
- }
3513
- },
3514
- "filter": {
3515
- "$ref": "#/definitions/historyStrategyFilter"
3516
- },
3517
- "transform": {
3518
- "$ref": "#/definitions/historyStrategyTransform"
3519
- }
3520
- },
3521
- "required": ["name", "transform"],
3522
- "additionalProperties": false
3523
- },
3524
- "historyStrategyFilter": {
3525
- "title": "History Strategy Filter",
3526
- "type": "object",
3527
- "properties": {
3528
- "toolCalls": {
3529
- "enum": ["retain", "clear"]
3530
- }
3531
- },
3532
- "additionalProperties": false
3533
- },
3534
- "historyStrategyTransform": {
3535
- "title": "History Strategy Transform",
3536
- "discriminator": {
3537
- "propertyName": "type"
3538
- },
3539
- "oneOf": [
3540
- {
3541
- "$ref": "#/definitions/historyStrategyTransformNone"
3542
- },
3543
- {
3544
- "$ref": "#/definitions/historyStrategyTransformReplace"
3545
- },
3546
- {
3547
- "$ref": "#/definitions/historyStrategyTransformSummarize"
3548
- }
3549
- ]
3550
- },
3551
- "historyStrategyTransformNone": {
3552
- "title": "History Strategy Transform None",
3553
- "type": "object",
3554
- "properties": {
3555
- "type": {
3556
- "enum": ["none"]
3557
- }
3558
- },
3559
- "required": ["type"],
3560
- "additionalProperties": false
3561
- },
3562
- "historyStrategyTransformReplace": {
3563
- "title": "History Strategy Transform Replace",
3564
- "type": "object",
3565
- "properties": {
3566
- "type": {
3567
- "enum": ["replace"]
3568
- },
3569
- "template": {
3570
- "type": "string"
3571
- }
3572
- },
3573
- "required": ["type", "template"],
3574
- "additionalProperties": false
3575
- },
3576
- "historyStrategyTransformSummarize": {
3577
- "title": "History Strategy Transform Summarize",
3578
- "type": "object",
3579
- "properties": {
3580
- "type": {
3581
- "enum": ["generate"]
3582
- },
3583
- "service": {
3584
- "type": "string"
3585
- },
3586
- "model": {
3587
- "type": "string"
3588
- },
3589
- "systemPrompt": {
3590
- "type": "string"
3591
- },
3592
- "tools": {
3593
- "type": "array",
3594
- "items": {
3595
- "$ref": "#/definitions/agentToolConfig"
3596
- }
3597
- },
3598
- "options": {
3599
- "$ref": "#/definitions/agentGenerateOptions"
3600
- }
3601
- },
3602
- "required": ["type", "service", "model", "systemPrompt"],
3603
- "additionalProperties": false
3604
- },
3605
- "tool": {
3606
- "title": "Tool JSON",
3607
- "type": "object",
3608
- "properties": {
3609
- "name": {
3610
- "type": "string"
3611
- },
3612
- "ref": {
3613
- "type": "string"
3614
- },
3615
- "description": {
3616
- "type": "string"
3617
- },
3618
- "args": {
3619
- "type": "array",
3620
- "items": {
3621
- "$ref": "#/definitions/toolArg"
3622
- }
3623
- },
3624
- "selectionSet": {
3625
- "type": "string"
3626
- }
3627
- },
3628
- "required": ["name", "ref"],
3629
- "additionalProperties": false
3630
- },
3631
- "toolArg": {
3632
- "title": "Tool Arg",
3633
- "type": "object",
3634
- "discriminator": {
3635
- "propertyName": "type"
3636
- },
3637
- "oneOf": [
3638
- {
3639
- "$ref": "#/definitions/agentToolConfigArgAgent"
3640
- }
3641
- ]
3642
- },
3643
- "agentApi": {
3644
- "title": "Agent API",
3645
- "type": "object",
3646
- "properties": {
3647
- "inputs": {
3648
- "type": "array",
3649
- "items": {
3650
- "$ref": "#/definitions/agentApiInput"
3651
- }
3652
- }
3653
- },
3654
- "required": ["inputs"],
3655
- "additionalProperties": false
3656
- },
3657
- "agentMemory": {
3658
- "title": "Agent Memory",
3659
- "type": "object",
3660
- "properties": {
3661
- "sessionMemory": {
3662
- "$ref": "#/definitions/agentSessionMemory"
3663
- }
3664
- },
3665
- "required": ["sessionMemory"],
3666
- "additionalProperties": false
3667
- },
3668
- "agentSessionMemory": {
3669
- "title": "Agent Session Memory",
3670
- "type": "object",
3671
- "properties": {
3672
- "shape": {
3673
- "type": "string"
3674
- }
3675
- },
3676
- "required": [],
3677
- "additionalProperties": false
3678
- },
3679
- "agentVariable": {
3680
- "title": "Agent Variable",
3681
- "type": "object",
3682
- "properties": {
3683
- "name": {
3684
- "type": "string"
3685
- },
3686
- "steps": {
3687
- "description": "These are evaluated in order until a value is found.",
3688
- "type": "array",
3689
- "items": {
3690
- "$ref": "#/definitions/agentVariableStep"
3691
- }
3692
- }
3693
- },
3694
- "required": ["name", "steps"],
3695
- "additionalProperties": false
3696
- },
3697
- "agentVariableStep": {
3698
- "title": "Agent Variable Step",
3699
- "type": "object",
3700
- "properties": {
3701
- "condition": {
3702
- "type": "string"
3703
- },
3704
- "expression": {
3705
- "type": "string"
3706
- }
3707
- },
3708
- "required": ["expression"],
3709
- "additionalProperties": false
3710
- },
3711
- "agentStart": {
3712
- "title": "Agent Start",
3713
- "description": "Configuration for the start of an agent's execution",
3714
- "type": "object",
3715
- "properties": {
3716
- "transitions": {
3717
- "type": "array",
3718
- "items": {
3719
- "$ref": "#/definitions/agentTransitionSuspend"
3720
- }
3721
- }
3722
- },
3723
- "required": ["transitions"],
3724
- "additionalProperties": false
3725
- },
3726
- "agentStateMap": {
3727
- "title": "Agent States",
3728
- "description": "States that are traversed during the execution of an agent.",
3729
- "type": "object",
3730
- "patternProperties": {
3731
- "^[0-9A-Za-z_]+$": {
3732
- "$ref": "#/definitions/agentState"
3733
- }
3734
- },
3735
- "additionalProperties": false
3736
- },
3737
- "agentState": {
3738
- "title": "Agent State",
3739
- "description": "One step of an agent's execution.",
3740
- "type": "object",
3741
- "properties": {
3742
- "name": {
3743
- "type": "string",
3744
- "pattern": "^[a-zA-Z][0-9A-Za-z_]*$"
3745
- },
3746
- "variables": {
3747
- "title": "Variables",
3748
- "type": "array",
3749
- "items": {
3750
- "$ref": "#/definitions/agentVariable"
3751
- }
3752
- },
3753
- "execution": {
3754
- "$ref": "#/definitions/agentExecution"
3755
- },
3756
- "transitions": {
3757
- "type": "array",
3758
- "items": {
3759
- "$ref": "#/definitions/agentTransition"
3760
- }
3761
- }
3762
- },
3763
- "required": ["name", "execution"],
3764
- "additionalProperties": false
3765
- },
3766
- "agentExecution": {
3767
- "title": "Agent Execution",
3768
- "discriminator": {
3769
- "propertyName": "type"
3770
- },
3771
- "oneOf": [
3772
- {
3773
- "$ref": "#/definitions/agentExecutionGraphql"
3774
- },
3775
- {
3776
- "$ref": "#/definitions/agentExecutionGenerate"
3777
- },
3778
- {
3779
- "$ref": "#/definitions/agentExecutionChat"
3780
- }
3781
- ]
3782
- },
3783
- "agentApiInput": {
3784
- "title": "Agent API Input",
3785
- "discriminator": {
3786
- "propertyName": "type"
3787
- },
3788
- "oneOf": [
3789
- {
3790
- "$ref": "#/definitions/agentApiMutationInput"
3791
- }
3792
- ]
3793
- },
3794
- "agentApiMutationInput": {
3795
- "title": "Agent API Mutation Input",
3796
- "type": "object",
3797
- "properties": {
3798
- "type": {
3799
- "enum": ["mutation"]
3800
- },
3801
- "name": {
3802
- "type": "string",
3803
- "pattern": "^[0-9A-Za-z_]+$"
3804
- },
3805
- "args": {
3806
- "type": "string"
3807
- },
3808
- "interactionTimeout": {
3809
- "title": "Interaction Timeout (milliseconds)",
3810
- "type": "integer"
3811
- }
3812
- },
3813
- "required": ["type", "name", "args"],
3814
- "additionalProperties": false
3815
- },
3816
- "agentExecutionGraphql": {
3817
- "title": "Agent Execution GraphQL",
3818
- "type": "object",
3819
- "properties": {
3820
- "type": {
3821
- "enum": ["graphql"]
3822
- },
3823
- "query": {
3824
- "type": "string"
3825
- },
3826
- "path": {
3827
- "type": "string"
3828
- }
3829
- },
3830
- "required": ["type", "query"],
3831
- "additionalProperties": false
3832
- },
3833
- "agentStateSessionMemoryAssignment": {
3834
- "title": "Agent State Session Memory Assignment",
3835
- "type": "object",
3836
- "properties": {
3837
- "memoryPath": {
3838
- "type": "string"
3839
- },
3840
- "expression": {
3841
- "type": "string"
3842
- }
3843
- },
3844
- "required": ["expression"],
3845
- "additionalProperties": false
3846
- },
3847
- "agentAiStateInputArg": {
3848
- "title": "Agent AI State Input Argument",
3849
- "type": "object",
3850
- "properties": {
3851
- "type": {
3852
- "enum": ["arg"]
3853
- }
3854
- },
3855
- "required": ["type"],
3856
- "additionalProperties": false
3857
- },
3858
- "agentAiStateInputTemplate": {
3859
- "title": "Agent AI State Input Template",
3860
- "type": "object",
3861
- "properties": {
3862
- "type": {
3863
- "enum": ["template"]
3864
- },
3865
- "inputTemplate": {
3866
- "type": "string"
3867
- }
3868
- },
3869
- "required": ["type", "inputTemplate"],
3870
- "additionalProperties": false
3871
- },
3872
- "agentAiStateInput": {
3873
- "title": "Agent AI State Input",
3874
- "type": "object",
3875
- "discriminator": {
3876
- "propertyName": "type"
3877
- },
3878
- "oneOf": [
3879
- {
3880
- "$ref": "#/definitions/agentAiStateInputArg"
3881
- },
3882
- {
3883
- "$ref": "#/definitions/agentAiStateInputTemplate"
3884
- }
3885
- ]
3886
- },
3887
- "agentGenerateOptions": {
3888
- "title": "AgentGenerateOptions",
3889
- "type": "object",
3890
- "properties": {
3891
- "history": {
3892
- "title": "history",
3893
- "type": "boolean"
3894
- },
3895
- "maxTokens": {
3896
- "type": "integer",
3897
- "title": "Maximum Tokens",
3898
- "description": "Maximum number of tokens to generate. Defaults to 1024"
3899
- },
3900
- "temperature": {
3901
- "type": "number",
3902
- "title": "Temperature",
3903
- "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",
3904
- "minimum": 0,
3905
- "maximum": 1
3906
- },
3907
- "topP": {
3908
- "type": "number",
3909
- "title": "Top P",
3910
- "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.",
3911
- "minimum": 0,
3912
- "maximum": 1
3913
- },
3914
- "topK": {
3915
- "type": "number",
3916
- "title": "Top K",
3917
- "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."
3918
- },
3919
- "presencePenalty": {
3920
- "type": "number",
3921
- "title": "Presence penalty setting",
3922
- "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.",
3923
- "minimum": -1,
3924
- "maximum": 1
3925
- },
3926
- "frequencyPenalty": {
3927
- "type": "number",
3928
- "title": "Frequency penalty setting",
3929
- "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.",
3930
- "minimum": -1,
3931
- "maximum": 1
3932
- },
3933
- "stopSequences": {
3934
- "title": "Stop sequences",
3935
- "description": "If set, the model will stop generating text when one of the stop sequences is generated.",
3936
- "type": "array",
3937
- "items": {
3938
- "type": "string"
3939
- }
3940
- },
3941
- "seed": {
3942
- "type": "integer",
3943
- "title": "Seed",
3944
- "description": " The seed (integer) to use for random sampling. If set and supported by the model, calls will generate deterministic results."
3945
- },
3946
- "maxRetries": {
3947
- "type": "integer",
3948
- "description": "Maximum number of retries. Set to 0 to disable retries. Defaults to 2"
3949
- },
3950
- "toolChoice": {
3951
- "type": "string",
3952
- "description": "The tool choice strategy. Default: 'auto'",
3953
- "anyOf": [
3954
- {
3955
- "enum": ["auto", "none", "required"]
3956
- },
3957
- {
3958
- "type": "string"
3959
- }
3960
- ]
3961
- },
3962
- "maxToolRoundtrips": {
3963
- "type": "integer",
3964
- "title": "Max Tool Roundtrips",
3965
- "description": "Maximal number of automatic roundtrips for tool calls."
3966
- },
3967
- "structuredOutputs": {
3968
- "type": "boolean",
3969
- "title": "Structured Outputs",
3970
- "description": "If true, structured outputs will be enabled on the model for non-text requests."
3971
- },
3972
- "enableOpenAIFormat": {
3973
- "type": "boolean",
3974
- "title": "Enable OpenAI Schema Format",
3975
- "description": "Enable OpenAI schema format. Must be enabled if `structuredOutputs` is enabled."
3976
- },
3977
- "removePropertyKeyPatterns": {
3978
- "$ref": "#/definitions/removePropertyKeyPatterns"
3979
- },
3980
- "stripMarkdown": {
3981
- "type": "boolean",
3982
- "title": "Strip Markdown",
3983
- "description": "Remove Markdown formatting from the LLM response"
3984
- }
3985
- },
3986
- "additionalProperties": false
3987
- },
3988
- "agentGuard": {
3989
- "title": "Agent Guard",
3990
- "type": "object",
3991
- "properties": {
3992
- "guardId": {
3993
- "title": "Guard ID",
3994
- "type": "string"
3995
- }
3996
- },
3997
- "required": ["guardId"],
3998
- "additionalProperties": false
3999
- },
4000
- "agentToolConfig": {
4001
- "title": "AgentToolConfig",
4002
- "type": "object",
4003
- "properties": {
4004
- "name": {
4005
- "type": "string"
4006
- },
4007
- "ref": {
4008
- "type": "string"
4009
- },
4010
- "description": {
4011
- "type": "string"
4012
- },
4013
- "args": {
4014
- "type": "array",
4015
- "items": {
4016
- "$ref": "#/definitions/agentToolConfigArg"
4017
- }
4018
- },
4019
- "selectionSet": {
4020
- "type": "string"
4021
- }
4022
- },
4023
- "required": ["name", "ref"],
4024
- "additionalProperties": false
4025
- },
4026
- "agentToolConfigArg": {
4027
- "title": "Agent Tool Config Arg",
4028
- "type": "object",
4029
- "discriminator": {
4030
- "propertyName": "type"
4031
- },
4032
- "oneOf": [
4033
- {
4034
- "$ref": "#/definitions/agentToolConfigArgAgent"
4035
- },
4036
- {
4037
- "$ref": "#/definitions/agentToolConfigArgVariable"
4038
- }
4039
- ]
4040
- },
4041
- "agentToolConfigArgAgent": {
4042
- "title": "Agent-Controlled",
4043
- "type": "object",
4044
- "properties": {
4045
- "type": {
4046
- "enum": ["agent"]
4047
- },
4048
- "argName": {
4049
- "title": "Tool Argument Name",
4050
- "type": "string",
4051
- "description": "The argument name that will be exposed by the tool for the LLM to use."
4052
- }
4053
- },
4054
- "required": ["type", "argName"],
4055
- "additionalProperties": false
4056
- },
4057
- "agentToolConfigArgVariable": {
4058
- "title": "Variable Value",
4059
- "type": "object",
4060
- "properties": {
4061
- "type": {
4062
- "enum": ["variable"]
4063
- },
4064
- "argName": {
4065
- "title": "Tool Argument Name",
4066
- "type": "string",
4067
- "description": "Name of argument to pass value to. This prevents the LLM from setting the argument."
4068
- },
4069
- "variableName": {
4070
- "title": "State Variable Name",
4071
- "type": "string",
4072
- "description": "Name of variable to pull value from."
4073
- }
4074
- },
4075
- "required": ["type", "argName", "variableName"],
4076
- "additionalProperties": false
4077
- },
4078
- "agentExecutionGenerate": {
4079
- "title": "Agent Execution Generate",
4080
- "type": "object",
4081
- "properties": {
4082
- "type": {
4083
- "enum": ["generate"]
4084
- },
4085
- "service": {
4086
- "type": "string"
4087
- },
4088
- "model": {
4089
- "type": "string"
4090
- },
4091
- "systemPrompt": {
4092
- "type": "string"
4093
- },
4094
- "input": {
4095
- "$ref": "#/definitions/agentAiStateInput"
4096
- },
4097
- "outputShape": {
4098
- "type": "string"
4099
- },
4100
- "tools": {
4101
- "type": "array",
4102
- "items": {
4103
- "$ref": "#/definitions/agentToolConfig"
4104
- }
4105
- },
4106
- "options": {
4107
- "$ref": "#/definitions/agentGenerateOptions"
4108
- }
4109
- },
4110
- "required": ["type", "service", "model", "input"],
4111
- "additionalProperties": false
4112
- },
4113
- "agentExecutionChat": {
4114
- "title": "Agent Execution Chat",
4115
- "type": "object",
4116
- "properties": {
4117
- "type": {
4118
- "enum": ["chat"]
4119
- },
4120
- "service": {
4121
- "type": "string"
4122
- },
4123
- "model": {
4124
- "type": "string"
4125
- },
4126
- "systemPrompt": {
4127
- "type": "string"
4128
- },
4129
- "input": {
4130
- "$ref": "#/definitions/agentAiStateInput"
4131
- },
4132
- "artifact": {
4133
- "type": "string"
4134
- },
4135
- "tools": {
4136
- "type": "array",
4137
- "items": {
4138
- "$ref": "#/definitions/agentToolConfig"
4139
- }
4140
- },
4141
- "options": {
4142
- "$ref": "#/definitions/agentGenerateOptions"
4143
- }
4144
- },
4145
- "required": ["type", "service", "model", "input"],
4146
- "additionalProperties": false
4147
- },
4148
- "agentTransition": {
4149
- "title": "Agent Transition",
4150
- "description": "These steps are evaluated in order until a destination is found.",
4151
- "discriminator": {
4152
- "propertyName": "type"
4153
- },
4154
- "oneOf": [
4155
- {
4156
- "$ref": "#/definitions/agentTransitionImmediate"
4157
- },
4158
- {
4159
- "$ref": "#/definitions/agentTransitionSuspend"
4160
- }
4161
- ]
4162
- },
4163
- "agentTransitionSuspend": {
4164
- "title": "Agent Transition Suspend",
4165
- "type": "object",
4166
- "properties": {
4167
- "type": {
4168
- "enum": ["suspend"]
4169
- },
4170
- "destination": {
4171
- "type": "string",
4172
- "pattern": "^[0-9A-Za-z_]+$"
4173
- },
4174
- "input": {
4175
- "type": "string"
4176
- },
4177
- "condition": {
4178
- "type": "string"
4179
- },
4180
- "limit": {
4181
- "type": "integer"
4182
- },
4183
- "sessionMemory": {
4184
- "title": "Agent State Session Memory",
4185
- "type": "array",
4186
- "items": {
4187
- "$ref": "#/definitions/agentStateSessionMemoryAssignment"
4188
- }
4189
- },
4190
- "historyStrategy": {
4191
- "type": "string"
4192
- }
4193
- },
4194
- "additionalProperties": false,
4195
- "required": ["type", "destination", "input"]
4196
- },
4197
- "agentTransitionImmediate": {
4198
- "title": "Agent Transition Immediate",
4199
- "type": "object",
4200
- "properties": {
4201
- "type": {
4202
- "enum": ["immediate"]
4203
- },
4204
- "destination": {
4205
- "type": "string",
4206
- "pattern": "^[0-9A-Za-z_]+$"
4207
- },
4208
- "condition": {
4209
- "type": "string"
4210
- },
4211
- "limit": {
4212
- "type": "integer"
4213
- },
4214
- "sessionMemory": {
4215
- "title": "Agent State Session Memory",
4216
- "type": "array",
4217
- "items": {
4218
- "$ref": "#/definitions/agentStateSessionMemoryAssignment"
4219
- }
4220
- },
4221
- "historyStrategy": {
4222
- "type": "string"
4223
- }
4224
- },
4225
- "additionalProperties": false,
4226
- "required": ["type", "destination"]
4227
- },
4228
- "agentMap": {
4229
- "title": "Agent Map",
4230
- "type": "object",
4231
- "patternProperties": {
4232
- "^[0-9A-Za-z_]+$": {
4233
- "$ref": "#/definitions/agent"
4234
- }
4235
- },
4236
- "additionalProperties": false
4237
- },
4238
- "toolMap": {
4239
- "title": "Tool Map",
4240
- "type": "object",
4241
- "patternProperties": {
4242
- "^[0-9A-Za-z_]+$": {
4243
- "$ref": "#/definitions/tool"
4244
- }
4245
- },
4246
- "additionalProperties": false
4247
- },
4248
- "mcpConfig": {
4249
- "title": "MCP Server Configuration",
4250
- "type": "object",
4251
- "properties": {
4252
- "tools": {
4253
- "$ref": "#/definitions/toolMap",
4254
- "description": "A Tool is a configuration for an AI tool which can query or mutate data."
4255
- }
4256
- },
4257
- "additionalProperties": false
4258
- },
4259
- "aiRunAgentResolver": {
4260
- "title": "AISendAgentMessageResolver",
4261
- "type": "object",
4262
- "properties": {
4263
- "id": {
4264
- "type": "string",
4265
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
4266
- },
4267
- "name": {
4268
- "title": "AI Resolver Name",
4269
- "type": "string",
4270
- "description": "Name of the resolver function.",
4271
- "enum": ["ai:sendAgentMessage"]
4272
- },
4273
- "agentName": {
4274
- "type": "string",
4275
- "pattern": "^[0-9A-Za-z_]+$"
4276
- },
4277
- "inputName": {
4278
- "type": "string",
4279
- "pattern": "^[0-9A-Za-z_]+$"
4280
- }
4281
- },
4282
- "required": ["name", "agentName", "inputName"],
4283
- "additionalProperties": false
4284
- },
4285
- "aiGetAgentMessageResolver": {
4286
- "title": "AIGetAgentMessageResolver",
4287
- "type": "object",
4288
- "properties": {
4289
- "id": {
4290
- "type": "string",
4291
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
4292
- },
4293
- "name": {
4294
- "title": "AI Resolver Name",
4295
- "type": "string",
4296
- "description": "Name of the resolver function.",
4297
- "enum": ["ai:getAgentMessage"]
4298
- },
4299
- "agentName": {
4300
- "type": "string",
4301
- "pattern": "^[0-9A-Za-z_]+$"
4302
- }
4303
- },
4304
- "required": ["name", "agentName"],
4305
- "additionalProperties": false
4306
- },
4307
- "aiAbortAgentMessageResolver": {
4308
- "title": "AIAbortAgentMessageResolver",
4309
- "type": "object",
4310
- "properties": {
4311
- "id": {
4312
- "type": "string",
4313
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
4314
- },
4315
- "name": {
4316
- "title": "AI Resolver Name",
4317
- "type": "string",
4318
- "description": "Name of the resolver function.",
4319
- "enum": ["ai:abortAgentMessage"]
4320
- },
4321
- "agentName": {
4322
- "type": "string",
4323
- "pattern": "^[0-9A-Za-z_]+$"
4324
- }
4325
- },
4326
- "required": ["name", "agentName"],
4327
- "additionalProperties": false
4328
- },
4329
- "aiSendAgentFeedbackResolver": {
4330
- "title": "AISendAgentFeedbackResolver",
4331
- "type": "object",
4332
- "properties": {
4333
- "id": {
4334
- "type": "string",
4335
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
4336
- },
4337
- "name": {
4338
- "title": "AI Resolver Name",
4339
- "type": "string",
4340
- "description": "Name of the resolver function.",
4341
- "enum": ["ai:sendAgentFeedback"]
4342
- },
4343
- "agentName": {
4344
- "type": "string",
4345
- "pattern": "^[0-9A-Za-z_]+$"
4346
- }
4347
- },
4348
- "required": ["name", "agentName"],
4349
- "additionalProperties": false
4350
- },
4351
- "guard": {
4352
- "title": "GuardJSON",
4353
- "description": "A Guard is a configuration for an AI guardrail that can check inputs and outputs and provide safety and compliance.",
4354
- "type": "object",
4355
- "properties": {
4356
- "name": {
4357
- "type": "string",
4358
- "title": "Name",
4359
- "description": "The human-readable name of the Guard."
4360
- },
4361
- "description": {
4362
- "type": "string",
4363
- "title": "Description",
4364
- "description": "A description of the Guard."
4365
- },
4366
- "enabled": {
4367
- "type": "boolean",
4368
- "title": "Enabled",
4369
- "description": "Guards will not run unless enabled.",
4370
- "default": true
4371
- },
4372
- "guardrailIdentifier": {
4373
- "type": "string",
4374
- "title": "Guardrail Identifier",
4375
- "description": "The remote id of the Guardrail."
4376
- },
4377
- "guardrailVersion": {
4378
- "type": "string",
4379
- "title": "Guardrail Version",
4380
- "description": "The remote version of the Guardrail."
4381
- },
4382
- "blockedInputMessaging": {
4383
- "type": "string",
4384
- "title": "Blocked Input Messaging",
4385
- "description": "A message to return when the input message is blocked by the Guard."
4386
- },
4387
- "blockedOutputsMessaging": {
4388
- "type": "string",
4389
- "title": "Blocked Outputs Messaging",
4390
- "description": "A message to return when the output message is blocked by the Guard."
4391
- },
4392
- "topicPolicyConfig": {
4393
- "type": "object",
4394
- "title": "Topic Policy",
4395
- "description": "Topics to identify and block.",
4396
- "properties": {
4397
- "topicsConfig": {
4398
- "title": "Topic",
4399
- "description": "A topic to block.",
4400
- "type": "array",
4401
- "items": {
4402
- "type": "object",
4403
- "properties": {
4404
- "name": {
4405
- "type": "string"
4406
- },
4407
- "definition": {
4408
- "type": "string"
4409
- },
4410
- "examples": {
4411
- "description": "Examples of the topic that can hint the LLM.",
4412
- "type": "array",
4413
- "items": {
4414
- "title": "Example",
4415
- "type": "string"
4416
- },
4417
- "minItems": 1
4418
- },
4419
- "type": {
4420
- "type": "string",
4421
- "enum": ["DENY"]
4422
- }
4423
- },
4424
- "required": ["name", "definition", "type"],
4425
- "additionalProperties": false
4426
- },
4427
- "minItems": 1
4428
- }
4429
- },
4430
- "required": ["topicsConfig"],
4431
- "additionalProperties": false
4432
- },
4433
- "contentPolicyConfig": {
4434
- "type": "object",
4435
- "title": "Content Policy",
4436
- "description": "Types of content to filter and strength configuration.",
4437
- "properties": {
4438
- "filtersConfig": {
4439
- "title": "Filter",
4440
- "description": "Types of content to filter.",
4441
- "type": "array",
4442
- "items": {
4443
- "type": "object",
4444
- "properties": {
4445
- "type": {
4446
- "type": "string",
4447
- "enum": ["HATE", "INSULTS", "MICONDUCT", "PROMPT_ATTACK", "SEXUAL", "VIOLENCE"]
4448
- },
4449
- "inputStrength": {
4450
- "title": "Input Strength",
4451
- "type": "string",
4452
- "enum": ["NONE", "LOW", "MEDIUM", "HIGH"]
4453
- },
4454
- "outputStrength": {
4455
- "title": "Output Strength",
4456
- "type": "string",
4457
- "enum": ["NONE", "LOW", "MEDIUM", "HIGH"]
4458
- },
4459
- "inputModalities": {
4460
- "title": "Input Modalities",
4461
- "description": "Whether to filter images or text",
4462
- "type": "array",
4463
- "items": {
4464
- "$ref": "#/definitions/guardrailModality"
4465
- },
4466
- "minItems": 1
4467
- },
4468
- "outputModalities": {
4469
- "title": "Output Modalities",
4470
- "description": "Whether to filter images or text",
4471
- "type": "array",
4472
- "items": {
4473
- "$ref": "#/definitions/guardrailModality"
4474
- },
4475
- "minItems": 1
4476
- }
4477
- },
4478
- "required": ["type", "inputStrength", "outputStrength"],
4479
- "additionalProperties": false
4480
- },
4481
- "minItems": 1
4482
- }
4483
- },
4484
- "required": ["filtersConfig"],
4485
- "additionalProperties": false
4486
- },
4487
- "wordPolicyConfig": {
4488
- "type": "object",
4489
- "title": "Word Policy",
4490
- "description": "Specific words to identify and block.",
4491
- "properties": {
4492
- "wordsConfig": {
4493
- "title": "Word List",
4494
- "description": "Specific words to block.",
4495
- "type": "array",
4496
- "items": {
4497
- "type": "object",
4498
- "properties": {
4499
- "text": {
4500
- "type": "string"
4501
- }
4502
- },
4503
- "required": ["text"],
4504
- "additionalProperties": false
4505
- },
4506
- "minItems": 1
4507
- },
4508
- "managedWordListsConfig": {
4509
- "title": "Managed Word List",
4510
- "description": "This is solely used for blocking profanity.",
4511
- "type": "array",
4512
- "items": {
4513
- "type": "object",
4514
- "properties": {
4515
- "type": {
4516
- "type": "string",
4517
- "enum": ["PROFANITY"]
4518
- }
4519
- },
4520
- "required": ["type"],
4521
- "additionalProperties": false
4522
- },
4523
- "minItems": 1
4524
- }
4525
- },
4526
- "additionalProperties": false
4527
- },
4528
- "sensitiveInformationPolicyConfig": {
4529
- "title": "Sensitive Information Policy",
4530
- "description": "Filter out and block or obscure sensitive information. Matching text will be handled per the policy.",
4531
- "type": "object",
4532
- "properties": {
4533
- "piiEntitiesConfig": {
4534
- "title": "PII Entity",
4535
- "description": "PII entity to infer from the text.",
4536
- "type": "array",
4537
- "items": {
4538
- "type": "object",
4539
- "properties": {
4540
- "type": {
4541
- "type": "string",
4542
- "enum": [
4543
- "ADDRESS",
4544
- "AGE",
4545
- "AWS_ACCESS_KEY",
4546
- "AWS_SECRET_KEY",
4547
- "CA_HEALTH_NUMBER",
4548
- "CA_SOCIAL_INSURANCE_NUMBER",
4549
- "CREDIT_DEBIT_CARD_CVV",
4550
- "CREDIT_DEBIT_CARD_EXPIRY",
4551
- "CREDIT_DEBIT_CARD_NUMBER",
4552
- "DRIVER_ID",
4553
- "EMAIL",
4554
- "INTERNATIONAL_BANK_ACCOUNT_NUMBER",
4555
- "IP_ADDRESS",
4556
- "LICENSE_PLATE",
4557
- "MAC_ADDRESS",
4558
- "NAME",
4559
- "PASSWORD",
4560
- "PHONE",
4561
- "PIN",
4562
- "SWIFT_CODE",
4563
- "UK_NATIONAL_HEALTH_SERVICE_NUMBER",
4564
- "UK_NATIONAL_INSURANCE_NUMBER",
4565
- "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER",
4566
- "URL",
4567
- "USERNAME",
4568
- "US_BANK_ACCOUNT_NUMBER",
4569
- "US_BANK_ROUTING_NUMBER",
4570
- "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER",
4571
- "US_PASSPORT_NUMBER",
4572
- "US_SOCIAL_SECURITY_NUMBER",
4573
- "VEHICLE_IDENTIFICATION_NUMBER"
4574
- ]
4575
- },
4576
- "action": {
4577
- "$ref": "#/definitions/guardrailSensitiveInformationAction"
4578
- }
4579
- },
4580
- "required": ["type", "action"],
4581
- "additionalProperties": false
4582
- },
4583
- "minItems": 1
4584
- },
4585
- "regexesConfig": {
4586
- "title": "Regular Expression",
4587
- "description": "A regular expression to match sensitive information.",
4588
- "type": "array",
4589
- "items": {
4590
- "type": "object",
4591
- "properties": {
4592
- "name": {
4593
- "type": "string"
4594
- },
4595
- "description": {
4596
- "type": "string"
4597
- },
4598
- "pattern": {
4599
- "type": "string"
4600
- },
4601
- "action": {
4602
- "$ref": "#/definitions/guardrailSensitiveInformationAction"
4603
- }
4604
- },
4605
- "required": ["name", "pattern", "action"],
4606
- "additionalProperties": false
4607
- },
4608
- "minItems": 1
4609
- }
4610
- },
4611
- "additionalProperties": false
4612
- },
4613
- "contextualGroundingPolicyConfig": {
4614
- "title": "Contextual Grounding Policy",
4615
- "description": "Provides evaluations based on grounding text supplied by your in-context agent variables. Off-topic conversations can then be blocked.",
4616
- "type": "object",
4617
- "properties": {
4618
- "filtersConfig": {
4619
- "title": "Filter",
4620
- "description": "Filter to evaluate grounding text.",
4621
- "type": "array",
4622
- "items": {
4623
- "type": "object",
4624
- "properties": {
4625
- "type": {
4626
- "title": "Type",
4627
- "description": "The type of filter.",
4628
- "type": "string",
4629
- "enum": ["GROUNDING", "RELEVANCE"]
4630
- },
4631
- "threshold": {
4632
- "title": "Threshold",
4633
- "description": "The threshold for the filter as a floating point value greater than 0.0 and less than 1.0.",
4634
- "type": "number",
4635
- "multipleOf": 0.01,
4636
- "exclusiveMinimum": 0,
4637
- "exclusiveMaximum": 1
4638
- }
4639
- },
4640
- "required": ["type", "threshold"],
4641
- "additionalProperties": false
4642
- },
4643
- "minItems": 1
4644
- }
4645
- },
4646
- "required": ["filtersConfig"],
4647
- "additionalProperties": false
4648
- }
4649
- },
4650
- "required": ["name"],
4651
- "additionalProperties": false
4652
- },
4653
- "guardMap": {
4654
- "title": "GuardMap",
4655
- "type": "object",
4656
- "patternProperties": {
4657
- "^[0-9A-Za-z_]+$": {
4658
- "$ref": "#/definitions/guard"
4659
- }
4660
- },
4661
- "additionalProperties": false
4662
- },
4663
- "guardrailModality": {
4664
- "title": "Guardrail Modality",
4665
- "type": "string",
4666
- "enum": ["TEXT", "IMAGE"]
4667
- },
4668
- "guardrailSensitiveInformationAction": {
4669
- "title": "Guardrail Sensitive Information Action",
4670
- "type": "string",
4671
- "enum": ["ANONYMIZE", "BLOCK"]
4672
- },
4673
- "aiInspectAgentResolver": {
4674
- "title": "AIInspectAgentResolver",
4675
- "type": "object",
4676
- "properties": {
4677
- "id": {
4678
- "type": "string",
4679
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
4680
- },
4681
- "name": {
4682
- "title": "AI Resolver Name",
4683
- "type": "string",
4684
- "description": "Name of the resolver function.",
4685
- "enum": ["ai:inspectAgent"]
4686
- },
4687
- "agentName": {
4688
- "type": "string",
4689
- "pattern": "^[0-9A-Za-z_]+$"
4690
- }
4691
- },
4692
- "required": ["name", "agentName"],
4693
- "additionalProperties": false
4694
- },
4695
- "aiCreateAgentSessionResolver": {
4696
- "title": "AICreateAgentSessionResolver",
4697
- "type": "object",
4698
- "properties": {
4699
- "id": {
4700
- "type": "string",
4701
- "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
4702
- },
4703
- "name": {
4704
- "title": "AI Resolver Name",
4705
- "type": "string",
4706
- "description": "Name of the resolver function.",
4707
- "enum": ["ai:createAgentSession"]
4708
- },
4709
- "agentName": {
4710
- "type": "string",
4711
- "pattern": "^[0-9A-Za-z_]+$"
4712
- }
4713
- },
4714
- "required": ["name", "agentName"],
4715
- "additionalProperties": false
4716
- },
4717
- "removePropertyKeyPatterns": {
4718
- "type": "array",
4719
- "items": {
4720
- "title": "Minimatch Pattern",
4721
- "type": "string"
4722
- },
4723
- "title": "Remove Property Key Patterns",
4724
- "description": "Remove properties from the schema sent to the model with keys matching these minimatch glob patterns."
4725
- }
4726
- },
4727
- "properties": {
4728
- "$schema": {
4729
- "type": "string"
4730
- },
4731
- "apiVersion": {
4732
- "type": "string",
4733
- "description": "The version of the TakeShape API your project is using. We increase the version as we make breaking changes to the API endpoints."
4734
- },
4735
- "schemaVersion": {
4736
- "type": "string",
4737
- "enum": ["3.57.0"],
4738
- "description": "The version of the schema format your project is using. We increase the version as we make breaking changes to the schema format."
4739
- },
4740
- "projectId": {
4741
- "type": "string",
4742
- "description": "The ID of the TakeShape project this schema belongs to."
4743
- },
4744
- "author": {
4745
- "type": "string",
4746
- "description": "The ID of the TakeShape user who created the schema."
4747
- },
4748
- "deactivated": {
4749
- "type": "number"
4750
- },
4751
- "defaultLocale": {
4752
- "type": "string",
4753
- "minLength": 1,
4754
- "pattern": "^[a-zA-Z]{2,3}(-[a-zA-Z]{2,3})?$",
4755
- "description": "The locale that should be preferred when creating new Shape items. This must be an entry in the locales array."
4756
- },
4757
- "locales": {
4758
- "type": "array",
4759
- "minItems": 1,
4760
- "items": {
4761
- "type": "string",
4762
- "minLength": 1,
4763
- "pattern": "^[a-zA-Z]{2,3}(-[a-zA-Z]{2,3})?$"
4764
- }
4765
- },
4766
- "queries": {
4767
- "$ref": "#/definitions/queryMap",
4768
- "description": "Queries map directly to queries your project's GraphQL API"
4769
- },
4770
- "mutations": {
4771
- "$ref": "#/definitions/queryMap",
4772
- "description": "Mutations map directly to mutations your project's GraphQL API"
4773
- },
4774
- "shapes": {
4775
- "$ref": "#/definitions/shapeMap",
4776
- "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."
4777
- },
4778
- "forms": {
4779
- "$ref": "#/definitions/formMap",
4780
- "description": "Forms define a visual interface for editing Shapes in the TakeShape UI."
4781
- },
4782
- "workflows": {
4783
- "$ref": "#/definitions/workflowMap",
4784
- "description": "Workflows describe the status of a shape item. Every schema starts with a default workflow with two steps, Disabled and Enabled"
4785
- },
4786
- "services": {
4787
- "$ref": "#/definitions/storedServiceMap",
4788
- "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."
4789
- },
4790
- "agents": {
4791
- "$ref": "#/definitions/agentMap",
4792
- "description": "An Agent is a configuration for an AI service such as a chat bot or a search engine."
4793
- },
4794
- "guards": {
4795
- "$ref": "#/definitions/guardMap",
4796
- "description": "A Guard is a configuration for an AI guardrail that can check inputs and outputs and provide safety and compliance."
4797
- },
4798
- "mcp": {
4799
- "$ref": "#/definitions/mcpConfig",
4800
- "description": "MCP server configuration"
4801
- }
4802
- },
4803
- "additionalProperties": false,
4804
- "required": [
4805
- "projectId",
4806
- "apiVersion",
4807
- "schemaVersion",
4808
- "defaultLocale",
4809
- "locales",
4810
- "shapes",
4811
- "queries",
4812
- "mutations",
4813
- "workflows"
4814
- ]
4815
- }