Repository navigation
Expand file tree
/
Copy pathsharing_settings.yaml
More file actions
131 lines (131 loc) · 3.96 KB
/
Copy pathsharing_settings.yaml
File metadata and controls
131 lines (131 loc) · 3.96 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
openapi: 3.0.0
info:
title: Sharing setting integration API
description: "Sharing setting integration API"
version: 0.0.1
servers:
- url: /consortia/{consortiumId}/sharing
paths:
/settings:
post:
summary: start setting sharing
operationId: startSharingSetting
parameters:
- $ref: "#/components/parameters/consortiumId"
requestBody:
$ref: "#/components/requestBodies/SharingSettingBody"
responses:
"201":
$ref: "#/components/responses/SharingSettingResponse"
"400":
$ref: "#/components/responses/BadRequest"
"404":
$ref: "#/components/responses/NotFound"
"409":
$ref: "#/components/responses/Conflict"
"422":
$ref: "#/components/responses/Conflict"
"500":
$ref: "#/components/responses/InternalServerError"
/settings/{settingId}:
delete:
summary: delete sharing setting
operationId: deleteSharingSetting
parameters:
- $ref: "#/components/parameters/consortiumId"
- $ref: "#/components/parameters/settingId"
requestBody:
$ref: "#/components/requestBodies/SharingSettingBody"
responses:
"200":
$ref: "#/components/responses/SharingSettingDeleteResponse"
"400":
$ref: "#/components/responses/BadRequest"
"404":
$ref: "#/components/responses/NotFound"
"409":
$ref: "#/components/responses/Conflict"
"422":
$ref: "#/components/responses/Conflict"
"500":
$ref: "#/components/responses/InternalServerError"
components:
requestBodies:
SharingSettingBody:
description: Sharing settings object
required: true
content:
application/json:
schema:
$ref: "schemas/sharingSetting.yaml#/SharingSettingRequest"
example:
$ref: "examples/requests/sharing_setting_request_for_department.json"
responses:
SharingSettingResponse:
description: Returns a sharing setting object response for post operation
content:
application/json:
schema:
$ref: "schemas/sharingSetting.yaml#/SharingSettingResponse"
example:
$ref: "examples/responses/sharing_setting_response.json"
SharingSettingDeleteResponse:
description: Returns a sharing setting response for delete operation
content:
application/json:
schema:
$ref: "schemas/sharingSetting.yaml#/SharingSettingDeleteResponse"
example:
$ref: "examples/responses/sharing_setting_delete_response.json"
NoContent:
description: No content
Conflict:
description: Validation errors
content:
application/json:
schema:
$ref: "schemas/common.yaml#/Errors"
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: "schemas/common.yaml#/Errors"
BadRequest:
description: Bad request
content:
application/json:
schema:
$ref: "schemas/common.yaml#/Errors"
Unauthorized:
description: Not authorized to perform requested action
content:
text/plain:
example: unable to perform action -- unauthorized
UnprocessableEntity:
description: Validation errors
content:
application/json:
schema:
$ref: 'schemas/common.yaml#/Errors'
InternalServerError:
description: Internal server error
content:
application/json:
schema:
$ref: "schemas/common.yaml#/Error"
parameters:
consortiumId:
in: path
name: consortiumId
schema:
$ref: "schemas/common.yaml#/uuid"
required: true
description: The ID of consortium
settingId:
in: path
name: settingId
schema:
$ref: "schemas/common.yaml#/uuid"
required: true
description: The ID of setting