sartography
/
cr-connect-workflow
mirror of https://github.com/sartography/cr-connect-workflow.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
cr-connect-workflow/crc/api.yml

1262 lines
36 KiB
YAML
Raw Normal View History

Adds properties and validation to form
2019-12-20 19:32:04 +00:00
openapi: "3.0.2"
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
info:
version: 1.0.0
title: Workflow Microservice
license:
name: MIT
servers:
- url: http://localhost:5000/v1.0
It became impossible to use the Swagger ui when we started adding authentication to all of the calls. I discovered Connexion and Swagger have a default way of handing JTW authentication and this cleans up our code quite a bit, moves the securing of endpoints into the API Definition, which is quite nice, and removes a whole library dependency (I never get to do that!) I added a SWAGGER_AUTH_KEY that can be used in non-production environments to allow users to quickly authenticate from the Swagger ui. I also removed all api calls to simple little happy api services, because that is just mean and pointless.
2020-03-24 18:15:21 +00:00
security:
- jwt: ['secret']
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
paths:
Adds SSO header attributes
2020-02-20 20:35:07 +00:00
/sso_backdoor:
Adding support to handle Single Sign On (Shibboleth) authentication using Flask SSO and an attribute map that has worked in the past with UVA's implementation. Aside from the new user endpoint, nothing requires authentication, but soon everything will expect it. I'm setting up a backdoor we can use for development and staging that will cause a round-robin affair that should make this relatively painless. Dropped "RestException" as we had two ways or raising errors, and that was silly.
2020-02-18 21:38:56 +00:00
get:
operationId: crc.api.user.backdoor
summary: A backdoor that allows someone to log in as a specific user, if they
are in a staging environment.
It became impossible to use the Swagger ui when we started adding authentication to all of the calls. I discovered Connexion and Swagger have a default way of handing JTW authentication and this cleans up our code quite a bit, moves the securing of endpoints into the API Definition, which is quite nice, and removes a whole library dependency (I never get to do that!) I added a SWAGGER_AUTH_KEY that can be used in non-production environments to allow users to quickly authenticate from the Swagger ui. I also removed all api calls to simple little happy api services, because that is just mean and pointless.
2020-03-24 18:15:21 +00:00
security: [] # Disable security for this endpoint only.
Adds SSO header attributes
2020-02-20 20:35:07 +00:00
parameters:
- name: uid
Moves sso_backdoor parameters to query string. Prevents duplication of user on update.
2020-02-21 16:24:39 +00:00
in: query
Adds SSO header attributes
2020-02-20 20:35:07 +00:00
required: true
schema:
type: string
- name: email_address
Moves sso_backdoor parameters to query string. Prevents duplication of user on update.
2020-02-21 16:24:39 +00:00
in: query
Adds SSO header attributes
2020-02-20 20:35:07 +00:00
required: false
schema:
type: string
- name: display_name
Moves sso_backdoor parameters to query string. Prevents duplication of user on update.
2020-02-21 16:24:39 +00:00
in: query
Adds SSO header attributes
2020-02-20 20:35:07 +00:00
required: false
schema:
type: string
- name: affiliation
Moves sso_backdoor parameters to query string. Prevents duplication of user on update.
2020-02-21 16:24:39 +00:00
in: query
Adds SSO header attributes
2020-02-20 20:35:07 +00:00
required: false
schema:
type: string
- name: eppn
Moves sso_backdoor parameters to query string. Prevents duplication of user on update.
2020-02-21 16:24:39 +00:00
in: query
Adds SSO header attributes
2020-02-20 20:35:07 +00:00
required: false
schema:
type: string
- name: first_name
Moves sso_backdoor parameters to query string. Prevents duplication of user on update.
2020-02-21 16:24:39 +00:00
in: query
Adds SSO header attributes
2020-02-20 20:35:07 +00:00
required: false
schema:
type: string
- name: last_name
Moves sso_backdoor parameters to query string. Prevents duplication of user on update.
2020-02-21 16:24:39 +00:00
in: query
Adds SSO header attributes
2020-02-20 20:35:07 +00:00
required: false
schema:
type: string
- name: title
Moves sso_backdoor parameters to query string. Prevents duplication of user on update.
2020-02-21 16:24:39 +00:00
in: query
Adds SSO header attributes
2020-02-20 20:35:07 +00:00
required: false
schema:
type: string
Adds redirect URL to login handler
2020-02-24 21:59:16 +00:00
- name: redirect_url
in: query
required: false
schema:
type: string
Adding support to handle Single Sign On (Shibboleth) authentication using Flask SSO and an attribute map that has worked in the past with UVA's implementation. Aside from the new user endpoint, nothing requires authentication, but soon everything will expect it. I'm setting up a backdoor we can use for development and staging that will cause a round-robin affair that should make this relatively painless. Dropped "RestException" as we had two ways or raising errors, and that was silly.
2020-02-18 21:38:56 +00:00
tags:
- Users
responses:
'304':
description: Redirection to the hosted frontend with an auth_token header.
/user:
get:
operationId: crc.api.user.get_current_user
summary: Returns the current user.
tags:
- Users
responses:
'200':
description: The currently authenticated user.
content:
application/json:
schema:
$ref: "#/components/schemas/User"
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
# /v1.0/study
/study:
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
get:
fixing failed run
2020-01-14 20:39:54 +00:00
operationId: crc.api.study.all_studies
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
summary: Provides a list of studies related to the current user.
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
tags:
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
- Studies
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
responses:
'200':
description: An array of studies, ordered by the last modified date.
content:
application/json:
schema:
$ref: "#/components/schemas/Study"
Adds endpoints for creating and updating a Study.
2020-01-03 16:44:24 +00:00
post:
fixing failed run
2020-01-14 20:39:54 +00:00
operationId: crc.api.study.add_study
Adds endpoints for creating and updating a Study.
2020-01-03 16:44:24 +00:00
summary: Creates a new study with the given parameters.
tags:
- Studies
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Study'
responses:
'200':
description: Study created successfully.
content:
application/json:
schema:
$ref: "#/components/schemas/Study"
Endpoint for studies with files
2020-05-22 15:46:03 +00:00
/study-files:
get:
operationId: crc.api.study.all_studies_and_files
summary: Provides a list of studies with submitted files
tags:
- Studies
responses:
'200':
description: An array of studies, with submitted files, ordered by the last modified date.
content:
application/json:
schema:
Adds endpoints for creating and updating a Study.
2020-01-03 16:44:24 +00:00
$ref: "#/components/schemas/Study"
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
/study/{study_id}:
Removes unsupported read-only flag on File schema for now
2020-01-31 16:33:31 +00:00
parameters:
- name: study_id
in: path
required: true
description: The id of the study for which workflows should be returned.
schema:
type: integer
format: int32
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
get:
fixing failed run
2020-01-14 20:39:54 +00:00
operationId: crc.api.study.get_study
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
summary: Provides a single study
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
tags:
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
- Studies
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
responses:
'200':
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
description: An Study Object
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
content:
application/json:
schema:
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
$ref: "#/components/schemas/Study"
Fixes #11: adding a delete endpoint for studies. It won't delete studies that have workflows, you have to delete those first) Removing the "default" error response from the api.yml, it was all noise.
2020-03-09 19:12:40 +00:00
delete:
operationId: crc.api.study.delete_study
summary: Removes the given study completely.
tags:
- Studies
responses:
'204':
description: The study has been removed.
Removes unsupported read-only flag on File schema for now
2020-01-31 16:33:31 +00:00
put:
fixing failed run
2020-01-14 20:39:54 +00:00
operationId: crc.api.study.update_study
Adds endpoints for creating and updating a Study.
2020-01-03 16:44:24 +00:00
summary: Updates an existing study with the given parameters.
tags:
- Studies
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Study'
responses:
'200':
description: Study updated successfully.
content:
application/json:
schema:
$ref: "#/components/schemas/Study"
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
/workflow-specification:
get:
fixing failed run
2020-01-14 20:39:54 +00:00
operationId: crc.api.workflow.all_specifications
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
summary: Provides a list of workflows specifications that can be added to a study manually. Please note that Protocol Builder will handle this most of the time.
tags:
When you create a study, all possible workflows are then associated with that study.
2020-01-30 14:11:17 +00:00
- Workflow Specifications
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
responses:
'200':
description: An array of workflow specifications
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/WorkflowSpec"
Adds endpoint for adding a workflow specification
2020-01-14 02:43:09 +00:00
post:
fixing failed run
2020-01-14 20:39:54 +00:00
operationId: crc.api.workflow.add_workflow_specification
Adds endpoint for adding a workflow specification
2020-01-14 02:43:09 +00:00
summary: Creates a new workflow specification with the given parameters.
tags:
When you create a study, all possible workflows are then associated with that study.
2020-01-30 14:11:17 +00:00
- Workflow Specifications
Adds endpoint for adding a workflow specification
2020-01-14 02:43:09 +00:00
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowSpec'
responses:
'200':
description: Workflow specification created successfully.
content:
application/json:
schema:
$ref: "#/components/schemas/WorkflowSpec"
Adds endpoint for modifying existing workflow spec
2020-01-14 19:10:53 +00:00
/workflow-specification/{spec_id}:
Adds endpoint to delete workflow spec
2020-01-23 21:05:09 +00:00
parameters:
- name: spec_id
in: path
required: false
description: The unique id of an existing workflow specification to modify.
schema:
type: string
adding an api call for getting a single workflow spec.
2020-01-28 15:14:06 +00:00
get:
operationId: crc.api.workflow.get_workflow_specification
summary: Returns a single workflow specification
tags:
When you create a study, all possible workflows are then associated with that study.
2020-01-30 14:11:17 +00:00
- Workflow Specifications
adding an api call for getting a single workflow spec.
2020-01-28 15:14:06 +00:00
responses:
'200':
description: Workflow specification.
content:
application/json:
schema:
$ref: "#/components/schemas/WorkflowSpec"
Adds endpoint for modifying existing workflow spec
2020-01-14 19:10:53 +00:00
put:
fixing failed run
2020-01-14 20:39:54 +00:00
operationId: crc.api.workflow.update_workflow_specification
Adds endpoint for modifying existing workflow spec
2020-01-14 19:10:53 +00:00
summary: Modifies an existing workflow specification with the given parameters.
tags:
When you create a study, all possible workflows are then associated with that study.
2020-01-30 14:11:17 +00:00
- Workflow Specifications
Adds endpoint for modifying existing workflow spec
2020-01-14 19:10:53 +00:00
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowSpec'
responses:
'200':
description: Workflow specification created successfully.
content:
application/json:
schema:
$ref: "#/components/schemas/WorkflowSpec"
Adds endpoint to delete workflow spec
2020-01-23 21:05:09 +00:00
delete:
operationId: crc.api.workflow.delete_workflow_specification
summary: Removes an existing workflow specification
tags:
When you create a study, all possible workflows are then associated with that study.
2020-01-30 14:11:17 +00:00
- Workflow Specifications
Adds endpoint to delete workflow spec
2020-01-23 21:05:09 +00:00
responses:
'204':
description: The workflow specification has been removed.
Vastly more informative ApiError model that provides details on the underlying task where the error occured. Added a validate_workflow_specification endpoint that allows you to check if the workflow will execute from beginning to end using random data. Minor fixes to existing bpmns to allow them to pass. All scripts must include a "do_task_validate_only" that restricts external calls and database modifications, but performs as much logic as possible.
2020-03-27 12:29:31 +00:00
/workflow-specification/{spec_id}/validate:
parameters:
- name: spec_id
in: path
required: false
description: The unique id of an existing workflow specification to validate.
schema:
type: string
get:
operationId: crc.api.workflow.validate_workflow_specification
summary: Loads and attempts to execute a Workflow Specification, returning a list of errors encountered
tags:
- Workflow Specifications
responses:
'200':
description: Workflow specification.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Error"
Adds CRUD endpoints for workflow spec categories
2020-03-16 20:30:56 +00:00
/workflow-specification-category:
get:
operationId: crc.api.workflow.list_workflow_spec_categories
summary: Provides a list of categories that can be added to a workflow spec.
tags:
Vastly more informative ApiError model that provides details on the underlying task where the error occured. Added a validate_workflow_specification endpoint that allows you to check if the workflow will execute from beginning to end using random data. Minor fixes to existing bpmns to allow them to pass. All scripts must include a "do_task_validate_only" that restricts external calls and database modifications, but performs as much logic as possible.
2020-03-27 12:29:31 +00:00
- Workflow Specification Category
Adds CRUD endpoints for workflow spec categories
2020-03-16 20:30:56 +00:00
responses:
'200':
description: An array of workflow specification categories
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/WorkflowSpecCategory"
post:
operationId: crc.api.workflow.add_workflow_spec_category
summary: Creates a new workflow spec category with the given parameters.
tags:
Vastly more informative ApiError model that provides details on the underlying task where the error occured. Added a validate_workflow_specification endpoint that allows you to check if the workflow will execute from beginning to end using random data. Minor fixes to existing bpmns to allow them to pass. All scripts must include a "do_task_validate_only" that restricts external calls and database modifications, but performs as much logic as possible.
2020-03-27 12:29:31 +00:00
- Workflow Specification Category
Adds CRUD endpoints for workflow spec categories
2020-03-16 20:30:56 +00:00
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowSpecCategory'
responses:
'200':
description: Workflow spec category created successfully.
content:
application/json:
schema:
$ref: "#/components/schemas/WorkflowSpecCategory"
/workflow-specification-category/{cat_id}:
parameters:
- name: cat_id
in: path
required: false
description: The unique id of an existing workflow spec category to modify.
schema:
type: string
get:
operationId: crc.api.workflow.get_workflow_spec_category
summary: Returns a single workflow spec category
tags:
Vastly more informative ApiError model that provides details on the underlying task where the error occured. Added a validate_workflow_specification endpoint that allows you to check if the workflow will execute from beginning to end using random data. Minor fixes to existing bpmns to allow them to pass. All scripts must include a "do_task_validate_only" that restricts external calls and database modifications, but performs as much logic as possible.
2020-03-27 12:29:31 +00:00
- Workflow Specification Category
Adds CRUD endpoints for workflow spec categories
2020-03-16 20:30:56 +00:00
responses:
'200':
description: Workflow spec category.
content:
application/json:
schema:
$ref: "#/components/schemas/WorkflowSpecCategory"
put:
operationId: crc.api.workflow.update_workflow_spec_category
summary: Modifies an existing workflow spec category with the given parameters.
tags:
Vastly more informative ApiError model that provides details on the underlying task where the error occured. Added a validate_workflow_specification endpoint that allows you to check if the workflow will execute from beginning to end using random data. Minor fixes to existing bpmns to allow them to pass. All scripts must include a "do_task_validate_only" that restricts external calls and database modifications, but performs as much logic as possible.
2020-03-27 12:29:31 +00:00
- Workflow Specification Category
Adds CRUD endpoints for workflow spec categories
2020-03-16 20:30:56 +00:00
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowSpecCategory'
responses:
'200':
description: Workflow spec category created successfully.
content:
application/json:
schema:
$ref: "#/components/schemas/WorkflowSpecCategory"
delete:
operationId: crc.api.workflow.delete_workflow_spec_category
summary: Removes an existing workflow spec category
tags:
Vastly more informative ApiError model that provides details on the underlying task where the error occured. Added a validate_workflow_specification endpoint that allows you to check if the workflow will execute from beginning to end using random data. Minor fixes to existing bpmns to allow them to pass. All scripts must include a "do_task_validate_only" that restricts external calls and database modifications, but performs as much logic as possible.
2020-03-27 12:29:31 +00:00
- Workflow Specification Category
Adds CRUD endpoints for workflow spec categories
2020-03-16 20:30:56 +00:00
responses:
'204':
description: The workflow spec category has been removed.
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
/file:
parameters:
Adds ability to get FileModel records by study and task
2020-02-04 02:56:18 +00:00
- name: workflow_spec_id
in: query
required: false
description: The unique id of a workflow specification
schema:
type: string
- name: study_id
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
in: query
required: false
Adds ability to get FileModel records by study and task
2020-02-04 02:56:18 +00:00
description: The unique id of a study
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
schema:
Study ID is an integer. Task ID is a string.
2020-02-04 03:29:41 +00:00
type: integer
Adds workflow_id to file endpoints.
2020-02-04 19:26:53 +00:00
- name: workflow_id
in: query
required: false
description: The unique id of a workflow instance
schema:
type: integer
Adds ability to get FileModel records by study and task
2020-02-04 02:56:18 +00:00
- name: task_id
in: query
required: false
description: The unique id of a workflow task
schema:
Study ID is an integer. Task ID is a string.
2020-02-04 03:29:41 +00:00
type: string
Adds form_field_key to API
2020-02-05 20:06:19 +00:00
- name: form_field_key
in: query
required: false
Assure that files uploaded through web forms and files generated from templates can be cross-referenced to known document requirements from the protocol builder. Configurators can control this by managing an XLS Spreadsheet called "irb_documents.xslx". Required Documents is becoming complicated, so making this it's own script task, removing it from study_info.py The file_service is now very aware of this irb_documents file, so it will always need to exist. We seed this file during setup, but it can be overwritten by the configurator.
2020-03-19 21:13:30 +00:00
description: The unique key of a workflow task form field. Make sure this matches a document in the irb_documents.xslx reference sheet.
Adds form_field_key to API
2020-02-05 20:06:19 +00:00
schema:
type: string
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
get:
fixing failed run
2020-01-14 20:39:54 +00:00
operationId: crc.api.file.get_files
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
summary: Provides a list of files that match the given parameters (such as a spec id) IMPORTANT, only includes metadata, not the file content.
tags:
- Files
responses:
'200':
description: An array of file descriptions (not the file content)
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/File"
Fixes #11: adding a delete endpoint for studies. It won't delete studies that have workflows, you have to delete those first) Removing the "default" error response from the api.yml, it was all noise.
2020-03-09 19:12:40 +00:00
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
post:
fixing failed run
2020-01-14 20:39:54 +00:00
operationId: crc.api.file.add_file
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
summary: Add a new file
tags:
- Files
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
responses:
'200':
description: Metadata about the uploaded file, but not the file content.
content:
application/json:
schema:
$ref: "#/components/schemas/File"
/file/{file_id}:
parameters:
- name: file_id
in: path
required: true
description: The id of the File requested
schema:
type: integer
get:
fixing failed run
2020-01-14 20:39:54 +00:00
operationId: crc.api.file.get_file_info
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
summary: Returns metadata about a file.
tags:
- Files
responses:
'200':
description: Returns the file information requested.
content:
application/json:
schema:
$ref: "#/components/schemas/File"
put:
Renames endpoint methods for clarity. Adds endpoint for just updating file info.
2020-01-31 15:39:19 +00:00
operationId: crc.api.file.update_file_info
Removes unsupported read-only flag on File schema for now
2020-01-31 16:33:31 +00:00
summary: Updates existing file info with the given parameters.
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
tags:
- Files
requestBody:
content:
Renames endpoint methods for clarity. Adds endpoint for just updating file info.
2020-01-31 15:39:19 +00:00
application/json:
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
schema:
Removes unsupported read-only flag on File schema for now
2020-01-31 16:33:31 +00:00
$ref: '#/components/schemas/File'
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
responses:
'200':
Removes unsupported read-only flag on File schema for now
2020-01-31 16:33:31 +00:00
description: File info updated successfully.
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
content:
application/json:
schema:
$ref: "#/components/schemas/File"
delete:
fixing failed run
2020-01-14 20:39:54 +00:00
operationId: crc.api.file.delete_file
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
summary: Removes an existing file
tags:
- Files
responses:
'204':
description: The file has been removed.
stuff that might be broken.
2020-05-23 19:21:30 +00:00
/file/{file_id}/data/{version}:
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
parameters:
- name: file_id
in: path
required: true
description: The id of the File requested
schema:
type: integer
stuff that might be broken.
2020-05-23 19:21:30 +00:00
- name: version
in: path
required: false
description: The version of the file, or none for latest version
schema:
type: integer
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
get:
Renames endpoint methods for clarity. Adds endpoint for just updating file info.
2020-01-31 15:39:19 +00:00
operationId: crc.api.file.get_file_data
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
summary: Returns only the file contents
tags:
- Files
responses:
'200':
description: Returns the actual file
content:
application/octet-stream:
schema:
type: string
format: binary
example: '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions></bpmn:definitions>'
Renames endpoint methods for clarity. Adds endpoint for just updating file info.
2020-01-31 15:39:19 +00:00
put:
operationId: crc.api.file.update_file_data
summary: Update only the file contents for a given file
tags:
- Files
requestBody:
content:
multipart/form-data:
schema:
Attempting to address "FutureWarning: Implicit (flask) JSON serialization" warning
2020-03-16 17:24:15 +00:00
x-body-name: file
Renames endpoint methods for clarity. Adds endpoint for just updating file info.
2020-01-31 15:39:19 +00:00
type: object
properties:
file:
type: string
format: binary
Attempting to address "FutureWarning: Implicit (flask) JSON serialization" warning
2020-03-16 17:24:15 +00:00
required:
- file
Renames endpoint methods for clarity. Adds endpoint for just updating file info.
2020-01-31 15:39:19 +00:00
responses:
'200':
Fix the API so we are clear what is being returned when updating a file.
2020-03-25 12:06:58 +00:00
description: Returns the updated file model with the new version information.
Renames endpoint methods for clarity. Adds endpoint for just updating file info.
2020-01-31 15:39:19 +00:00
content:
Fix the API so we are clear what is being returned when updating a file.
2020-03-25 12:06:58 +00:00
application/json:
Renames endpoint methods for clarity. Adds endpoint for just updating file info.
2020-01-31 15:39:19 +00:00
schema:
Fix the API so we are clear what is being returned when updating a file.
2020-03-25 12:06:58 +00:00
$ref: "#/components/schemas/File"
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
# /v1.0/workflow/0
Add the ability to upload and request general reference files by name. These will be used across workflows and will frequently contain lookup tables that can be referenced by various script tasks.
2020-03-13 19:03:57 +00:00
/reference_file:
get:
operationId: crc.api.file.get_reference_files
summary: Provides a list of existing reference files that are available in the system.
tags:
- Files
responses:
'200':
description: An array of file descriptions (not the file content)
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/File"
/reference_file/{name}:
parameters:
- name: name
in: path
required: true
description: The special name of the reference file.
schema:
type: string
get:
operationId: crc.api.file.get_reference_file
summary: Reference files are called by name rather than by id.
tags:
- Files
responses:
'200':
description: Returns the actual file
content:
application/octet-stream:
schema:
type: string
format: binary
example: '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions></bpmn:definitions>'
put:
operationId: crc.api.file.set_reference_file
summary: Update the contents of a named reference file.
tags:
- Files
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
responses:
'200':
description: Returns the actual file
content:
application/octet-stream:
schema:
type: string
format: binary
example: '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions></bpmn:definitions>'
# /v1.0/workflow/0
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
/workflow/{workflow_id}:
Add the ability to delete a workflow.
2019-12-30 18:15:39 +00:00
parameters:
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
- name: workflow_id
in: path
required: true
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
description: The id of the workflow
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
schema:
type: integer
format: int32
Add the ability to delete a workflow.
2019-12-30 18:15:39 +00:00
get:
fixing failed run
2020-01-14 20:39:54 +00:00
operationId: crc.api.workflow.get_workflow
Functional multi-instance - works with no changes to the front end - though I've added some attributes to task so we could give people a sense of how many iterations they will go through.
2020-04-19 19:14:10 +00:00
summary: Returns a workflow, can also be used to do a soft or hard reset on the workflow.
Expose a flag on the workflow model in the api to shown if it is using the latest spec. Added a soft_reset and hard_reset onto the workflow endpoint that will allow you to cause a hard or soft reset.
2020-03-05 21:45:44 +00:00
parameters:
- name: soft_reset
in: query
required: false
description: Set this to true to use the latest workflow specification to load minor modifications to the spec.
schema:
type: boolean
- name: hard_reset
in: query
required: false
description: Set this to true to reset the workflow
schema:
type: boolean
Add the ability to delete a workflow.
2019-12-30 18:15:39 +00:00
tags:
- Workflows and Tasks
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
responses:
'200':
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
description: Returns details about the workflows state and current task
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
content:
application/json:
schema:
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
$ref: "#/components/schemas/Workflow"
Add the ability to delete a workflow.
2019-12-30 18:15:39 +00:00
delete:
Deleteing stuff is a damn mess, but this is a little cleaner.
2020-04-29 20:07:39 +00:00
operationId: crc.api.workflow.delete_workflow
Add the ability to delete a workflow.
2019-12-30 18:15:39 +00:00
summary: Removes an existing workflow
tags:
Stupid tag
2019-12-30 18:34:18 +00:00
- Workflows and Tasks
Add the ability to delete a workflow.
2019-12-30 18:15:39 +00:00
responses:
'204':
description: The workflow was removed
Adding an API Endpoint that will return a list of LookupValues that match a given query - can be used to populate an auto-complete table.
2020-04-22 23:40:40 +00:00
/workflow/{workflow_id}/task/{task_id}/data:
WIP
2020-01-07 18:23:46 +00:00
parameters:
- name: workflow_id
in: path
required: true
description: The id of the workflow
schema:
type: integer
format: int32
Allow submitting data and progressing to the next task in a workflow.
2020-01-14 16:02:44 +00:00
- name: task_id
WIP
2020-01-07 18:23:46 +00:00
in: path
required: true
description: The id of the task
schema:
type: string
Allow submitting data and progressing to the next task in a workflow.
2020-01-14 16:02:44 +00:00
format: uuid
Adding an API Endpoint that will return a list of LookupValues that match a given query - can be used to populate an auto-complete table.
2020-04-22 23:40:40 +00:00
put:
operationId: crc.api.workflow.update_task
summary: Exclusively for User Tasks, submits form data as a flat set of key/values.
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
tags:
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
- Workflows and Tasks
Adding an API Endpoint that will return a list of LookupValues that match a given query - can be used to populate an auto-complete table.
2020-04-22 23:40:40 +00:00
requestBody:
description: Key / Value pairs in JSON format.
required: true
content:
application/json:
schema:
type: object
example:
favorite_color: blue
capital_assyria: Assur
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
responses:
Adding an API Endpoint that will return a list of LookupValues that match a given query - can be used to populate an auto-complete table.
2020-04-22 23:40:40 +00:00
'201':
Adding an API endpoint that allows setting the token on the workflow to a specific task. Added error checking such that attempting to submit data for a task that is not in the "READY" state throws an error message. For some reason I'm getting lots of errors in the tests as they try to hit API endpoints they were not hitting before, so adding a number of mocks to some of the study service tests.
2020-04-28 21:25:53 +00:00
description: Returns the updated workflow with this task as the current task.
content:
application/json:
schema:
$ref: "#/components/schemas/Workflow"
/workflow/{workflow_id}/task/{task_id}/set_token:
parameters:
- name: workflow_id
in: path
required: true
description: The id of the workflow
schema:
type: integer
format: int32
- name: task_id
in: path
required: true
description: The id of the task
schema:
type: string
format: uuid
put:
operationId: crc.api.workflow.set_current_task
summary: Attempts to make the given task the Current Active Task
tags:
- Workflows and Tasks
responses:
'201':
description: Returns the updated workflow with this task as the current task.
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
content:
application/json:
schema:
Adding an API Endpoint that will return a list of LookupValues that match a given query - can be used to populate an auto-complete table.
2020-04-22 23:40:40 +00:00
$ref: "#/components/schemas/Workflow"
/workflow/{workflow_id}/task/{task_id}/lookup/{field_id}:
Allow submitting data and progressing to the next task in a workflow.
2020-01-14 16:02:44 +00:00
parameters:
- name: workflow_id
in: path
required: true
description: The id of the workflow
schema:
type: integer
format: int32
- name: task_id
in: path
required: true
description: The id of the task
schema:
type: string
format: uuid
Adding an API Endpoint that will return a list of LookupValues that match a given query - can be used to populate an auto-complete table.
2020-04-22 23:40:40 +00:00
- name: field_id
in: path
required: true
description: The id of the field (as set in the bpmn editor) on which to do a lookup.
schema:
type: string
- name: query
in: query
required: false
description: The string to search for in the Value column of the lookup table.
schema:
type: string
- name: limit
in: query
required: false
description: The total number of records to return, defaults to 10.
schema:
type: integer
get:
operationId: crc.api.workflow.lookup
summary: Provides type-ahead search against a lookup table associted with a form field.
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
tags:
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
- Workflows and Tasks
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
responses:
'201':
Adding an API Endpoint that will return a list of LookupValues that match a given query - can be used to populate an auto-complete table.
2020-04-22 23:40:40 +00:00
description: Returns the a list of values and labels for a lookup form.
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
content:
application/json:
schema:
Adding an API Endpoint that will return a list of LookupValues that match a given query - can be used to populate an auto-complete table.
2020-04-22 23:40:40 +00:00
$ref: "#/components/schemas/LookupItem"
New set of "Tools" api endpoints, that provides a way to quickly render markdown or word documents by uploading json data and a template to populate. Improved Error messages / Error processing. You can now just throw an APIError anywhere, and it will be properly serialized and returned.
2020-02-29 22:22:38 +00:00
/render_markdown:
parameters:
- name: data
in: query
required: true
description: The json data to use in populating the template
schema:
type: string
- name: template
in: query
required: true
description: The markdown template to process.
schema:
type: string
get:
operationId: crc.api.tools.render_markdown
It became impossible to use the Swagger ui when we started adding authentication to all of the calls. I discovered Connexion and Swagger have a default way of handing JTW authentication and this cleans up our code quite a bit, moves the securing of endpoints into the API Definition, which is quite nice, and removes a whole library dependency (I never get to do that!) I added a SWAGGER_AUTH_KEY that can be used in non-production environments to allow users to quickly authenticate from the Swagger ui. I also removed all api calls to simple little happy api services, because that is just mean and pointless.
2020-03-24 18:15:21 +00:00
security: [] # Disable security for this endpoint only.
New set of "Tools" api endpoints, that provides a way to quickly render markdown or word documents by uploading json data and a template to populate. Improved Error messages / Error processing. You can now just throw an APIError anywhere, and it will be properly serialized and returned.
2020-02-29 22:22:38 +00:00
summary: Processes the markdown template using the data provided.
tags:
- Configurator Tools
responses:
'201':
description: Returns the updated workflow with the task completed.
content:
text/plain:
schema:
type: string
/render_docx:
put:
operationId: crc.api.tools.render_docx
It became impossible to use the Swagger ui when we started adding authentication to all of the calls. I discovered Connexion and Swagger have a default way of handing JTW authentication and this cleans up our code quite a bit, moves the securing of endpoints into the API Definition, which is quite nice, and removes a whole library dependency (I never get to do that!) I added a SWAGGER_AUTH_KEY that can be used in non-production environments to allow users to quickly authenticate from the Swagger ui. I also removed all api calls to simple little happy api services, because that is just mean and pointless.
2020-03-24 18:15:21 +00:00
security: [] # Disable security for this endpoint only.
New set of "Tools" api endpoints, that provides a way to quickly render markdown or word documents by uploading json data and a template to populate. Improved Error messages / Error processing. You can now just throw an APIError anywhere, and it will be properly serialized and returned.
2020-02-29 22:22:38 +00:00
summary: Renders a docx template with embedded jinja2 markup.
tags:
- Configurator Tools
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
On the tools/render_docx api, allow sending the json data in the body, rather than as a ludicrous long get parameter. Silly Dan.
2020-05-22 19:30:22 +00:00
data:
type: string
format: json
New set of "Tools" api endpoints, that provides a way to quickly render markdown or word documents by uploading json data and a template to populate. Improved Error messages / Error processing. You can now just throw an APIError anywhere, and it will be properly serialized and returned.
2020-02-29 22:22:38 +00:00
responses:
'200':
description: Returns the generated document.
content:
application/octet-stream:
schema:
type: string
format: binary
example: '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions></bpmn:definitions>'
Adding a simple endpoint that describes what scripts are currently available, along with a brief description.
2020-03-03 20:30:42 +00:00
/list_scripts:
get:
operationId: crc.api.tools.list_scripts
It became impossible to use the Swagger ui when we started adding authentication to all of the calls. I discovered Connexion and Swagger have a default way of handing JTW authentication and this cleans up our code quite a bit, moves the securing of endpoints into the API Definition, which is quite nice, and removes a whole library dependency (I never get to do that!) I added a SWAGGER_AUTH_KEY that can be used in non-production environments to allow users to quickly authenticate from the Swagger ui. I also removed all api calls to simple little happy api services, because that is just mean and pointless.
2020-03-24 18:15:21 +00:00
security: [] # Disable security for this endpoint only.
Adding a simple endpoint that describes what scripts are currently available, along with a brief description.
2020-03-03 20:30:42 +00:00
summary: Returns an list of scripts, along with their descriptions
tags:
- Configurator Tools
responses:
'201':
description: The list of scripts
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Script"
Building out the boilerplate code to make pushing forward on this a little friendlier. There is an approval api file, and approval model file and an approval test file.
2020-05-22 22:25:00 +00:00
/approval:
parameters:
- name: approver_uid
in: query
required: false
description: Restrict results to a given approver uid, maybe we restrict the use of this at somepoint.
schema:
type: string
get:
operationId: crc.api.approval.get_approvals
summary: Provides a list of workflows approvals
tags:
- Approvals
responses:
'200':
description: An array of approvals
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Approval"
/approval/{approval_id}:
parameters:
- name: approval_id
in: path
required: true
description: The id of the approval in question.
schema:
type: integer
format: int32
put:
operationId: crc.api.approval.update_approval
summary: Updates an approval with the given parameters
tags:
- Approvals
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Approval'
responses:
'200':
description: Study updated successfully.
content:
application/json:
schema:
$ref: "#/components/schemas/Approval"
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
components:
It became impossible to use the Swagger ui when we started adding authentication to all of the calls. I discovered Connexion and Swagger have a default way of handing JTW authentication and this cleans up our code quite a bit, moves the securing of endpoints into the API Definition, which is quite nice, and removes a whole library dependency (I never get to do that!) I added a SWAGGER_AUTH_KEY that can be used in non-production environments to allow users to quickly authenticate from the Swagger ui. I also removed all api calls to simple little happy api services, because that is just mean and pointless.
2020-03-24 18:15:21 +00:00
securitySchemes:
jwt:
type: http
scheme: bearer
bearerFormat: JWT
x-bearerInfoFunc: crc.api.user.verify_token
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
schemas:
Adding support to handle Single Sign On (Shibboleth) authentication using Flask SSO and an attribute map that has worked in the past with UVA's implementation. Aside from the new user endpoint, nothing requires authentication, but soon everything will expect it. I'm setting up a backdoor we can use for development and staging that will cause a round-robin affair that should make this relatively painless. Dropped "RestException" as we had two ways or raising errors, and that was silly.
2020-02-18 21:38:56 +00:00
User:
properties:
uid:
type: string
email_address:
type: string
display_name:
type: string
Adds SSO header attributes
2020-02-20 20:35:07 +00:00
affiliation:
type: string
eppn:
type: string
first_name:
type: string
last_name:
type: string
title:
type: string
Refactor models into seperate directories
2019-12-31 21:32:47 +00:00
DataModel:
properties:
id:
type: string
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
Study:
properties:
id:
Tasks can have forms and they are returned correctly.
2019-12-19 16:58:51 +00:00
type: integer
example: 1234
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
title:
type: string
example: The impact of fried pickles on beer consumption in bipedal software developers.
last_updated:
type: string
format: date_time
example: "2019-12-25T09:12:33.001Z"
updating the API Removing the call for study/workflows - as workflow information is returned with the study by default. Fixing a bug in the workflow spec model schema.
2020-03-30 14:12:10 +00:00
primary_investigator_id:
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
type: string
updating the API Removing the call for study/workflows - as workflow information is returned with the study by default. Fixing a bug in the workflow spec model schema.
2020-03-30 14:12:10 +00:00
example: dhf8r
Adds user_uid and investigator_ids fields to Study. Gets studies from protocol builder and adds them if they aren't already in the database
2020-02-26 23:06:51 +00:00
user_uid:
type: string
example: dhf8r
updating the API Removing the call for study/workflows - as workflow information is returned with the study by default. Fixing a bug in the workflow spec model schema.
2020-03-30 14:12:10 +00:00
protocol_builder_status:
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
type: string
Updated the study status to use a different enumeration. Migration correctly handles modifying the enum. INCOMPLETE = 'Incomplete in Protocol Builder', ACTIVE = 'Active / Ready to roll', HOLD = 'On Hold', OPEN = 'Open - this study is in progress', ABANDONED = 'Abandoned, it got deleted in Protocol Builder'
2020-04-21 21:13:30 +00:00
enum: [INCOMPLETE, ACTIVE, HOLD, OPEN, ABANDONED]
updating the API Removing the call for study/workflows - as workflow information is returned with the study by default. Fixing a bug in the workflow spec model schema.
2020-03-30 14:12:10 +00:00
example: done
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
sponsor:
type: string
example: "Sartography Pharmaceuticals"
ind_number:
type: string
example: "27b-6-42"
updating the API Removing the call for study/workflows - as workflow information is returned with the study by default. Fixing a bug in the workflow spec model schema.
2020-03-30 14:12:10 +00:00
hsr_number:
type: string
fixing a bug that was causing failing tests. Adding id and spec_version to the workflow metadata. Refactoring the processing of the master_spec so that it doesn't polute the workflow database. Adding tests to assure that the status and counts are updated on the workflow model as users make progress.
2020-03-30 18:01:57 +00:00
x-nullable: true
updating the API Removing the call for study/workflows - as workflow information is returned with the study by default. Fixing a bug in the workflow spec model schema.
2020-03-30 14:12:10 +00:00
example: "27b-6-1212"
categories:
type: array
items:
$ref: "#/components/schemas/WorkflowSpecCategory"
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
WorkflowSpec:
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
properties:
id:
type: string
Adds workflow spec category to API
2020-03-16 16:10:32 +00:00
name:
type: string
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
display_name:
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
type: string
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
description:
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
type: string
Adds workflow spec category to API
2020-03-16 16:10:32 +00:00
primary_process_id:
type: string
nullable: true
Created a "StudyService" and moved all complex logic around study manipulation out of the study api, and this service, as things were getting complicated. The Workflow Processor no longer creates the WorkflowModel, the study object handles that, and only passes the model into the workflow processor when it is ready to start the workflow. Created a Study object (seperate from the StudyModel) that can cronstructed on request, and contains a different data structure than we store in the DB. This allows us to return underlying Categories and Workflows in a clean way. Added a new status to workflows called "not_started", meaning we have not yet instantiated a processor or created a BPMN, they have no version yet and no stored data, just the possiblity of being started. The Top Level Workflow or "Master" workflow is now a part of the sample data, and loaded at all times. Removed the ability to "add a workflow to a study" and "remove a workflow from a study", a study contains all possible workflows by definition. Example data no longer creates users or studies, it just creates the specs.
2020-03-30 12:00:16 +00:00
category_id:
Adds workflow spec category to API
2020-03-16 16:10:32 +00:00
type: integer
nullable: true
workflow_spec_category:
$ref: "#/components/schemas/WorkflowSpecCategory"
is_status:
type: boolean
nullable: true
WorkflowSpecCategory:
properties:
id:
type: integer
name:
type: string
display_name:
type: string
Adds display order to categories
2020-03-26 19:29:52 +00:00
display_order:
type: integer
updating the API Removing the call for study/workflows - as workflow information is returned with the study by default. Fixing a bug in the workflow spec model schema.
2020-03-30 14:12:10 +00:00
workflows:
type: array
items:
$ref: "#/components/schemas/Workflow"
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
File:
properties:
id:
type: number
name:
type: string
example: "random_fact.bpmn"
version:
Removes unsupported read-only flag on File schema for now
2020-01-31 16:33:31 +00:00
type: integer
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
last_updated:
type: string
format: date_time
example: "2019-12-25T09:12:33.001Z"
type:
Removes unsupported read-only flag on File schema for now
2020-01-31 16:33:31 +00:00
type: string
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
primary:
type: boolean
content_type:
type: string
example: "application/xml"
workflow_spec_id:
type: string
example: "random_fact"
Found a few errors in the sqlalchemy file definition that was causing failures, and had some consistency problems with the IRB Categories file name. The API was bailing out because we had restricted file types to bpmn,svg,or dmn in the connexion config file, I don't restrict this anymore we have plenty of checks elsewhere. Adding xlrd as a dependency - this didn't fail till a push to production.
2020-03-20 12:21:21 +00:00
x-nullable: true
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
file:
type: file
format: binary
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
Workflow:
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
properties:
id:
readOnly: true
type: integer
format: int64
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
status:
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
type: enum
Returning better cleaner information about workflow with the workflow endpoint. Removes the get_all_tasks and get_user_tasks endpoints as tasks are returned with the workflow. Workflow endpoint also includes the last task and next_task, which may or may not be user tasks. The task "type" returned is now the class name of the task_spec, rather than just the word "task".
2020-02-07 16:34:44 +00:00
enum: ['new','user_input_required','waiting','complete']
adding a navigation component to the Workflow Model. running all extension/properties through the Jinja template processor so you can have custom display names using data, very helpful for building multi-instance displays. Properties was returned as an array of key/value pairs, which is just mean. Switched this to a dictionary.
2020-05-14 17:43:23 +00:00
navigation:
type: array
items:
$ref: "#/components/schemas/NavigationItem"
Cleaning up swagger docs.
2020-03-05 22:10:00 +00:00
next_task:
$ref: "#/components/schemas/Task"
Adds workflow_spec_id back in to WorkflowApi
2020-02-07 17:36:08 +00:00
workflow_spec_id:
type: string
Cleaning up swagger docs.
2020-03-05 22:10:00 +00:00
spec_version:
type: string
is_latest_spec:
type: boolean
Adds task counts
2020-03-10 19:46:14 +00:00
num_tasks_total:
type: integer
num_tasks_complete:
type: integer
num_tasks_incomplete:
type: integer
Returning better cleaner information about workflow with the workflow endpoint. Removes the get_all_tasks and get_user_tasks endpoints as tasks are returned with the workflow. Workflow endpoint also includes the last task and next_task, which may or may not be user tasks. The task "type" returned is now the class name of the task_spec, rather than just the word "task".
2020-02-07 16:34:44 +00:00
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
example:
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
id: 291234
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
status: 'user_input_required'
Cleaning up swagger docs.
2020-03-05 22:10:00 +00:00
workflow_spec_id: 'random_fact'
spec_version: 'v1.1 [22,23]'
is_latest_spec: True
next_task:
id: study_identification
name: Study Identification
title: IRB Review
documentation: "# Heading 1\n\nMarkdown documentation text goes here"
type: form
state: ready
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
Task:
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
properties:
id:
readOnly: true
Adds properties and validation to form
2019-12-20 19:32:04 +00:00
type: string
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
name:
type: string
Adds task title and documentation
2019-12-20 20:39:02 +00:00
title:
type: string
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
type:
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
type: string
Adds properties and validation to form
2019-12-20 19:32:04 +00:00
state:
Tasks can have forms and they are returned correctly.
2019-12-19 16:58:51 +00:00
type: string
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
form:
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
$ref: "#/components/schemas/Form"
Adds task title and documentation
2019-12-20 20:39:02 +00:00
documentation:
type: string
massive overhaul of the Workflow API endpoint. No Previous Task, No Last Task, No Task List. Just the current task, and the Navigation. Use the token endpoint to set the current task, even if it is a "READY" task in the api. Previous Task can be set by identifying the prior task in the Navigation (I'm hoping) Prefering camel case to snake case on all new apis. Maybe clean the rest up later.
2020-05-15 19:54:53 +00:00
data:
type: object
the heck with camel case, what the heck TypeScript? Get a grip. This is a python API.
2020-05-15 20:38:37 +00:00
multi_instance_type:
massive overhaul of the Workflow API endpoint. No Previous Task, No Last Task, No Task List. Just the current task, and the Navigation. Use the token endpoint to set the current task, even if it is a "READY" task in the api. Previous Task can be set by identifying the prior task in the Navigation (I'm hoping) Prefering camel case to snake case on all new apis. Maybe clean the rest up later.
2020-05-15 19:54:53 +00:00
type: enum
enum: ['none', 'looping', 'parallel', 'sequential']
the heck with camel case, what the heck TypeScript? Get a grip. This is a python API.
2020-05-15 20:38:37 +00:00
multi_instance_count:
massive overhaul of the Workflow API endpoint. No Previous Task, No Last Task, No Task List. Just the current task, and the Navigation. Use the token endpoint to set the current task, even if it is a "READY" task in the api. Previous Task can be set by identifying the prior task in the Navigation (I'm hoping) Prefering camel case to snake case on all new apis. Maybe clean the rest up later.
2020-05-15 19:54:53 +00:00
type: number
the heck with camel case, what the heck TypeScript? Get a grip. This is a python API.
2020-05-15 20:38:37 +00:00
multi_instance_index:
massive overhaul of the Workflow API endpoint. No Previous Task, No Last Task, No Task List. Just the current task, and the Navigation. Use the token endpoint to set the current task, even if it is a "READY" task in the api. Previous Task can be set by identifying the prior task in the Navigation (I'm hoping) Prefering camel case to snake case on all new apis. Maybe clean the rest up later.
2020-05-15 19:54:53 +00:00
type: number
the heck with camel case, what the heck TypeScript? Get a grip. This is a python API.
2020-05-15 20:38:37 +00:00
process_name:
massive overhaul of the Workflow API endpoint. No Previous Task, No Last Task, No Task List. Just the current task, and the Navigation. Use the token endpoint to set the current task, even if it is a "READY" task in the api. Previous Task can be set by identifying the prior task in the Navigation (I'm hoping) Prefering camel case to snake case on all new apis. Maybe clean the rest up later.
2020-05-15 19:54:53 +00:00
type: string
properties:
type: object
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
example:
Adds properties and validation to form
2019-12-20 19:32:04 +00:00
id: study_identification
name: Study Identification
Adds task title and documentation
2019-12-20 20:39:02 +00:00
title: IRB Review
documentation: "# Heading 1\n\nMarkdown documentation text goes here"
Adds properties and validation to form
2019-12-20 19:32:04 +00:00
type: form
state: ready
form:
"key": "irb_review_form"
"fields":
- "id": "irb_review_type"
"type": "enum"
"label": "Select IRB Review Type"
"options":
- id: "emergency_use"
name: "Emergency Use"
- id: "humanitarian_device"
name: "Humanitarian Device"
- id: "non_human"
name: "Non-Human"
- id: "non_uva_agent"
name: "Non-UVA Agent"
- id: "exempt"
name: "Exempt"
- id: "non_engaged"
name: "Non-Engaged"
- id: "expedited"
name: "Expedited"
- id: "full_board"
name: "Full Board"
Adds default_value to Task schema
2020-02-18 15:14:03 +00:00
"default_value": "Full Board"
Adds properties and validation to form
2019-12-20 19:32:04 +00:00
"validation":
- name: "required"
config: "true"
"properties":
- id: "description"
value: "Description text goes here"
- id: "help"
value: "# Heading 1\n\nMarkdown help text goes here"
- id: "required_expression"
value: "model.my_boolean_field_id && model.my_enum_field_value !== 'something'"
- id: "hide_expression"
value: "model.my_enum_field_value === 'something'"
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
Form:
properties:
Adds properties and validation to form
2019-12-20 19:32:04 +00:00
key:
type: string
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
fields:
type: array
items:
$ref: "#/components/schemas/Field"
Adds properties and validation to form
2019-12-20 19:32:04 +00:00
example:
"key": "irb_review_form"
"fields":
- "id": "irb_review_type"
"type": "enum"
"label": "Select IRB Review Type"
"options":
- id: "emergency_use"
name: "Emergency Use"
- id: "humanitarian_device"
name: "Humanitarian Device"
- id: "non_human"
name: "Non-Human"
- id: "non_uva_agent"
name: "Non-UVA Agent"
- id: "exempt"
name: "Exempt"
- id: "non_engaged"
name: "Non-Engaged"
- id: "expedited"
name: "Expedited"
- id: "full_board"
name: "Full Board"
Adds default_value to Task schema
2020-02-18 15:14:03 +00:00
"default_value": "Full Board"
Adds properties and validation to form
2019-12-20 19:32:04 +00:00
"validation":
- name: "required"
config: "true"
"properties":
- id: "description"
value: "Description text goes here"
- id: "help"
value: "# Heading 1\n\nMarkdown help text goes here"
- id: "required_expression"
value: "model.my_boolean_field_id && model.my_enum_field_value !== 'something'"
- id: "hide_expression"
value: "model.my_enum_field_value === 'something'"
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
Field:
properties:
id:
type: string
readOnly: true
type:
type: enum
Adds properties and validation to form
2019-12-20 19:32:04 +00:00
enum: ['string', 'long', 'boolean', 'date', 'enum']
readOnly: true
label:
type: string
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
readOnly: true
options:
type: array
items:
Adds properties and validation to form
2019-12-20 19:32:04 +00:00
$ref: "#/components/schemas/EnumFieldOption"
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
readOnly: true
Adds default_value to Task schema
2020-02-18 15:14:03 +00:00
default_value:
Adds properties and validation to form
2019-12-20 19:32:04 +00:00
type: string
Adds default_value to Task schema
2020-02-18 15:14:03 +00:00
readOnly: true
Adds properties and validation to form
2019-12-20 19:32:04 +00:00
validation:
type: array
items:
$ref: "#/components/schemas/FieldValidation"
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
readOnly: true
Adds properties and validation to form
2019-12-20 19:32:04 +00:00
"properties":
type: array
items:
$ref: "#/components/schemas/FieldProperty"
readOnly: true
EnumFieldOption:
properties:
id:
type: string
name:
type: string
FieldValidation:
properties:
name:
type: string
config:
type: string
FieldProperty:
properties:
id:
type: string
Lots and lots of random stuff as I organize code and get things to make sense.
2019-12-18 19:02:17 +00:00
value:
type: string
Adds properties and validation to form
2019-12-20 19:32:04 +00:00
example:
id: "required_expression"
value: "model.should_require"
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
Error:
required:
- code
- message
properties:
code:
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
type: string
format: string
example: "access_denied"
Adds basic Flask, Connexion, and SpiffWorkflow structure
2019-11-19 20:57:46 +00:00
message:
type: string
Createing Swagger API documentation that I intend to build out to support the front end.
2019-12-11 21:54:24 +00:00
example: "You do not have permission to view the requested study."
Adding a simple endpoint that describes what scripts are currently available, along with a brief description.
2020-03-03 20:30:42 +00:00
Script:
properties:
name:
type: string
format: string
example: "random_fact"
description:
type: string
example: "Returns a random fact about a topic. Provide an argument of either 'cat', 'norris', or 'buzzword'"
Adding an API Endpoint that will return a list of LookupValues that match a given query - can be used to populate an auto-complete table.
2020-04-22 23:40:40 +00:00
LookupItem:
properties:
value:
type: string
format: string
example: "1000"
label:
type: string
example: "Chuck Norris"
data:
Refactor the stats models, and assure they are very correct across all tests with the workflow api. I noticed we were saving the workflow every time we loaded it up, rather than only when we were making changes to it. Refactored this to be a little more careful. Centralized the saving of the workflow into one location in the processor, so we can make sure we update all the details about that workflow every time we save. The workflow service has a method that will log any task action taken in a consistent way. The stats models were removed from the API completely. Will wait for a use case for dealing with this later.
2020-05-04 14:57:09 +00:00
type: any
adding a navigation component to the Workflow Model. running all extension/properties through the Jinja template processor so you can have custom display names using data, very helpful for building multi-instance displays. Properties was returned as an array of key/value pairs, which is just mean. Switched this to a dictionary.
2020-05-14 17:43:23 +00:00
NavigationItem:
properties:
id:
type: number
format: integer
example: 5
massive overhaul of the Workflow API endpoint. No Previous Task, No Last Task, No Task List. Just the current task, and the Navigation. Use the token endpoint to set the current task, even if it is a "READY" task in the api. Previous Task can be set by identifying the prior task in the Navigation (I'm hoping) Prefering camel case to snake case on all new apis. Maybe clean the rest up later.
2020-05-15 19:54:53 +00:00
task_id:
type: string
format: uuid
example: "1234123uuid1234"
adding a navigation component to the Workflow Model. running all extension/properties through the Jinja template processor so you can have custom display names using data, very helpful for building multi-instance displays. Properties was returned as an array of key/value pairs, which is just mean. Switched this to a dictionary.
2020-05-14 17:43:23 +00:00
name:
type: string
example: "Task_Has_bananas"
description:
type: string
example: "Has Bananas?"
backtracks:
massive overhaul of the Workflow API endpoint. No Previous Task, No Last Task, No Task List. Just the current task, and the Navigation. Use the token endpoint to set the current task, even if it is a "READY" task in the api. Previous Task can be set by identifying the prior task in the Navigation (I'm hoping) Prefering camel case to snake case on all new apis. Maybe clean the rest up later.
2020-05-15 19:54:53 +00:00
type: boolean
adding a navigation component to the Workflow Model. running all extension/properties through the Jinja template processor so you can have custom display names using data, very helpful for building multi-instance displays. Properties was returned as an array of key/value pairs, which is just mean. Switched this to a dictionary.
2020-05-14 17:43:23 +00:00
example: false
level:
type: integer
example: 1
indent:
type: integer
example: 2
the heck with camel case, what the heck TypeScript? Get a grip. This is a python API.
2020-05-15 20:38:37 +00:00
child_count:
adding a navigation component to the Workflow Model. running all extension/properties through the Jinja template processor so you can have custom display names using data, very helpful for building multi-instance displays. Properties was returned as an array of key/value pairs, which is just mean. Switched this to a dictionary.
2020-05-14 17:43:23 +00:00
type: integer
example: 4
state:
type: enum
enum: ['FUTURE', 'WAITING', 'READY', 'CANCELLED', 'COMPLETED','LIKELY','MAYBE']
readOnly: true
the heck with camel case, what the heck TypeScript? Get a grip. This is a python API.
2020-05-15 20:38:37 +00:00
is_decision:
massive overhaul of the Workflow API endpoint. No Previous Task, No Last Task, No Task List. Just the current task, and the Navigation. Use the token endpoint to set the current task, even if it is a "READY" task in the api. Previous Task can be set by identifying the prior task in the Navigation (I'm hoping) Prefering camel case to snake case on all new apis. Maybe clean the rest up later.
2020-05-15 19:54:53 +00:00
type: boolean
example: False
readOnly: true
task:
$ref: "#/components/schemas/Task"
Building out the boilerplate code to make pushing forward on this a little friendlier. There is an approval api file, and approval model file and an approval test file.
2020-05-22 22:25:00 +00:00
Approval:
properties:
id:
type: number
format: integer
example: 5
Refactor the stats models, and assure they are very correct across all tests with the workflow api. I noticed we were saving the workflow every time we loaded it up, rather than only when we were making changes to it. Refactored this to be a little more careful. Centralized the saving of the workflow into one location in the processor, so we can make sure we update all the details about that workflow every time we save. The workflow service has a method that will log any task action taken in a consistent way. The stats models were removed from the API completely. Will wait for a use case for dealing with this later.
2020-05-04 14:57:09 +00:00