diff --git a/crc/api.yml b/crc/api.yml index 0e1fe4b5..af7fdf47 100644 --- a/crc/api.yml +++ b/crc/api.yml @@ -10,7 +10,7 @@ paths: # /v1.0/study /study: get: - operationId: crc.api.study.all_studies + operationId: api.study.all_studies summary: Provides a list of studies related to the current user. tags: - Studies @@ -28,7 +28,7 @@ paths: schema: $ref: "#/components/schemas/Error" post: - operationId: crc.api.study.add_study + operationId: api.study.add_study summary: Creates a new study with the given parameters. tags: - Studies @@ -52,7 +52,7 @@ paths: $ref: "#/components/schemas/Error" /study/{study_id}: get: - operationId: crc.api.study.get_study + operationId: api.study.get_study summary: Provides a single study tags: - Studies @@ -78,7 +78,7 @@ paths: schema: $ref: "#/components/schemas/Error" post: - operationId: crc.api.study.update_study + operationId: api.study.update_study summary: Updates an existing study with the given parameters. tags: - Studies @@ -110,7 +110,7 @@ paths: $ref: "#/components/schemas/Error" /study-update/{study_id}: post: - operationId: crc.api.study.post_update_study_from_protocol_builder + operationId: api.study.post_update_study_from_protocol_builder summary: If the study is up-to-date with Protocol Builder, returns a 304 Not Modified. If out of date, return a 202 Accepted and study state changes to updating. tags: - Study Status @@ -136,7 +136,7 @@ paths: /study/{study_id}/workflows: get: - operationId: crc.api.study.get_study_workflows + operationId: api.study.get_study_workflows summary: Provides a list of workflows to be completed for the given study. tags: - Studies @@ -164,7 +164,7 @@ paths: schema: $ref: "#/components/schemas/Error" post: - operationId: crc.api.study.add_workflow_to_study + operationId: api.study.add_workflow_to_study summary: Starts a new workflow for the given study using the provided spec. This is atypical, and should be left to the protocol builder. tags: - Studies @@ -198,7 +198,7 @@ paths: $ref: "#/components/schemas/Error" /workflow-specification: get: - operationId: crc.api.workflow.all_specifications + operationId: api.workflow.all_specifications 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: - Workflows and Tasks @@ -218,7 +218,7 @@ paths: schema: $ref: "#/components/schemas/Error" post: - operationId: crc.api.workflow.add_workflow_specification + operationId: api.workflow.add_workflow_specification summary: Creates a new workflow specification with the given parameters. tags: - Workflows and Tasks @@ -242,7 +242,7 @@ paths: $ref: "#/components/schemas/Error" /workflow-specification/{spec_id}: put: - operationId: crc.api.workflow.update_workflow_specification + operationId: api.workflow.update_workflow_specification summary: Modifies an existing workflow specification with the given parameters. tags: - Workflows and Tasks @@ -280,7 +280,7 @@ paths: schema: type: string get: - operationId: crc.api.file.get_files + operationId: api.file.get_files 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 @@ -300,7 +300,7 @@ paths: schema: $ref: "#/components/schemas/Error" post: - operationId: crc.api.file.add_file + operationId: api.file.add_file summary: Add a new file tags: - Files @@ -332,7 +332,7 @@ paths: schema: type: integer get: - operationId: crc.api.file.get_file_info + operationId: api.file.get_file_info summary: Returns metadata about a file. tags: - Files @@ -344,7 +344,7 @@ paths: schema: $ref: "#/components/schemas/File" put: - operationId: crc.api.file.update_file + operationId: api.file.update_file summary: Update a file tags: - Files @@ -367,7 +367,7 @@ paths: schema: $ref: "#/components/schemas/File" delete: - operationId: crc.api.file.delete_file + operationId: api.file.delete_file summary: Removes an existing file tags: - Files @@ -383,7 +383,7 @@ paths: schema: type: integer get: - operationId: crc.api.file.get_file + operationId: api.file.get_file summary: Returns only the file contents tags: - Files @@ -407,7 +407,7 @@ paths: type: integer format: int32 get: - operationId: crc.api.workflow.get_workflow + operationId: api.workflow.get_workflow summary: Detailed information for a specific workflow instance tags: - Workflows and Tasks @@ -425,7 +425,7 @@ paths: schema: $ref: "#/components/schemas/Error" delete: - operationId: crc.api.workflow.delete + operationId: api.workflow.delete summary: Removes an existing workflow tags: - Workflows and Tasks @@ -434,7 +434,7 @@ paths: description: The workflow was removed /workflow/{workflow_id}/tasks: get: - operationId: crc.api.workflow.get_tasks + operationId: api.workflow.get_tasks summary: Return a list of all tasks for this workflow tags: - Workflows and Tasks @@ -479,7 +479,7 @@ paths: type: string format: uuid get: - operationId: crc.api.workflow.get_task + operationId: api.workflow.get_task summary: Get details of specific task in specific workflow instance tags: - Workflows and Tasks @@ -513,7 +513,7 @@ paths: type: string format: uuid put: - operationId: crc.api.workflow.update_task + operationId: api.workflow.update_task summary: Exclusively for User Tasks, submits form data as a flat set of key/values. tags: - Workflows and Tasks diff --git a/crc/api/workflow.py b/crc/api/workflow.py index b6eb0115..39046387 100644 --- a/crc/api/workflow.py +++ b/crc/api/workflow.py @@ -1,7 +1,5 @@ import uuid -import connexion - from api.common import ApiError, ApiErrorSchema from crc import session from crc.models.workflow import WorkflowModel, WorkflowModelSchema, WorkflowSpecModelSchema, WorkflowSpecModel, \