@takeshape/schema 12.1.1 → 12.1.5

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