Cleaning up swagger docs.
This commit is contained in:
parent
bb3f0dc128
commit
e501fb31fd
33
crc/api.yml
33
crc/api.yml
|
@ -804,31 +804,34 @@ components:
|
||||||
status:
|
status:
|
||||||
type: enum
|
type: enum
|
||||||
enum: ['new','user_input_required','waiting','complete']
|
enum: ['new','user_input_required','waiting','complete']
|
||||||
last_task:
|
|
||||||
$ref: "#/components/schemas/Task"
|
|
||||||
next_task:
|
|
||||||
$ref: "#/components/schemas/Task"
|
|
||||||
user_tasks:
|
user_tasks:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: "#/components/schemas/Task"
|
$ref: "#/components/schemas/Task"
|
||||||
|
last_task:
|
||||||
|
$ref: "#/components/schemas/Task"
|
||||||
|
next_task:
|
||||||
|
$ref: "#/components/schemas/Task"
|
||||||
workflow_spec_id:
|
workflow_spec_id:
|
||||||
type: string
|
type: string
|
||||||
|
spec_version:
|
||||||
|
type: string
|
||||||
|
is_latest_spec:
|
||||||
|
type: boolean
|
||||||
|
|
||||||
example:
|
example:
|
||||||
id: 291234
|
id: 291234
|
||||||
status: 'user_input_required'
|
status: 'user_input_required'
|
||||||
current_task_ids: ['study_identification','Detailed Reports']
|
workflow_spec_id: 'random_fact'
|
||||||
workflow_spec:
|
spec_version: 'v1.1 [22,23]'
|
||||||
id: 'prot_def'
|
is_latest_spec: True
|
||||||
display_name: 'Protocol Definition'
|
next_task:
|
||||||
description: 'Collect some additional information about your protocol to complete forms and processes.'
|
id: study_identification
|
||||||
bpmn_url: 'https://crconnect.viriginia.edu/prot_def.bpmn'
|
name: Study Identification
|
||||||
svg_url: 'https://crconnect.viriginia.edu/prot_def.svg'
|
title: IRB Review
|
||||||
messages: [
|
documentation: "# Heading 1\n\nMarkdown documentation text goes here"
|
||||||
"Protocol Builder reports that the protocol process is complete for this study.",
|
type: form
|
||||||
"IDS Submission Template was generated successfully."
|
state: ready
|
||||||
]
|
|
||||||
Task:
|
Task:
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
|
|
Loading…
Reference in New Issue