This repository was archived by the owner on Feb 11, 2025. It is now read-only.
forked from corona-warn-app/cwa-testresult-server
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.json
More file actions
295 lines (295 loc) · 9.53 KB
/
openapi.json
File metadata and controls
295 lines (295 loc) · 9.53 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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
{"openapi": "3.0.1",
"info": {
"title": "cwa-testresult-server",
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "1.4.4-SNAPSHOT"
},
"servers": [
{
"url": "http://localhost:8080",
"description": "Generated server url"
}
],
"paths": {
"/api/v1/quicktest/results": {
"post": {
"tags": [
"test-result-controller"
],
"summary": "Set multiple testresults for a Rapid Antigen Test as an array.",
"description": "The result and the sc (sample collection) timestamp of a RAT can be set.",
"operationId": "quicktestResults",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestResultRequest"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No content, RAT result(s) inserted successfully.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
}
},
"/api/v1/quicktest/result": {
"post": {
"tags": [
"test-result-controller"
],
"summary": "Set the testresult for a Rapid Antigen Test.",
"description": "The result and the sc (sample collection) timestamp of a RAT can be set.",
"operationId": "quickTestResult",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestResultRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Ok, RAT result inserted successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestResultResponse"
}
}
}
}
}
}
},
"/api/v1/pocnat/results": {
"post": {
"tags": [
"test-result-controller"
],
"summary": "Set multiple testresults for a PoC-NAT as an array.",
"description": "The result and the sc (sample collection) timestamp of a PoC-NAT can be set.",
"operationId": "pocnatResults",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PocNatResultList"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No content, PoC-NAT result(s) inserted successfully."
}
}
}
},
"/api/v1/pocnat/result": {
"post": {
"tags": [
"test-result-controller"
],
"summary": "Set the testresult for a PoC-NAT.",
"description": "The result and the sc (sample collection) timestamp of a PoC-NAT can be set.",
"operationId": "pocnatResult",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestResultRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Ok, PoC-NAT result inserted successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestResultResponse"
}
}
}
}
}
}
},
"/api/v1/lab/results": {
"post": {
"tags": [
"test-result-controller"
],
"summary": "PCR Testresults to be inserted by labs.",
"description": "PCR testresults can be inserted.",
"operationId": "results",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestResultRequest"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No content, testresult successfully inserted",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
}
},
"/api/v1/app/result": {
"post": {
"tags": [
"test-result-controller"
],
"summary": "Retrieve test results",
"description": "Get test result for a given TestId (Hashed GUID)",
"operationId": "result",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestResultRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Content exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestResultResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"TestResultRequest": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"pattern": "^[XxA-Fa-f0-9]([A-Fa-f0-9]{63})$",
"type": "string"
},
"sc": {
"type": "integer",
"format": "int64"
}
},
"description": "The test result request model."
},
"TestResultResponse": {
"required": [
"testResult"
],
"type": "object",
"properties": {
"testResult": {
"maximum": 9,
"minimum": 0,
"type": "integer",
"format": "int32"
},
"sc": {
"type": "integer",
"format": "int64"
},
"labId": {
"type": "string"
}
},
"description": "The test result response model."
},
"PocNatResult": {
"required": [
"id",
"result"
],
"type": "object",
"properties": {
"id": {
"pattern": "^[XxA-Fa-f0-9]([A-Fa-f0-9]{63})$",
"type": "string",
"description": "the testId (Hashed GUID"
},
"result": {
"maximum": 14,
"minimum": 10,
"type": "integer",
"description": "the result of the PoC-NAT",
"format": "int32"
},
"sc": {
"type": "integer",
"description": "the timestamp of the sample collection (sc) in unix epoch format. If not set, the time of insertion will be used instead",
"format": "int64"
}
},
"description": "The PoC-NAT result model."
},
"PocNatResultList": {
"required": [
"labId",
"testResults"
],
"type": "object",
"properties": {
"testResults": {
"type": "array",
"description": "array of PoC-NAT results",
"items": {
"$ref": "#/components/schemas/PocNatResult"
}
},
"labId": {
"maxLength": 64,
"type": "string",
"description": "The id that identifies a lab. Every lab can choose its own labid, but it must be unique over all labs, should be generated once via cryptographic hash function"
}
},
"description": "The PoC-NAT result list model."
}
}
}
}