new endpoint to run a process instance

stub for its new method
This commit is contained in:
mike cullerton 2022-06-23 08:08:00 -04:00
parent a1798cc1ea
commit c107482bbc
2 changed files with 57 additions and 7 deletions

View File

@ -357,6 +357,40 @@ paths:
$ref: "#/components/schemas/Workflow"
/process-models/{process_group_id}/{process_model_id}/process-instances/{process_instance_id}:
parameters:
- name: process_group_id
in: path
required: true
description: The unique id of an existing process group
schema:
type: string
- name: process_model_id
in: path
required: true
description: The unique id of an existing process model.
schema:
type: string
- name: process_instance_id
in: path
required: true
description: The unique id of an existing process instance.
schema:
type: integer
# process_instance_delete
delete:
operationId: spiffworkflow_backend.routes.process_api_blueprint.process_instance_delete
summary: Deletes a single process instance
tags:
- Process Instances
responses:
"200":
description: The process instance was deleted.
content:
application/json:
schema:
$ref: "#components/schemas/OkTrue"
/process-models/{process_group_id}/{process_model_id}/process-instances/{process_instance_id}/run:
parameters:
- name: process_group_id
in: path
@ -376,18 +410,25 @@ paths:
description: The unique id of an existing process instance.
schema:
type: integer
delete:
operationId: spiffworkflow_backend.routes.process_api_blueprint.process_instance_delete
summary: Deletes a single process group
- name: do_engine_steps
in: query
required: false
description: Defaults to true, can be set to false if you are just looking at the workflow not completeing it.
schema:
type: boolean
# process_instance_run
post:
operationId: spiffworkflow_backend.routes.process_api_blueprint.process_instance_run
summary: Run a process instance
tags:
- Process Groups
- Process Instances
responses:
"200":
description: The process instance was deleted.
'200':
description: Returns details about the workflows state and current task
content:
application/json:
schema:
$ref: "#components/schemas/OkTrue"
$ref: "#/components/schemas/Workflow"
/process-models/{process_group_id}/{process_model_id}/process-instances/report:
parameters:

View File

@ -275,6 +275,15 @@ def process_instance_create(
json.dumps(process_instance_metadata), status=201, mimetype="application/json"
)
def process_instance_run(
process_group_id: str,
process_model_id: str,
process_instance_id: str,
do_engine_steps: bool
) -> flask.wrappers.Response:
...
def process_instance_list(
process_group_id: str,