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

2101 lines
59 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:
Refactors user authentication endpoints so we can use the Swagger UI in production mode
2020-05-31 20:49:39 +00:00
/login:
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:
Refactors user authentication endpoints so we can use the Swagger UI in production mode
2020-05-31 20:49:39 +00:00
operationId: crc.api.user.login
summary: In production, logs the user in via SSO. If not in production, logs in as a specific user for testing.
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: false
schema:
type: string
Refactors user authentication endpoints so we can use the Swagger UI in production mode
2020-05-31 20:49:39 +00:00
- name: redirect_url
Adds redirect URL to login handler
2020-02-24 21:59:16 +00:00
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:
Adds list_users endpoint. Adds admin impersonate uid parameter to user endpoint. Adds some utility methods to user service. Refactors authentication tests.
2020-07-30 02:47:47 +00:00
parameters:
- name: admin_impersonate_uid
in: query
required: false
description: For admins, the unique uid of an existing user to impersonate.
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
get:
operationId: crc.api.user.get_current_user
summary: Returns the current user.
tags:
- Users
responses:
'200':
Adds list_users endpoint. Adds admin impersonate uid parameter to user endpoint. Adds some utility methods to user service. Refactors authentication tests.
2020-07-30 02:47:47 +00:00
description: The currently-authenticated user, or, if the current user is an admin and admin_impersonate_uid is provided, this will be the user with the given uid.
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
content:
application/json:
schema:
$ref: "#/components/schemas/User"
Adds list_users endpoint. Adds admin impersonate uid parameter to user endpoint. Adds some utility methods to user service. Refactors authentication tests.
2020-07-30 02:47:47 +00:00
/list_users:
get:
operationId: crc.api.user.get_all_users
security:
- auth_admin: ['secret']
summary: Returns a list of all users in the database.
tags:
- Users
responses:
'200':
description: All users in the database.
content:
application/json:
schema:
type: array
fixing the api.yml file which was starting to throw errors when updating the libraries. Seems that sqlalchemy now has a hard time incrementing sequences, so putting in a fix for this. Upgrading many of our libraries, to avoid any disconnects as we try to handle security patches from these automated bumps.
2021-04-02 21:10:05 +00:00
items:
$ref: "#/components/schemas/User"
Changes to support the frontend data pane fixes #277 and requires frontend branch 277-document-pane
2021-04-20 12:12:27 +00:00
# /v1.0/document_directory/{study_id}
/document_directory/{study_id}:
parameters :
- name : study_id
required : true
in : path
description : The unique id of a study.
schema :
type : integer
- name : workflow_id
in : query
required : false
schema :
type : integer
get:
Refactoring Reference files to use the lookup table, rather than parsing the results directly out of the spreadsheet, or attempting to cache them. Adding a DocumentService to clean up the FileService, and get Documents well seperated, as it seems likely be pulled out or seperated in the future, there is now a Documents api file as well, for the same reason. Some other minor changes are just fixing white space to assure our code is linting correctly. I removed _create_study_workflow_approvals from the base test, as we don't use approvals like this anymore.
2021-07-06 17:10:20 +00:00
operationId: crc.api.document.get_document_directory
Changes to support the frontend data pane fixes #277 and requires frontend branch 277-document-pane
2021-04-20 12:12:27 +00:00
summary: Returns a directory of all files for study in a nested structure
tags:
- Document Categories
responses:
'200':
description: All IRB Categories defined in the file document.
content:
application/json:
schema:
Adding a test for the new endpoint and cleaning up the API documenation
2021-04-21 18:00:19 +00:00
type: array
items:
$ref: "#/components/schemas/DocumentDirectory"
Changes to support the frontend data pane fixes #277 and requires frontend branch 277-document-pane
2021-04-20 12:12:27 +00:00
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:
A major refactor of how we search and store files, as there was a lot of confusing bits in here. From an API point of view you can do the following (and only the following) /files?workflow_spec_id=x * You can find all files associated with a workflow_spec_id, and add a file with a workflow_spec_id /files?workflow_id=x * You can find all files associated with a workflow_id, and add a file that is directly associated with the workflow /files?workflow_id=x&form_field_key=y * You can find all files associated with a form element on a running workflow, and add a new file. Note: you can add multiple files to the same form_field_key, IF they have different file names. If the same name, the original file is archived, and the new file takes its place. The study endpoints always return a list of the file metadata associated with the study. Removed /studies-files, but there is an endpoint called /studies/all - that returns all the studies in the system, and does include their files. On a deeper level: The File model no longer contains: - study_id, - task_id, - form_field_key Instead, if the file is associated with workflow - then that is the one way it is connected to the study, and we use this relationship to find files for a study. A file is never associated with a task_id, as these change when the workflow is reloaded. The form_field_key must match the irb_doc_code, so when requesting files for a form field, we just look up the irb_doc_code.
2020-05-28 12:27:26 +00:00
operationId: crc.api.study.user_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:
Adds list_users endpoint. Adds admin impersonate uid parameter to user endpoint. Adds some utility methods to user service. Refactors authentication tests.
2020-07-30 02:47:47 +00:00
type: array
fixing the api.yml file which was starting to throw errors when updating the libraries. Seems that sqlalchemy now has a hard time incrementing sequences, so putting in a fix for this. Upgrading many of our libraries, to avoid any disconnects as we try to handle security patches from these automated bumps.
2021-04-02 21:10:05 +00:00
items:
$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:
A major refactor of how we search and store files, as there was a lot of confusing bits in here. From an API point of view you can do the following (and only the following) /files?workflow_spec_id=x * You can find all files associated with a workflow_spec_id, and add a file with a workflow_spec_id /files?workflow_id=x * You can find all files associated with a workflow_id, and add a file that is directly associated with the workflow /files?workflow_id=x&form_field_key=y * You can find all files associated with a form element on a running workflow, and add a new file. Note: you can add multiple files to the same form_field_key, IF they have different file names. If the same name, the original file is archived, and the new file takes its place. The study endpoints always return a list of the file metadata associated with the study. Removed /studies-files, but there is an endpoint called /studies/all - that returns all the studies in the system, and does include their files. On a deeper level: The File model no longer contains: - study_id, - task_id, - form_field_key Instead, if the file is associated with workflow - then that is the one way it is connected to the study, and we use this relationship to find files for a study. A file is never associated with a task_id, as these change when the workflow is reloaded. The form_field_key must match the irb_doc_code, so when requesting files for a form field, we just look up the irb_doc_code.
2020-05-28 12:27:26 +00:00
type: array
items:
$ref: "#/components/schemas/Study"
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
/workflow_sync/pullall:
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
get:
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
operationId: crc.api.workflow_sync.sync_all_changed_workflows
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
summary: Sync all workflows that have changed on the remote side and provide a list of the results
security:
- ApiKeyAuth : []
# in the endpoint
parameters:
- name: remote
in: query
required: true
description: The remote endpoint
schema:
type: string
tags:
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
- Workflow Sync API
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
responses:
'200':
description: An array of workflow specs that were synced from remote.
content:
application/json:
schema:
type: array
items:
type: string
example : ['top_level_workflow','3b495037-f7d4-4509-bf58-cee41c0c6b0e']
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
/workflow_sync/diff:
add endpoint that gets a record for all changed /new workflow_specs at a remote endpoint
2020-12-03 19:45:57 +00:00
get:
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
operationId: crc.api.workflow_sync.get_changed_workflows
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
summary: Provides a list of workflow that differ from remote and if it is new or not
security :
- ApiKeyAuth : []
add endpoint that gets a record for all changed /new workflow_specs at a remote endpoint
2020-12-03 19:45:57 +00:00
# in the endpoint
parameters:
- name: remote
in: query
required: true
description: The remote endpoint
schema:
type: string
tags:
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
- Workflow Sync API
add endpoint that gets a record for all changed /new workflow_specs at a remote endpoint
2020-12-03 19:45:57 +00:00
responses:
'200':
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
description: An array of workflow specs, with last touched date and which one is most recent.
add endpoint that gets a record for all changed /new workflow_specs at a remote endpoint
2020-12-03 19:45:57 +00:00
content:
application/json:
schema:
type: array
items:
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
$ref: "#/components/schemas/WorkflowSpecDiffList"
add endpoint that gets a record for all changed /new workflow_specs at a remote endpoint
2020-12-03 19:45:57 +00:00
redid the api a bit so that nothing was using open security - added a new endpoint for getting a workflow spec that uses the alternate API_TOKEN security and leave the original endpoint as it was.
2020-12-11 17:03:41 +00:00
/workflow_sync/{workflow_spec_id}/spec:
parameters:
- name: workflow_spec_id
in: path
Merge branch 'dev' into bug/missing_pi_name_246 # Conflicts: # crc/api.yml # crc/services/study_service.py
2021-07-20 15:44:11 +00:00
required: true
redid the api a bit so that nothing was using open security - added a new endpoint for getting a workflow spec that uses the alternate API_TOKEN security and leave the original endpoint as it was.
2020-12-11 17:03:41 +00:00
description: The unique id of an existing workflow specification to modify.
schema:
type: string
get:
operationId: crc.api.workflow_sync.get_sync_workflow_specification
summary: Returns a single workflow specification
security:
- ApiKeyAuth: []
tags:
- Workflow Sync API
responses:
'200':
description: Workflow specification.
content:
application/json:
schema:
$ref: "#/components/schemas/WorkflowSpec"
add endpoint that gets a record for all changed /new workflow_specs at a remote endpoint
2020-12-03 19:45:57 +00:00
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
/workflow_sync/{workflow_spec_id}/files:
For a given workflow - find the files that are different from a remote endpoint for the same workflow
2020-12-04 16:49:07 +00:00
get:
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
operationId: crc.api.workflow_sync.get_workflow_spec_files
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
summary: Provides a list of files for a workflow spec on this machine.
security :
- ApiKeyAuth : []
For a given workflow - find the files that are different from a remote endpoint for the same workflow
2020-12-04 16:49:07 +00:00
parameters:
- name: workflow_spec_id
in: path
required: true
description: The workflow_spec id
schema:
type: string
tags:
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
- Workflow Sync API
For a given workflow - find the files that are different from a remote endpoint for the same workflow
2020-12-04 16:49:07 +00:00
responses:
'200':
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
description: An array of files for a workflow spec on the local system, with details.
For a given workflow - find the files that are different from a remote endpoint for the same workflow
2020-12-04 16:49:07 +00:00
content:
application/json:
schema:
type: array
items:
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
$ref: "#/components/schemas/WorkflowSpecFilesList"
For a given workflow - find the files that are different from a remote endpoint for the same workflow
2020-12-04 16:49:07 +00:00
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
/workflow_sync/{workflow_spec_id}/files/sync:
Make a change to make sure that if there is a new file locally that is not present remotely when we pull from the remote, the new local file gets deleted. Also: add several things to the requirements.txt that should have been there in the first place.
2020-12-08 18:42:01 +00:00
get:
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
operationId: crc.api.workflow_sync.sync_changed_files
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
summary: Syncs files from a workflow on a remote system and provides a list of files that were updated
security :
- ApiKeyAuth : []
Make a change to make sure that if there is a new file locally that is not present remotely when we pull from the remote, the new local file gets deleted. Also: add several things to the requirements.txt that should have been there in the first place.
2020-12-08 18:42:01 +00:00
parameters:
- name: workflow_spec_id
in: path
required: true
description: The workflow_spec id
schema:
type: string
- name: remote
in: query
required: true
description: The remote endpoint
schema:
type: string
tags:
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
- Workflow Sync API
Make a change to make sure that if there is a new file locally that is not present remotely when we pull from the remote, the new local file gets deleted. Also: add several things to the requirements.txt that should have been there in the first place.
2020-12-08 18:42:01 +00:00
responses:
'200':
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
description: A list of files that were synced for the workflow.
Make a change to make sure that if there is a new file locally that is not present remotely when we pull from the remote, the new local file gets deleted. Also: add several things to the requirements.txt that should have been there in the first place.
2020-12-08 18:42:01 +00:00
content:
application/json:
schema:
type: array
items:
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
type : string
example : ["data_security_plan.dmn",'some_other_file.xml']
Make a change to make sure that if there is a new file locally that is not present remotely when we pull from the remote, the new local file gets deleted. Also: add several things to the requirements.txt that should have been there in the first place.
2020-12-08 18:42:01 +00:00
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
/workflow_sync/{workflow_spec_id}/files/diff:
For a given workflow - find the files that are different from a remote endpoint for the same workflow
2020-12-04 16:49:07 +00:00
get:
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
operationId: crc.api.workflow_sync.get_changed_files
Add some punctuation
2020-12-09 18:50:52 +00:00
summary: Provides a list of files for a workflow specs that differ from remote and their signature.
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
security :
- ApiKeyAuth : []
For a given workflow - find the files that are different from a remote endpoint for the same workflow
2020-12-04 16:49:07 +00:00
parameters:
- name: workflow_spec_id
in: path
required: true
description: The workflow_spec id
schema:
type: string
- name: remote
in: query
required: true
description: The remote endpoint
schema:
type: string
tags:
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
- Workflow Sync API
For a given workflow - find the files that are different from a remote endpoint for the same workflow
2020-12-04 16:49:07 +00:00
responses:
'200':
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
description: An array of files that are different from remote, with last touched date and file signature.
For a given workflow - find the files that are different from a remote endpoint for the same workflow
2020-12-04 16:49:07 +00:00
content:
application/json:
schema:
type: array
items:
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
$ref: "#/components/schemas/WorkflowSpecFilesDiff"
For a given workflow - find the files that are different from a remote endpoint for the same workflow
2020-12-04 16:49:07 +00:00
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
/workflow_sync/all:
commit before removing big long SQL
2020-12-02 21:04:00 +00:00
get:
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
operationId: crc.api.workflow_sync.get_all_spec_state
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
summary: Provides a list of workflow specs, last update date and thumbprint
security:
- ApiKeyAuth : []
commit before removing big long SQL
2020-12-02 21:04:00 +00:00
tags:
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
- Workflow Sync API
commit before removing big long SQL
2020-12-02 21:04:00 +00:00
responses:
'200':
description: An array of workflow specs, with last touched date and file signature.
content:
application/json:
schema:
type: array
items:
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
$ref: "#/components/schemas/WorkflowSpecAll"
commit before removing big long SQL
2020-12-02 21:04:00 +00:00
A major refactor of how we search and store files, as there was a lot of confusing bits in here. From an API point of view you can do the following (and only the following) /files?workflow_spec_id=x * You can find all files associated with a workflow_spec_id, and add a file with a workflow_spec_id /files?workflow_id=x * You can find all files associated with a workflow_id, and add a file that is directly associated with the workflow /files?workflow_id=x&form_field_key=y * You can find all files associated with a form element on a running workflow, and add a new file. Note: you can add multiple files to the same form_field_key, IF they have different file names. If the same name, the original file is archived, and the new file takes its place. The study endpoints always return a list of the file metadata associated with the study. Removed /studies-files, but there is an endpoint called /studies/all - that returns all the studies in the system, and does include their files. On a deeper level: The File model no longer contains: - study_id, - task_id, - form_field_key Instead, if the file is associated with workflow - then that is the one way it is connected to the study, and we use this relationship to find files for a study. A file is never associated with a task_id, as these change when the workflow is reloaded. The form_field_key must match the irb_doc_code, so when requesting files for a form field, we just look up the irb_doc_code.
2020-05-28 12:27:26 +00:00
/study/all:
Endpoint for studies with files
2020-05-22 15:46:03 +00:00
get:
A major refactor of how we search and store files, as there was a lot of confusing bits in here. From an API point of view you can do the following (and only the following) /files?workflow_spec_id=x * You can find all files associated with a workflow_spec_id, and add a file with a workflow_spec_id /files?workflow_id=x * You can find all files associated with a workflow_id, and add a file that is directly associated with the workflow /files?workflow_id=x&form_field_key=y * You can find all files associated with a form element on a running workflow, and add a new file. Note: you can add multiple files to the same form_field_key, IF they have different file names. If the same name, the original file is archived, and the new file takes its place. The study endpoints always return a list of the file metadata associated with the study. Removed /studies-files, but there is an endpoint called /studies/all - that returns all the studies in the system, and does include their files. On a deeper level: The File model no longer contains: - study_id, - task_id, - form_field_key Instead, if the file is associated with workflow - then that is the one way it is connected to the study, and we use this relationship to find files for a study. A file is never associated with a task_id, as these change when the workflow is reloaded. The form_field_key must match the irb_doc_code, so when requesting files for a form field, we just look up the irb_doc_code.
2020-05-28 12:27:26 +00:00
operationId: crc.api.study.all_studies
summary: Provides a list of studies
Endpoint for studies with files
2020-05-22 15:46:03 +00:00
tags:
- Studies
responses:
'200':
description: An array of studies, with submitted files, ordered by the last modified date.
content:
application/json:
schema:
A major refactor of how we search and store files, as there was a lot of confusing bits in here. From an API point of view you can do the following (and only the following) /files?workflow_spec_id=x * You can find all files associated with a workflow_spec_id, and add a file with a workflow_spec_id /files?workflow_id=x * You can find all files associated with a workflow_id, and add a file that is directly associated with the workflow /files?workflow_id=x&form_field_key=y * You can find all files associated with a form element on a running workflow, and add a new file. Note: you can add multiple files to the same form_field_key, IF they have different file names. If the same name, the original file is archived, and the new file takes its place. The study endpoints always return a list of the file metadata associated with the study. Removed /studies-files, but there is an endpoint called /studies/all - that returns all the studies in the system, and does include their files. On a deeper level: The File model no longer contains: - study_id, - task_id, - form_field_key Instead, if the file is associated with workflow - then that is the one way it is connected to the study, and we use this relationship to find files for a study. A file is never associated with a task_id, as these change when the workflow is reloaded. The form_field_key must match the irb_doc_code, so when requesting files for a form field, we just look up the irb_doc_code.
2020-05-28 12:27:26 +00:00
type: array
items:
$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
When retrieving the study, only update the status of underlying workflows if specifically requested. Record the size of a file in the database for quick access (this helps with a frontend refactor, so it isn't downloading the file just to see it's size) Cleaning up the timing/performance metric reporting to make it easier to read. Fixing a bug that prevented non-admins for getting the document-directory
2021-04-30 15:55:12 +00:00
- name: update_status
in: query
required: false
description: If set to true, will synch the study with protocol builder and assure the status of all workflows is up to date (expensive).
schema:
type: boolean
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
Refactors user authentication endpoints so we can use the Swagger UI in production mode
2020-05-31 20:49:39 +00:00
security:
Fixes broken unit tests. But still broken.
2020-06-11 15:29:58 +00:00
- auth_admin: ['secret']
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
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"
Fixed email_cc test
2021-07-22 19:08:28 +00:00
/study/{study_id}/associates:
Updated Study Associate Endpoints
2021-03-22 21:30:49 +00:00
parameters:
- name: study_id
in: path
required: true
Fixed Associate API Endpoint description
2021-07-22 18:36:00 +00:00
description: The id of the study for which associates should be returned.
Updated Study Associate Endpoints
2021-03-22 21:30:49 +00:00
schema:
type: integer
format: int32
get:
operationId: crc.api.study.get_study_associates
Fixed Associate API Endpoint description
2021-07-22 18:36:00 +00:00
summary: Provides a list of associates for a particular study
Updated Study Associate Endpoints
2021-03-22 21:30:49 +00:00
tags:
- Studies
responses:
'200':
Fixed Associate API Endpoint description
2021-07-22 18:36:00 +00:00
description: list of Study Associate Objects
Updated Study Associate Endpoints
2021-03-22 21:30:49 +00:00
content:
application/json:
schema:
Fixed Associate API Endpoint description
2021-07-22 18:36:00 +00:00
type: array
items:
$ref: "#/components/schemas/StudyAssociate"
Updated Study Associate Endpoints
2021-03-22 21:30:49 +00:00
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
commit in intermediate changes to work on a bug
2021-07-26 17:00:11 +00:00
parameters :
- name : libraries
in : query
required : false
description : True if we should return just library schemas
schema :
type : boolean
- name : standalone
in : query
required : false
description : True if we should return just standalone schemas
schema :
type : boolean
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"
got library side working - still need to have parent working
2021-07-22 14:20:34 +00:00
/workflow-specification/{spec_id}/library/{library_id}:
parameters:
- name: spec_id
in: path
required: true
description: The unique id of an existing workflow specification.
schema:
type: string
- name: library_id
in: path
required: true
description: The unique id of an existing library specification.
schema:
type: string
post:
operationId: crc.api.workflow.add_workflow_spec_library
summary: Adds a library to a workflow spec
tags:
- Workflow Specifications
responses:
'200':
description: Workflow specification.
content:
application/json:
schema:
$ref: "#/components/schemas/WorkflowSpec"
delete:
operationId: crc.api.workflow.drop_workflow_spec_library
summary: Delete a library from a workflow
tags:
- Workflow Specifications
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
/workflow-specification/{spec_id}:
Adds endpoint to delete workflow spec
2020-01-23 21:05:09 +00:00
parameters:
- name: spec_id
in: path
fixing the api.yml file which was starting to throw errors when updating the libraries. Seems that sqlalchemy now has a hard time incrementing sequences, so putting in a fix for this. Upgrading many of our libraries, to avoid any disconnects as we try to handle security patches from these automated bumps.
2021-04-02 21:10:05 +00:00
required: true
Added study_id to workflow_api
2021-04-29 18:29:21 +00:00
description: The unique id of an existing workflow specification.
Adds endpoint to delete workflow spec
2020-01-23 21:05:09 +00:00
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"
Created 2 api endpoints; one to get a workflow from a workflow spec, and one to list all standalone workflow specs. Also added `standalone` argument to workflow_spec schema properties
2021-04-26 12:27:24 +00:00
post:
operationId: crc.api.workflow.get_workflow_from_spec
summary: Creates a workflow from a workflow spec and returns the workflow
tags:
- Workflow Specifications
responses:
'200':
description: Workflow generated successfully
content:
application/json:
schema:
$ref: "#/components/schemas/Workflow"
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
Refactors user authentication endpoints so we can use the Swagger UI in production mode
2020-05-31 20:49:39 +00:00
security:
Fixes broken unit tests. But still broken.
2020-06-11 15:29:58 +00:00
- auth_admin: ['secret']
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
Refactors user authentication endpoints so we can use the Swagger UI in production mode
2020-05-31 20:49:39 +00:00
security:
Fixes broken unit tests. But still broken.
2020-06-11 15:29:58 +00:00
- auth_admin: ['secret']
Adds endpoint to delete workflow spec
2020-01-23 21:05:09 +00:00
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
fixing the api.yml file which was starting to throw errors when updating the libraries. Seems that sqlalchemy now has a hard time incrementing sequences, so putting in a fix for this. Upgrading many of our libraries, to avoid any disconnects as we try to handle security patches from these automated bumps.
2021-04-02 21:10:05 +00:00
required: true
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
description: The unique id of an existing workflow specification to validate.
schema:
type: string
Adding additional details to error messages, and cleaning up the cruft around these messages to keep them clear and succinct. Most noteable is the addition of the line on which the error occurs for script tasks. It will report the line number and pass back the content of the line that failed. The validator only returns the first error it encounters, as it's clear that all we ever get right now is two of the same error. Did a lot of work between this and spiffworkflow to remove all the places where we obfuscate or drop details as we converted between workflowExceptions and APIExceptions. Dropped the python levenshtein dependency, in favor of just rolling a simple one ourselves in Spiffworkflow.
2021-07-07 04:53:30 +00:00
- name: study_id
Added optional `validate_study_id` parameter to the validation api endpoint.
2021-06-03 18:17:12 +00:00
in: query
required: false
description: Optional id of study to test under different scenarios
schema:
type: string
Merge branch 'dev' of https://github.com/sartography/cr-connect-workflow into partial_testing
2021-06-09 18:32:01 +00:00
- name: test_until
in: query
required: false
Merge branch 'dev' into bug/missing_pi_name_246 # Conflicts: # crc/api.yml # crc/services/study_service.py
2021-07-20 15:44:11 +00:00
description: Optional name of task to stop validating at
Merge branch 'dev' of https://github.com/sartography/cr-connect-workflow into partial_testing
2021-06-09 18:32:01 +00:00
schema:
type: string
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
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
Refactors user authentication endpoints so we can use the Swagger UI in production mode
2020-05-31 20:49:39 +00:00
security:
Fixes broken unit tests. But still broken.
2020-06-11 15:29:58 +00:00
- auth_admin: ['secret']
Adds CRUD endpoints for workflow spec categories
2020-03-16 20:30:56 +00:00
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
fixing the api.yml file which was starting to throw errors when updating the libraries. Seems that sqlalchemy now has a hard time incrementing sequences, so putting in a fix for this. Upgrading many of our libraries, to avoid any disconnects as we try to handle security patches from these automated bumps.
2021-04-02 21:10:05 +00:00
required: true
Adds CRUD endpoints for workflow spec categories
2020-03-16 20:30:56 +00:00
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
Refactors user authentication endpoints so we can use the Swagger UI in production mode
2020-05-31 20:49:39 +00:00
security:
Fixes broken unit tests. But still broken.
2020-06-11 15:29:58 +00:00
- auth_admin: ['secret']
Adds CRUD endpoints for workflow spec categories
2020-03-16 20:30:56 +00:00
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
Refactors user authentication endpoints so we can use the Swagger UI in production mode
2020-05-31 20:49:39 +00:00
security:
Fixes broken unit tests. But still broken.
2020-06-11 15:29:58 +00:00
- auth_admin: ['secret']
Adds CRUD endpoints for workflow spec categories
2020-03-16 20:30:56 +00:00
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:
fixed error on api.yml from search / replace
2020-12-11 13:29:37 +00:00
- name: workflow_spec_id
Adds ability to get FileModel records by study and task
2020-02-04 02:56:18 +00:00
in: query
required: false
description: The unique id of a workflow specification
schema:
type: string
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 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
give an endpoint to return all files associated with a study
2021-04-12 16:23:33 +00:00
- name: study_id
in: query
required: false
description: The study that the files are related to
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:
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
Some additional cleanup - when a file is "archived" it is no longer returned for any endpoints about files, but it is directly accessible via id, in the event some request is made for it at a later date.
2020-06-04 13:49:42 +00:00
summary: Removes an existing file. In the event the file can not be deleted, it is marked as "archived" in the database and is no longer returned unless specifically requested by id.
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
tags:
- Files
responses:
'204':
description: The file has been removed.
Make a change to make sure that if there is a new file locally that is not present remotely when we pull from the remote, the new local file gets deleted. Also: add several things to the requirements.txt that should have been there in the first place.
2020-12-08 18:42:01 +00:00
/file/{md5_hash}/hash_data:
Get more file details so we can fill out everything locally and also add a method to download the file by md5_hash
2020-12-07 13:49:38 +00:00
parameters:
- name: md5_hash
in: path
required: true
description: The md5 hash of the file requested
schema:
type: string
get:
operationId: crc.api.file.get_file_data_by_hash
summary: Returns only the file contents
refactored calls into a service
2020-12-11 16:41:32 +00:00
security:
- ApiKeyAuth: []
Get more file details so we can fill out everything locally and also add a method to download the file by md5_hash
2020-12-07 13:49:38 +00:00
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>'
Add URL to the study_info('documents') script fixes #321 - I merged in branches that fix #320 and #297 320-add-default-for-file-data-get 297-filename-in-documents
2021-05-05 15:30:08 +00:00
/file/{file_id}/download :
parameters :
- name : file_id
in : path
required : true
description : The id of the File requested
schema :
type : integer
- name : auth_token
in : query
required : true
description : User Auth Toeken
schema :
type : string
- name : version
in : query
required : false
description : The version of the file, or none for latest version
schema :
type : integer
get :
operationId : crc.api.file.get_file_data_link
summary : Returns only the file contents
security: []
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>'
Fixing broken tests by making version parameter optional in get file data endpoint
2020-05-23 21:37:03 +00:00
/file/{file_id}/data:
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
Fixing broken tests by making version parameter optional in get file data endpoint
2020-05-23 21:37:03 +00:00
in: query
stuff that might be broken.
2020-05-23 19:21:30 +00:00
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"
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
Refactors user authentication endpoints so we can use the Swagger UI in production mode
2020-05-31 20:49:39 +00:00
security:
Fixes broken unit tests. But still broken.
2020-06-11 15:29:58 +00:00
- auth_admin: ['secret']
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
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>'
Whenever a workflow is loaded or updated, add events to the TaskEvent table with assignments for the next set of ready tasks, along with who should complete those tasks. Add the lane information to the Task model. Drop the foreign key constraint on the user_uid in the task log, as we might create tasks for users before they ever log into the system. Add a new endpoint to the API called task events. It should be possible to query this and get a list of all tasks that need a users attention. The task events returned include detailed information about the workflow and study as sub-models Rename all the actions in event log to things that are easier to pass over the api as arguments, make this backwards compatible, updating existing names in the database via the migration. Throughly test the navigation and task details as control of the workflow is passed between two lanes.
2020-07-15 02:16:44 +00:00
/task_events:
parameters:
- name: action
in: query
required: false
description: The type of action the event documents, options include "ASSIGNMENT" for tasks that are waiting on you, "COMPLETE" for things have completed.
schema:
type: string
Expanding the task events endpoint to accept workflow and study ids as additional filters. Removing events from the study endpoint, too noisy.
2020-07-28 14:16:48 +00:00
- name: workflow
in: query
required: false
description: Restrict results to the given workflow.
schema:
type: number
- name: study
in: query
required: false
description: Restrict results to the given study.
schema:
type: number
Whenever a workflow is loaded or updated, add events to the TaskEvent table with assignments for the next set of ready tasks, along with who should complete those tasks. Add the lane information to the Task model. Drop the foreign key constraint on the user_uid in the task log, as we might create tasks for users before they ever log into the system. Add a new endpoint to the API called task events. It should be possible to query this and get a list of all tasks that need a users attention. The task events returned include detailed information about the workflow and study as sub-models Rename all the actions in event log to things that are easier to pass over the api as arguments, make this backwards compatible, updating existing names in the database via the migration. Throughly test the navigation and task details as control of the workflow is passed between two lanes.
2020-07-15 02:16:44 +00:00
get:
operationId: crc.api.workflow.get_task_events
summary: Returns a list of task events related to the current user. Can be filtered by type.
tags:
- Workflows and Tasks
responses:
'200':
description: Returns details about tasks that are waiting on the current user.
content:
application/json:
schema:
$ref: "#/components/schemas/TaskEvent"
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
# /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
New api endpoint for restarting a workflow. Unsure if I needed the responses section. **Dan, can you check this?** Also, removed clear_data and reload_spec as parameters for standard get workflow endpoint.
2021-01-19 20:00:39 +00:00
summary: Returns a 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:
dropping the "read_only" flag in favor of a "do_engine_steps" flag, which more clearly defines what is happening.
2020-07-28 17:51:29 +00:00
- name: do_engine_steps
Allow the workflow to be requested without making changes to the workflow - requires that you specify a read_only flag of true, otherwise it assumes that you want a fully prepared workflow with the next ready task set to run.
2020-07-28 17:33:38 +00:00
in: query
required: false
dropping the "read_only" flag in favor of a "do_engine_steps" flag, which more clearly defines what is happening.
2020-07-28 17:51:29 +00:00
description: Defaults to true, can be set to false if you are just looking at the workflow not completeing it.
Allow the workflow to be requested without making changes to the workflow - requires that you specify a read_only flag of true, otherwise it assumes that you want a fully prepared workflow with the next ready task set to run.
2020-07-28 17:33:38 +00:00
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
Refactors user authentication endpoints so we can use the Swagger UI in production mode
2020-05-31 20:49:39 +00:00
security:
Fixes broken unit tests. But still broken.
2020-06-11 15:29:58 +00:00
- auth_admin: ['secret']
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
New api endpoint for restarting a workflow. Unsure if I needed the responses section. **Dan, can you check this?** Also, removed clear_data and reload_spec as parameters for standard get workflow endpoint.
2021-01-19 20:00:39 +00:00
/workflow/{workflow_id}/restart:
parameters:
- name: workflow_id
in: path
required: true
description: The id of the workflow
schema:
type: integer
format: int32
get:
operationId: crc.api.workflow.restart_workflow
summary: Restarts a workflow with the latest spec. Can also clear data.
parameters:
- name: clear_data
in: query
required: false
description: Set this to true to clear data when starting workflow.
schema:
type: boolean
Added delete_files argument to the workflow restart api endpoint
2021-04-15 15:21:51 +00:00
- name: delete_files
in: query
required: false
description: Set this to true to delete associated files when starting workflow.
schema:
New api endpoint for restarting a workflow. Unsure if I needed the responses section. **Dan, can you check this?** Also, removed clear_data and reload_spec as parameters for standard get workflow endpoint.
2021-01-19 20:00:39 +00:00
type: boolean
tags:
- Workflows and Tasks
responses:
'200':
description: Returns updated workflow, possibly without data.
content:
application/json:
schema:
$ref: "#/components/schemas/Workflow"
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
STG-26 - basic test case for a looping task Criteria : task.multi_instance_type == 'looping' to terminate, use the standard endpoint for submitting form data with a query variable of terminate_loop=true Will likely need two buttons: "Submit and quit" "Submit and add another" or something similar
2020-06-17 15:35:06 +00:00
- name: terminate_loop
in: query
required: false
description: Terminate the loop on a looping task
schema:
type: boolean
Adding an argument to update task that will allow it to complete all remaining tasks through an "update_all" flag, this will allow us to remove some fairly complex logic from the front end that isn't behaving properly.
2021-03-13 01:41:07 +00:00
- name: update_all
in: query
required: false
description: In the case of a multi-instance user task, update all tasks with the submitted values.
schema:
type: boolean
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"
Bug #255, this requires the front end to pass in the name of the task, when doing a lookup. This will prevent a bug where we have multiple user tasks, with enum fields that set the same variable, but use different lookup tables to populate the dropbown or search feature.
2021-03-01 19:54:04 +00:00
/workflow/{workflow_id}/lookup/{task_spec_name}/{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
Bug #255, this requires the front end to pass in the name of the task, when doing a lookup. This will prevent a bug where we have multiple user tasks, with enum fields that set the same variable, but use different lookup tables to populate the dropbown or search feature.
2021-03-01 19:54:04 +00:00
- name: task_spec_name
in: path
required: true
description: The name of the current task
schema:
type: string
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
Provides some basic tools for getting additional information about a lookup field. Adds an optional 'value' parameter to the lookup endpoint so you can find a specific entry in the lookup table. Makes sure the data attribute returned on a lookup model is a dictionary, and not a string. Fixes a previous bug that would crop up if double spaces were used when performing a search.
2020-06-30 14:34:16 +00:00
- name: value
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
in: query
required: false
Provides some basic tools for getting additional information about a lookup field. Adds an optional 'value' parameter to the lookup endpoint so you can find a specific entry in the lookup table. Makes sure the data attribute returned on a lookup model is a dictionary, and not a string. Fixes a previous bug that would crop up if double spaces were used when performing a search.
2020-06-30 14:34:16 +00:00
description: An alternative to query, this accepts the specific value or id selected in a dropdown list or auto-complete, and will return the one matching record. Useful for getting additional details about an item selected in a dropdown.
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
schema:
Provides some basic tools for getting additional information about a lookup field. Adds an optional 'value' parameter to the lookup endpoint so you can find a specific entry in the lookup table. Makes sure the data attribute returned on a lookup model is a dictionary, and not a string. Fixes a previous bug that would crop up if double spaces were used when performing a search.
2020-06-30 14:34:16 +00:00
type: string
- name: limit
Provides some basic tools for getting additional information about a lookup field. Adds an optional 'id' parameter to the lookup endpoint so you can find a specific entry in the lookup table. Makes sure the data attribute returned on a lookup model is a dictionary, and not a string. Fixes a previous bug that would crop up in double spaces were used when performing a search.
2020-06-30 14:00:22 +00:00
in: query
required: false
Provides some basic tools for getting additional information about a lookup field. Adds an optional 'value' parameter to the lookup endpoint so you can find a specific entry in the lookup table. Makes sure the data attribute returned on a lookup model is a dictionary, and not a string. Fixes a previous bug that would crop up if double spaces were used when performing a search.
2020-06-30 14:34:16 +00:00
description: The total number of records to return, defaults to 10.
Provides some basic tools for getting additional information about a lookup field. Adds an optional 'id' parameter to the lookup endpoint so you can find a specific entry in the lookup table. Makes sure the data attribute returned on a lookup model is a dictionary, and not a string. Fixes a previous bug that would crop up in double spaces were used when performing a search.
2020-06-30 14:00:22 +00:00
schema:
Provides some basic tools for getting additional information about a lookup field. Adds an optional 'value' parameter to the lookup endpoint so you can find a specific entry in the lookup table. Makes sure the data attribute returned on a lookup model is a dictionary, and not a string. Fixes a previous bug that would crop up if double spaces were used when performing a search.
2020-06-30 14:34:16 +00:00
type: integer
Provides some basic tools for getting additional information about a lookup field. Adds an optional 'id' parameter to the lookup endpoint so you can find a specific entry in the lookup table. Makes sure the data attribute returned on a lookup model is a dictionary, and not a string. Fixes a previous bug that would crop up in double spaces were used when performing a search.
2020-06-30 14:00:22 +00:00
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
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
Default mail user name and password to blank.
2020-06-08 18:15:56 +00:00
/send_email:
parameters:
Modify the send_email api endpoint (in Configurator Tools section) to accept subject, message, and data. Subject, address and message are required. Data is not required. Message is in the body of the request. Subject, address, and data are in the query string.
2021-03-11 16:10:10 +00:00
- in: query
name: subject
required: true
description: The subject of the email.
schema:
type: string
- in: query
name: address
Default mail user name and password to blank.
2020-06-08 18:15:56 +00:00
required: true
description: The address to send a test email to.
schema:
type: string
Modify the send_email api endpoint (in Configurator Tools section) to accept subject, message, and data. Subject, address and message are required. Data is not required. Message is in the body of the request. Subject, address, and data are in the query string.
2021-03-11 16:10:10 +00:00
- in: query
name: data
required: false
description:
The data to use in populating the message.
schema:
type: string
example: {"id_1": "value_1", "id_2": "value_2"}
put:
Default mail user name and password to blank.
2020-06-08 18:15:56 +00:00
operationId: crc.api.tools.send_email
Modify the send_email api endpoint (in Configurator Tools section) to accept subject, message, and data. Subject, address and message are required. Data is not required. Message is in the body of the request. Subject, address, and data are in the query string.
2021-03-11 16:10:10 +00:00
summary: Sends an email so we can see what the message will look like.
Default mail user name and password to blank.
2020-06-08 18:15:56 +00:00
tags:
- Configurator Tools
Modify the send_email api endpoint (in Configurator Tools section) to accept subject, message, and data. Subject, address and message are required. Data is not required. Message is in the body of the request. Subject, address, and data are in the query string.
2021-03-11 16:10:10 +00:00
requestBody:
required: true
content:
text/plain:
schema:
type: string
Default mail user name and password to blank.
2020-06-08 18:15:56 +00:00
responses:
'201':
description: Returns any error messages that might come back from sending the email.
content:
text/plain:
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
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 the start of an endpoint that could be used by logged in / authenticated users that will evaluate basic python functions sent in via the API. The hope here is that we can process these in real time for the front end, but still do it using the same evaluation engine we use everywhere else, so the syntax for things like hide-expressions can be properly verified during workflow validation and will be assured to work during front end rendering. Removing any all javascript code in the BPMN models.
2020-07-21 17:57:33 +00:00
/eval:
Updating to lastest spiffworkflow which uses box to support dot notation. Adding a new endpoint for evaluating the results of a python expression into the tools section of the api.
2020-07-22 15:30:16 +00:00
put:
Building the start of an endpoint that could be used by logged in / authenticated users that will evaluate basic python functions sent in via the API. The hope here is that we can process these in real time for the front end, but still do it using the same evaluation engine we use everywhere else, so the syntax for things like hide-expressions can be properly verified during workflow validation and will be assured to work during front end rendering. Removing any all javascript code in the BPMN models.
2020-07-21 17:57:33 +00:00
operationId: crc.api.tools.evaluate_python_expression
summary: Execute the given python expression, with the given json data structure used as local variables, returns the result of the evaluation.
tags:
- Configurator Tools
Updating to lastest spiffworkflow which uses box to support dot notation. Adding a new endpoint for evaluating the results of a python expression into the tools section of the api.
2020-07-22 15:30:16 +00:00
requestBody:
Minor tweaks to the eval endpoint, which should take both the expression and the data as one data structure.
2020-08-20 20:13:48 +00:00
description: The expression and the json data to use as local variables when evaluating the expresson.
Updating to lastest spiffworkflow which uses box to support dot notation. Adding a new endpoint for evaluating the results of a python expression into the tools section of the api.
2020-07-22 15:30:16 +00:00
required: true
content:
application/json:
schema:
type: object
Building the start of an endpoint that could be used by logged in / authenticated users that will evaluate basic python functions sent in via the API. The hope here is that we can process these in real time for the front end, but still do it using the same evaluation engine we use everywhere else, so the syntax for things like hide-expressions can be properly verified during workflow validation and will be assured to work during front end rendering. Removing any all javascript code in the BPMN models.
2020-07-21 17:57:33 +00:00
responses:
'200':
description: Returns the result of executing the given python script.
content:
text/plain:
schema:
type: string
Add last_updated field - change the api signature to be closer to what we need going forward, but retain the old methods for testing the script get/set through the API
2020-11-13 17:03:29 +00:00
/datastore:
post:
operationId: crc.api.data_store.add_datastore
summary: Add datastore item with the given parameters.
tags:
- DataStore
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DataStore'
responses:
'200':
description: Datastore updated successfully.
content:
application/json:
schema:
$ref: "#/components/schemas/DataStore"
/datastore/{id}:
Add in api changes
2020-11-11 14:44:58 +00:00
parameters:
Add last_updated field - change the api signature to be closer to what we need going forward, but retain the old methods for testing the script get/set through the API
2020-11-13 17:03:29 +00:00
- name: id
in: path
Add in api changes
2020-11-11 14:44:58 +00:00
required: true
description: The key to lookup.
schema:
type: string
format: string
Add last_updated field - change the api signature to be closer to what we need going forward, but retain the old methods for testing the script get/set through the API
2020-11-13 17:03:29 +00:00
Add in api changes
2020-11-11 14:44:58 +00:00
get:
Add last_updated field - change the api signature to be closer to what we need going forward, but retain the old methods for testing the script get/set through the API
2020-11-13 17:03:29 +00:00
operationId: crc.api.data_store.datastore_get
summary: Get a datastore item by id
Add in api changes
2020-11-11 14:44:58 +00:00
tags:
- DataStore
responses:
'200':
description: A value from the data store, or a default if provided, or None if not found.
content:
application/json:
schema:
Add last_updated field - change the api signature to be closer to what we need going forward, but retain the old methods for testing the script get/set through the API
2020-11-13 17:03:29 +00:00
$ref: "#/components/schemas/DataStore"
put:
operationId: crc.api.data_store.update_datastore
summary: Updates an existing datastore item with the given parameters.
tags:
- DataStore
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DataStore'
responses:
'200':
description: Datastore updated successfully.
content:
application/json:
schema:
$ref: "#/components/schemas/DataStore"
save before changing how API works
2020-11-13 14:58:21 +00:00
Add last_updated field - change the api signature to be closer to what we need going forward, but retain the old methods for testing the script get/set through the API
2020-11-13 17:03:29 +00:00
delete:
operationId: crc.api.data_store.datastore_del
summary: Deletes a value from the data store by id
tags:
- DataStore
responses:
'200':
description: Deletes a value from a data store.
content:
application/json:
schema:
$ref: "#/components/schemas/DataStore"
/datastore/study/{study_id}:
save before changing how API works
2020-11-13 14:58:21 +00:00
parameters:
- name: study_id
Add last_updated field - change the api signature to be closer to what we need going forward, but retain the old methods for testing the script get/set through the API
2020-11-13 17:03:29 +00:00
in: path
save before changing how API works
2020-11-13 14:58:21 +00:00
required: true
description: The study id we are concerned with .
schema:
type: integer
format: int32
get:
operationId: crc.api.data_store.study_multi_get
Add last_updated field - change the api signature to be closer to what we need going forward, but retain the old methods for testing the script get/set through the API
2020-11-13 17:03:29 +00:00
summary: Gets all datastore items for a study_id
save before changing how API works
2020-11-13 14:58:21 +00:00
tags:
- DataStore
responses:
'200':
description: Get all values from the data store for a study_id
content:
application/json:
schema:
Add last_updated field - change the api signature to be closer to what we need going forward, but retain the old methods for testing the script get/set through the API
2020-11-13 17:03:29 +00:00
$ref: "#/components/schemas/DataStore"
/datastore/user/{user_id}:
parameters:
- name: user_id
in: path
required: true
description: The user id we are concerned with .
schema:
type: string
format: string
get:
operationId: crc.api.data_store.user_multi_get
summary: Gets all datastore items by user_id
tags:
- DataStore
responses:
'200':
description: Get all values from the data store for a user_id.
content:
application/json:
schema:
$ref: "#/components/schemas/DataStore"
New `/datastore/file/{file_id}` endpoint definition
2021-06-01 17:49:21 +00:00
/datastore/file/{file_id}:
parameters:
- name: file_id
in: path
required: true
description: The file id we are concerned with
schema:
type: string
format: string
get:
operationId: crc.api.data_store.file_multi_get
summary: Gets all datastore items by file_id
tags:
- DataStore
responses:
'200':
description: Get all values from the data store for a file_id
content:
application/json:
schema:
$ref: "#/components/schemas/DataStore"
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
Fixes broken unit tests. But still broken.
2020-06-11 15:29:58 +00:00
auth_admin:
Refactors user authentication endpoints so we can use the Swagger UI in production mode
2020-05-31 20:49:39 +00:00
type: http
scheme: bearer
bearerFormat: JWT
x-bearerInfoFunc: crc.api.user.verify_token_admin
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
ApiKeyAuth :
type : apiKey
in : header
name : X-CR-API-KEY
Move all workflow sync stuff into new file Make changes to api naming scheme add some error checking around endpoints for missing/invalid endpoints
2020-12-10 15:46:23 +00:00
x-apikeyInfoFunc: crc.api.workflow_sync.verify_token
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
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
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
WorkflowSpecDiffList:
properties:
fixed error on api.yml from search / replace
2020-12-11 13:29:37 +00:00
workflow_spec_id:
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
type: string
example : top_level_workflow
date_created :
type: string
example : 2020-12-09 16:55:12.951500+00:00
location :
type : string
example : remote
new :
type : boolean
example : false
WorkflowSpecFilesList:
properties:
file_model_id:
type : integer
example : 171
fixed error on api.yml from search / replace
2020-12-11 13:29:37 +00:00
workflow_spec_id :
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
type: string
example : top_level_workflow
filename :
type: string
example : data_security_plan.dmn
date_created :
type: string
example : 2020-12-01 13:58:12.420333+00:00
type:
type : string
example : dmn
primary :
type : boolean
example : false
content_type:
type: string
example : text/xml
primary_process_id:
type : string
example : null
md5_hash:
type: string
example: f12e2bbd-a20c-673b-ccb8-a8a1ea9c5b7b
WorkflowSpecFilesDiff:
properties:
filename :
type: string
example : data_security_plan.dmn
date_created :
type: string
example : 2020-12-01 13:58:12.420333+00:00
type:
type : string
example : dmn
primary :
type : boolean
example : false
content_type:
type: string
example : text/xml
primary_process_id:
type : string
example : null
md5_hash:
type: string
example: f12e2bbd-a20c-673b-ccb8-a8a1ea9c5b7b
location:
type : string
example : remote
new:
type: boolean
example : false
WorkflowSpecAll:
properties:
fixed error on api.yml from search / replace
2020-12-11 13:29:37 +00:00
workflow_spec_id :
Add a robust way of adding an API key, update examples and documentation for swagger API and add the ability to completely sync the local system from the remote system.
2020-12-09 17:13:17 +00:00
type: string
example : acaf1258-43b4-437e-8846-f612afa66811
date_created :
type: string
example : 2020-12-01 13:58:12.420333+00:00
md5_hash:
type: string
example: c30fd597f21715018eab12f97f9d4956
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
Updated Study Associate Endpoints
2021-03-22 21:30:49 +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"
primary_investigator_id:
type: string
x-nullable: true
example: dhf8r
user_uid:
type: string
example: dhf8r
status:
type: string
enum: ['in_progress', 'hold', 'open_for_enrollment', 'abandoned']
example: done
sponsor:
type: string
x-nullable: true
example: "Sartography Pharmaceuticals"
ind_number:
type: string
x-nullable: true
example: "27b-6-42"
StudyAssociate:
properties:
Fixed Associate API Endpoint description
2021-07-22 18:36:00 +00:00
uid:
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
Fixed Associate API Endpoint description
2021-07-22 18:36:00 +00:00
example: "dhf8r"
access:
type: boolean
example: False
role:
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
type: string
Fixed Associate API Endpoint description
2021-07-22 18:36:00 +00:00
example: "TODO"
Adding a test for the new endpoint and cleaning up the API documenation
2021-04-21 18:00:19 +00:00
DocumentDirectory:
Changes to support the frontend data pane fixes #277 and requires frontend branch 277-document-pane
2021-04-20 12:12:27 +00:00
properties:
Adding a test for the new endpoint and cleaning up the API documenation
2021-04-21 18:00:19 +00:00
level:
Changes to support the frontend data pane fixes #277 and requires frontend branch 277-document-pane
2021-04-20 12:12:27 +00:00
type: string
x-nullable: true
example: "Ancillary Document"
description:
type: string
x-nullable: true
Adding a test for the new endpoint and cleaning up the API documenation
2021-04-21 18:00:19 +00:00
example: "Documents that are ancillary to the study"
file:
$ref: "#/components/schemas/File"
x-nullable: true
expanded:
type: boolean
example: False
filecount:
type: integer
example: 1
children:
type: array
items:
$ref: "#/components/schemas/File"
Add last_updated field - change the api signature to be closer to what we need going forward, but retain the old methods for testing the script get/set through the API
2020-11-13 17:03:29 +00:00
DataStore:
properties:
id:
type: integer
example: 1234
key:
type: string
example: MyKey
workflow_id:
type: integer
x-nullable: true
example: 12
study_id:
type: integer
x-nullable: true
example: 42
user_id:
type: string
x-nullable: true
example: dhf8r
task_id:
type: string
x-nullable: true
example: MyTask
spec_id:
type: string
x-nullable: true
example: My Spec Name
value:
type: string
x-nullable: true
example: Some Value
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
Created 2 api endpoints; one to get a workflow from a workflow spec, and one to list all standalone workflow specs. Also added `standalone` argument to workflow_spec schema properties
2021-04-26 12:27:24 +00:00
standalone:
type: boolean
example: false
Set the default for the `standalone` parameter to `false`.
2021-05-06 15:54:04 +00:00
default: false
Adds workflow spec category to API
2020-03-16 16:10:32 +00:00
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"
fixed error on api.yml from search / replace
2020-12-11 13:29:37 +00:00
workflow_spec_id:
Adding file management. Files are stored in the database along with basic meta data.
2019-12-27 18:50:03 +00:00
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:
Merge branch 'dev' into bug/missing_pi_name_246 # Conflicts: # crc/api.yml # crc/services/study_service.py
2021-07-20 15:44:11 +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
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:
fixing the api.yml file which was starting to throw errors when updating the libraries. Seems that sqlalchemy now has a hard time incrementing sequences, so putting in a fix for this. Upgrading many of our libraries, to avoid any disconnects as we try to handle security patches from these automated bumps.
2021-04-02 21:10:05 +00:00
type: string
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"
fixed error on api.yml from search / replace
2020-12-11 13:29:37 +00:00
workflow_spec_id:
Adds workflow_spec_id back in to WorkflowApi
2020-02-07 17:36:08 +00:00
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
Added study_id to workflow_api
2021-04-29 18:29:21 +00:00
study_id:
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'
fixed error on api.yml from search / replace
2020-12-11 13:29:37 +00:00
workflow_spec_id: 'random_fact'
Cleaning up swagger docs.
2020-03-05 22:10:00 +00:00
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:
fixing the api.yml file which was starting to throw errors when updating the libraries. Seems that sqlalchemy now has a hard time incrementing sequences, so putting in a fix for this. Upgrading many of our libraries, to avoid any disconnects as we try to handle security patches from these automated bumps.
2021-04-02 21:10:05 +00:00
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
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'"
Whenever a workflow is loaded or updated, add events to the TaskEvent table with assignments for the next set of ready tasks, along with who should complete those tasks. Add the lane information to the Task model. Drop the foreign key constraint on the user_uid in the task log, as we might create tasks for users before they ever log into the system. Add a new endpoint to the API called task events. It should be possible to query this and get a list of all tasks that need a users attention. The task events returned include detailed information about the workflow and study as sub-models Rename all the actions in event log to things that are easier to pass over the api as arguments, make this backwards compatible, updating existing names in the database via the migration. Throughly test the navigation and task details as control of the workflow is passed between two lanes.
2020-07-15 02:16:44 +00:00
TaskEvent:
properties:
workflow:
$ref: "#/components/schemas/Workflow"
study:
$ref: "#/components/schemas/Study"
workflow_sec:
$ref: "#/components/schemas/WorkflowSpec"
spec_version:
type: string
action:
type: string
task_id:
type: string
task_type:
type: string
task_lane:
type: string
form_data:
type: object
mi_type:
type: string
mi_count:
type: integer
mi_index:
type: integer
process_name:
type: string
date:
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
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:
fixing the api.yml file which was starting to throw errors when updating the libraries. Seems that sqlalchemy now has a hard time incrementing sequences, so putting in a fix for this. Upgrading many of our libraries, to avoid any disconnects as we try to handle security patches from these automated bumps.
2021-04-02 21:10:05 +00:00
type: string
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:
fixing the api.yml file which was starting to throw errors when updating the libraries. Seems that sqlalchemy now has a hard time incrementing sequences, so putting in a fix for this. Upgrading many of our libraries, to avoid any disconnects as we try to handle security patches from these automated bumps.
2021-04-02 21:10:05 +00:00
type: string
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:
fixing the api.yml file which was starting to throw errors when updating the libraries. Seems that sqlalchemy now has a hard time incrementing sequences, so putting in a fix for this. Upgrading many of our libraries, to avoid any disconnects as we try to handle security patches from these automated bumps.
2021-04-02 21:10:05 +00:00
type: string
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
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
Adds endpoint to quickly get counts of approvals in each status group for a user
2020-06-06 02:19:37 +00:00
ApprovalCounts:
properties:
PENDING:
type: number
format: integer
example: 5
APPROVED:
type: number
format: integer
example: 5
DECLINED:
type: number
format: integer
example: 5
CANCELED:
type: number
format: integer
example: 5
AWAITING:
type: number
format: integer
example: 5