Skip to content

Commit

Permalink
Add workflow response object to workflow creation call.
Browse files Browse the repository at this point in the history
Co-authored-by: Ted Thibodeau Jr <[email protected]>
  • Loading branch information
PatStLouis and TallTed authored Aug 20, 2024
1 parent fc94698 commit c12c194
Showing 1 changed file with 58 additions and 26 deletions.
84 changes: 58 additions & 26 deletions exchanges.yml
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ components:
additionalProperties: false
description: Object containing information for creating a workflow.
properties:
workflowData:
config:
type: object
additionalProperties: false
description: Object containing information for creating a workflow.
Expand Down Expand Up @@ -217,49 +217,81 @@ components:
type: string
template:
type: string
workflowId:
id:
type: string
description: the ID that will be used for the created workflow. workflowId is OPTIONAL.
description: The ID that will be used for the created workflow. Passing an ID is OPTIONAL.
CreateWorkflowResponse:
type: object
additionalProperties: false
description: Object containing information about a created workflow.
description: Response containing the created workflow config Object.
properties:
workflowId:
type: string
description: The URL that uniquely identifies the created workflow.
config:
type: object
additionalProperties: false
description: Object containing information about a created workflow.
properties:
id:
type: string
description: The URL that uniquely identifies the created workflow.
steps:
type: object
description: One or more steps required to complete an exchange on the workflow.
properties:
stepName:
type: object
description: The name of the step.
properties:
step:
$ref: "#/components/schemas/WorkflowStep"
initialStep:
type: string
description: The step from the above set that the exchange starts on.
controller:
type: string
description: The controller of the instance. Returning controller is OPTIONAL.
authorization:
type: object
description: Authorization scheme information (e.g., OAuth2 configuration). Returning authorization is OPTIONAL.
credentialTemplates:
type: array
description: One or more VC templates for issuance. Returning credentialTemplates is OPTIONAL.
items:
type: object
properties:
type:
type: string
description: The type of template.
template:
type: string
description: The template itself.
GetWorkflowResponse:
type: object
additionalProperties: false
description: Object containing information about a workflow.
properties:
workflowData:
config:
type: object
additionalProperties: false
description: Object containing information about a created workflow.
properties:
stepInformation:
exchanges:
type: array
description: The identifiers of the current exchanges associated with the workflow instance.
items:
type: string
steps:
type: object
description: Information about the steps required for the workflow. Returning stepInformation is REQUIRED.
description: One or more steps required to complete an exchange on the workflow.
properties:
exchanges:
type: array
description: The identifiers of the current exchanges associated with the workflow instance.
items:
type: string
steps:
stepName:
type: object
description: One or more steps required to complete an exchange on the workflow.
description: The name of the step.
properties:
stepName:
type: object
description: The name of the step.
properties:
step:
$ref: "#/components/schemas/WorkflowStep"
initialStep:
type: string
description: The step from the above set that the exchange starts on.
step:
$ref: "#/components/schemas/WorkflowStep"
initialStep:
type: string
description: The step from the above set that the exchange starts on.
controller:
type: string
description: The controller of the instance. Returning controller is OPTIONAL.
Expand Down

0 comments on commit c12c194

Please sign in to comment.