Fixed Associate API Endpoint description
This commit is contained in:
parent
4632c6374f
commit
b94d49076d
|
@ -399,21 +399,23 @@ paths:
|
||||||
- name: study_id
|
- name: study_id
|
||||||
in: path
|
in: path
|
||||||
required: true
|
required: true
|
||||||
description: The id of the study for which workflows should be returned.
|
description: The id of the study for which associates should be returned.
|
||||||
schema:
|
schema:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
get:
|
get:
|
||||||
operationId: crc.api.study.get_study_associates
|
operationId: crc.api.study.get_study_associates
|
||||||
summary: Provides a single study
|
summary: Provides a list of associates for a particular study
|
||||||
tags:
|
tags:
|
||||||
- Studies
|
- Studies
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: An Study Associate Object
|
description: list of Study Associate Objects
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
$ref: "#/components/schemas/StudyAssociate"
|
$ref: "#/components/schemas/StudyAssociate"
|
||||||
|
|
||||||
/workflow-specification:
|
/workflow-specification:
|
||||||
|
@ -1589,39 +1591,15 @@ components:
|
||||||
example: "27b-6-1212"
|
example: "27b-6-1212"
|
||||||
StudyAssociate:
|
StudyAssociate:
|
||||||
properties:
|
properties:
|
||||||
id:
|
uid:
|
||||||
type: integer
|
|
||||||
example: 1234
|
|
||||||
title:
|
|
||||||
type: string
|
type: string
|
||||||
example: The impact of fried pickles on beer consumption in bipedal software developers.
|
example: "dhf8r"
|
||||||
last_updated:
|
access:
|
||||||
|
type: boolean
|
||||||
|
example: False
|
||||||
|
role:
|
||||||
type: string
|
type: string
|
||||||
format: date_time
|
example: "TODO"
|
||||||
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"
|
|
||||||
hsr_number:
|
|
||||||
type: string
|
|
||||||
x-nullable: true
|
|
||||||
example: "27b-6-1212"
|
|
||||||
DocumentDirectory:
|
DocumentDirectory:
|
||||||
properties:
|
properties:
|
||||||
level:
|
level:
|
||||||
|
|
Loading…
Reference in New Issue