Browse Source

Update swagger documentation

master
Joshua Rubingh 11 months ago
parent
commit
57270875e2
  1. BIN
      doc/documentation.pdf
  2. 55
      doc/swagger.yaml

BIN
doc/documentation.pdf

Binary file not shown.

55
doc/swagger.yaml

@ -536,10 +536,35 @@ paths: @@ -536,10 +536,35 @@ paths:
in: path
required: true
type: string
/v1/studies/{study_id}/contributor/invite/:
/v1/studies/{study_id}/contributors/:
get:
operationId: v1_studies_contributors_list
description: Get all the contributors that are assigned to a study of which you are also a member of.
parameters:
- name: page
in: query
description: A page number within the paginated result set.
required: false
type: integer
responses:
"200":
description: ""
schema:
type: array
items:
$ref: "#/definitions/Contributor"
tags:
- v1
parameters:
- name: study_id
in: path
description: Study
required: true
type: string
/v1/studies/{study_id}/contributors/invite/:
post:
operationId: v1_studies_contributor_invite_create
description: ""
operationId: v1_studies_contributors_invite_create
description: Sent an invitation to a new or existing researcher. The researcher is looked up based on email address.
parameters:
- name: data
in: body
@ -558,29 +583,23 @@ paths: @@ -558,29 +583,23 @@ paths:
in: path
required: true
type: string
/v1/studies/{study_id}/contributors/:
/v1/studies/{study_id}/contributors/join/{jwt_token}:
get:
operationId: v1_studies_contributors_list
description: Get all the contributors that are assigned to a study of which you are also a member of.
parameters:
- name: page
in: query
description: A page number within the paginated result set.
required: false
type: integer
operationId: v1_studies_contributors_join_read
description: This will validate an invitation for a researcher for a single study. The JWT token is valid for 3 days.
parameters: []
responses:
"200":
description: ""
schema:
type: array
items:
$ref: "#/definitions/Contributor"
tags:
- v1
parameters:
- name: jwt_token
in: path
required: true
type: string
- name: study_id
in: path
description: Study
required: true
type: string
/v1/studies/{study_id}/contributors/{contributor_id}/:
@ -634,7 +653,7 @@ paths: @@ -634,7 +653,7 @@ paths:
- v1
delete:
operationId: v1_studies_contributors_delete
description: ""
description: Delete an existing researche from a study. This can only be done by either an admin or owner of the study
parameters: []
responses:
"204":

Loading…
Cancel
Save