oas: [3/n] improve oas schemas (#9042)

Improve oas schemas [3/n]
This commit is contained in:
Shahed Nasser
2024-09-07 09:16:00 +03:00
committed by GitHub
parent a7180e29b8
commit 4b8d9cc735
20 changed files with 285 additions and 97 deletions

View File

@@ -1,7 +1,7 @@
/**
* @schema AdminCreateWorkflowsAsyncResponse
* type: object
* description: SUMMARY
* description: The details of changing a workflow execution's step status.
* x-schemaName: AdminCreateWorkflowsAsyncResponse
* required:
* - transaction_id
@@ -10,16 +10,18 @@
* transaction_id:
* type: string
* title: transaction_id
* description: The workflows execution's transaction id.
* description: The workflows execution's transaction ID.
* step_id:
* type: string
* title: step_id
* description: The workflows execution's step id.
* response: {}
* compensate_input: {}
* description: The ID of the step whose status was changed.
* response:
* description: Sets the step's response. It accepts any type.
* compensate_input:
* description: Sets the compensation function's input. It accepts any response.
* action:
* type: string
* description: The workflows execution's action.
* description: Whether to invoke or compensate the step.
* enum:
* - invoke
* - compensate