chore(oas): [21/21] improve oas schemas (#9339)

* improve oas * more improvements * add missing descriptions --------- Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-09-27 12:40:24 +02:00
parent 38778b37e2
commit 74b3385a65
26 changed files with 433 additions and 235 deletions
@@ -10,6 +10,30 @@
 *   data:
 *     type: object
 *     description: The context's data.
+ *     properties:
+ *       invoke:
+ *         type: object
+ *         description: The step's invokation details.
+ *         required:
+ *           - output
+ *         additionalProperties:
+ *           type: object
+ *           properties:
+ *             output:
+ *               type: object
+ *               description: The invokation's details.
+ *               required:
+ *                 - output
+ *                 - compensateInput
+ *               properties:
+ *                 output:
+ *                   description: the step's output
+ *                 compensateInput:
+ *                   description: the compensation function's input.
+ *       payload:
+ *         description: the payload of the transaction.
+ *     required:
+ *       - invoke
 *   compensate:
 *     type: object
 *     description: The context's compensate.
@@ -18,7 +42,23 @@
 *     description: The context's errors.
 *     items:
 *       type: object
- *       description: The error's errors.
+ *       description: The error's details.
+ *       properties:
+ *         error:
+ *           type: object
+ *           description: The error's details.
+ *         action:
+ *           type: string
+ *           title: action
+ *           description: The error's action.
+ *         handlerType:
+ *           type: string
+ *           title: handlerType
+ *           description: The error's handler type.
+ *       required:
+ *         - error
+ *         - action
+ *         - handlerType
 * 
 */