Fixes path to api methods
This commit is contained in:
parent
790b0dfc3a
commit
054bd88760
42
crc/api.yml
42
crc/api.yml
|
@ -10,7 +10,7 @@ paths:
|
||||||
# /v1.0/study
|
# /v1.0/study
|
||||||
/study:
|
/study:
|
||||||
get:
|
get:
|
||||||
operationId: crc.api.study.all_studies
|
operationId: api.study.all_studies
|
||||||
summary: Provides a list of studies related to the current user.
|
summary: Provides a list of studies related to the current user.
|
||||||
tags:
|
tags:
|
||||||
- Studies
|
- Studies
|
||||||
|
@ -28,7 +28,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/Error"
|
$ref: "#/components/schemas/Error"
|
||||||
post:
|
post:
|
||||||
operationId: crc.api.study.add_study
|
operationId: api.study.add_study
|
||||||
summary: Creates a new study with the given parameters.
|
summary: Creates a new study with the given parameters.
|
||||||
tags:
|
tags:
|
||||||
- Studies
|
- Studies
|
||||||
|
@ -52,7 +52,7 @@ paths:
|
||||||
$ref: "#/components/schemas/Error"
|
$ref: "#/components/schemas/Error"
|
||||||
/study/{study_id}:
|
/study/{study_id}:
|
||||||
get:
|
get:
|
||||||
operationId: crc.api.study.get_study
|
operationId: api.study.get_study
|
||||||
summary: Provides a single study
|
summary: Provides a single study
|
||||||
tags:
|
tags:
|
||||||
- Studies
|
- Studies
|
||||||
|
@ -78,7 +78,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/Error"
|
$ref: "#/components/schemas/Error"
|
||||||
post:
|
post:
|
||||||
operationId: crc.api.study.update_study
|
operationId: api.study.update_study
|
||||||
summary: Updates an existing study with the given parameters.
|
summary: Updates an existing study with the given parameters.
|
||||||
tags:
|
tags:
|
||||||
- Studies
|
- Studies
|
||||||
|
@ -110,7 +110,7 @@ paths:
|
||||||
$ref: "#/components/schemas/Error"
|
$ref: "#/components/schemas/Error"
|
||||||
/study-update/{study_id}:
|
/study-update/{study_id}:
|
||||||
post:
|
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.
|
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:
|
tags:
|
||||||
- Study Status
|
- Study Status
|
||||||
|
@ -136,7 +136,7 @@ paths:
|
||||||
|
|
||||||
/study/{study_id}/workflows:
|
/study/{study_id}/workflows:
|
||||||
get:
|
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.
|
summary: Provides a list of workflows to be completed for the given study.
|
||||||
tags:
|
tags:
|
||||||
- Studies
|
- Studies
|
||||||
|
@ -164,7 +164,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/Error"
|
$ref: "#/components/schemas/Error"
|
||||||
post:
|
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.
|
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:
|
tags:
|
||||||
- Studies
|
- Studies
|
||||||
|
@ -198,7 +198,7 @@ paths:
|
||||||
$ref: "#/components/schemas/Error"
|
$ref: "#/components/schemas/Error"
|
||||||
/workflow-specification:
|
/workflow-specification:
|
||||||
get:
|
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.
|
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:
|
tags:
|
||||||
- Workflows and Tasks
|
- Workflows and Tasks
|
||||||
|
@ -218,7 +218,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/Error"
|
$ref: "#/components/schemas/Error"
|
||||||
post:
|
post:
|
||||||
operationId: crc.api.workflow.add_workflow_specification
|
operationId: api.workflow.add_workflow_specification
|
||||||
summary: Creates a new workflow specification with the given parameters.
|
summary: Creates a new workflow specification with the given parameters.
|
||||||
tags:
|
tags:
|
||||||
- Workflows and Tasks
|
- Workflows and Tasks
|
||||||
|
@ -242,7 +242,7 @@ paths:
|
||||||
$ref: "#/components/schemas/Error"
|
$ref: "#/components/schemas/Error"
|
||||||
/workflow-specification/{spec_id}:
|
/workflow-specification/{spec_id}:
|
||||||
put:
|
put:
|
||||||
operationId: crc.api.workflow.update_workflow_specification
|
operationId: api.workflow.update_workflow_specification
|
||||||
summary: Modifies an existing workflow specification with the given parameters.
|
summary: Modifies an existing workflow specification with the given parameters.
|
||||||
tags:
|
tags:
|
||||||
- Workflows and Tasks
|
- Workflows and Tasks
|
||||||
|
@ -280,7 +280,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
get:
|
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.
|
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:
|
tags:
|
||||||
- Files
|
- Files
|
||||||
|
@ -300,7 +300,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/Error"
|
$ref: "#/components/schemas/Error"
|
||||||
post:
|
post:
|
||||||
operationId: crc.api.file.add_file
|
operationId: api.file.add_file
|
||||||
summary: Add a new file
|
summary: Add a new file
|
||||||
tags:
|
tags:
|
||||||
- Files
|
- Files
|
||||||
|
@ -332,7 +332,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: integer
|
type: integer
|
||||||
get:
|
get:
|
||||||
operationId: crc.api.file.get_file_info
|
operationId: api.file.get_file_info
|
||||||
summary: Returns metadata about a file.
|
summary: Returns metadata about a file.
|
||||||
tags:
|
tags:
|
||||||
- Files
|
- Files
|
||||||
|
@ -344,7 +344,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/File"
|
$ref: "#/components/schemas/File"
|
||||||
put:
|
put:
|
||||||
operationId: crc.api.file.update_file
|
operationId: api.file.update_file
|
||||||
summary: Update a file
|
summary: Update a file
|
||||||
tags:
|
tags:
|
||||||
- Files
|
- Files
|
||||||
|
@ -367,7 +367,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/File"
|
$ref: "#/components/schemas/File"
|
||||||
delete:
|
delete:
|
||||||
operationId: crc.api.file.delete_file
|
operationId: api.file.delete_file
|
||||||
summary: Removes an existing file
|
summary: Removes an existing file
|
||||||
tags:
|
tags:
|
||||||
- Files
|
- Files
|
||||||
|
@ -383,7 +383,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
type: integer
|
type: integer
|
||||||
get:
|
get:
|
||||||
operationId: crc.api.file.get_file
|
operationId: api.file.get_file
|
||||||
summary: Returns only the file contents
|
summary: Returns only the file contents
|
||||||
tags:
|
tags:
|
||||||
- Files
|
- Files
|
||||||
|
@ -407,7 +407,7 @@ paths:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
get:
|
get:
|
||||||
operationId: crc.api.workflow.get_workflow
|
operationId: api.workflow.get_workflow
|
||||||
summary: Detailed information for a specific workflow instance
|
summary: Detailed information for a specific workflow instance
|
||||||
tags:
|
tags:
|
||||||
- Workflows and Tasks
|
- Workflows and Tasks
|
||||||
|
@ -425,7 +425,7 @@ paths:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/Error"
|
$ref: "#/components/schemas/Error"
|
||||||
delete:
|
delete:
|
||||||
operationId: crc.api.workflow.delete
|
operationId: api.workflow.delete
|
||||||
summary: Removes an existing workflow
|
summary: Removes an existing workflow
|
||||||
tags:
|
tags:
|
||||||
- Workflows and Tasks
|
- Workflows and Tasks
|
||||||
|
@ -434,7 +434,7 @@ paths:
|
||||||
description: The workflow was removed
|
description: The workflow was removed
|
||||||
/workflow/{workflow_id}/tasks:
|
/workflow/{workflow_id}/tasks:
|
||||||
get:
|
get:
|
||||||
operationId: crc.api.workflow.get_tasks
|
operationId: api.workflow.get_tasks
|
||||||
summary: Return a list of all tasks for this workflow
|
summary: Return a list of all tasks for this workflow
|
||||||
tags:
|
tags:
|
||||||
- Workflows and Tasks
|
- Workflows and Tasks
|
||||||
|
@ -479,7 +479,7 @@ paths:
|
||||||
type: string
|
type: string
|
||||||
format: uuid
|
format: uuid
|
||||||
get:
|
get:
|
||||||
operationId: crc.api.workflow.get_task
|
operationId: api.workflow.get_task
|
||||||
summary: Get details of specific task in specific workflow instance
|
summary: Get details of specific task in specific workflow instance
|
||||||
tags:
|
tags:
|
||||||
- Workflows and Tasks
|
- Workflows and Tasks
|
||||||
|
@ -513,7 +513,7 @@ paths:
|
||||||
type: string
|
type: string
|
||||||
format: uuid
|
format: uuid
|
||||||
put:
|
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.
|
summary: Exclusively for User Tasks, submits form data as a flat set of key/values.
|
||||||
tags:
|
tags:
|
||||||
- Workflows and Tasks
|
- Workflows and Tasks
|
||||||
|
|
|
@ -1,7 +1,5 @@
|
||||||
import uuid
|
import uuid
|
||||||
|
|
||||||
import connexion
|
|
||||||
|
|
||||||
from api.common import ApiError, ApiErrorSchema
|
from api.common import ApiError, ApiErrorSchema
|
||||||
from crc import session
|
from crc import session
|
||||||
from crc.models.workflow import WorkflowModel, WorkflowModelSchema, WorkflowSpecModelSchema, WorkflowSpecModel, \
|
from crc.models.workflow import WorkflowModel, WorkflowModelSchema, WorkflowSpecModelSchema, WorkflowSpecModel, \
|
||||||
|
|
Loading…
Reference in New Issue