asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Updated API Reference (automated) (#12268)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2025-04-23 08:50:17 +00:00
committed by GitHub
parent cb53b8a529
commit c7065fcd2b
37 changed files with 392 additions and 156 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionExecution.yaml
View File

@@ -27,17 +27,20 @@ properties:
type: object
description: The state of the step's invokation function.
x-schemaName: WorkflowExecutionFn
required:
- state
- status
properties:
state:
type: string
description: The invokation step's state.
enum:
- failed
- not_started
- invoking
- compensating
- done
- reverted
- failed
- dormant
- skipped
- skipped_failure
@@ -51,9 +54,6 @@ properties:
- waiting_response
- temp_failure
- permanent_failure
required:
- state
- status
definition:
type: object
description: The step's definition details.
@@ -75,8 +75,20 @@ properties:
type: boolean
title: continueOnPermanentFailure
description: >-
Whether the step continues executing even if its status is
changed to failed.
Whether the workflow should continue executing even if its
status is changed to failed.
skipOnPermanentFailure:
oneOf:
- type: string
title: skipOnPermanentFailure
description: >-
The ID of the step to skip to in case of a permanent
failure.
- type: boolean
title: skipOnPermanentFailure
description: >-
Whether the workflow should skip subsequent steps in case of
a permanent failure.
maxRetries:
type: number
title: maxRetries
@@ -115,17 +127,20 @@ properties:
type: object
description: The state of the step's compensation function.
x-schemaName: WorkflowExecutionFn
required:
- state
- status
properties:
state:
type: string
description: The compensation function's state.
enum:
- failed
- not_started
- invoking
- compensating
- done
- reverted
- failed
- dormant
- skipped
- skipped_failure
@@ -139,9 +154,6 @@ properties:
- waiting_response
- temp_failure
- permanent_failure
required:
- state
- status
depth:
type: number
title: depth