/
swagger.yaml
244 lines (240 loc) · 8.7 KB
/
swagger.yaml
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
openapi: '3.0.0'
info:
version: 0.0.2
title: restify_waterline_scaffold API
description: Simple user+auth scaffold using TypeORM, Restify and Redis
termsOfService: null
license:
name: (Apache-2.0 OR MIT)
url: https://www.apache.org/licenses/LICENSE-2.0.html
paths:
/users:
get:
description: |
Returns all users from the system that the user has access to
operationId: findUsers
parameters:
- name: x-access-token
in: header
description: access token to be passed as a header
required: true
schema:
type: string
- name: role
in: query
description: 'role to filter by, e.g.: ophthalmologist'
required: false
style: form
schema:
type: array
items:
type: string
- name: limit
in: query
description: maximum number of results to return
required: false
schema:
type: integer
format: int32
responses:
'200':
description: user response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
description: Register a new. Duplicates are not allowed
operationId: registerUser
requestBody:
description: User to add to the store
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/User'
responses:
'200':
description: User response
content:
application/json:
schema:
$ref: '#/components/schemas/User'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/users/{username}:
get:
description: 'Returns a user based on a single ID, if the user has access to the user at username and user at ID exists'
operationId: find user by id
parameters:
- name: x-access-token
in: header
description: access token to be passed as a header
required: true
schema:
type: string
- name: username
in: path
description: username of user to fetch
required: true
schema:
type: string
responses:
'200':
description: user response
content:
application/json:
schema:
$ref: '#/components/schemas/User'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
description: deletes a user based on the ID supplied (only used for test cleanup)
operationId: deleteUser
parameters:
- name: x-access-token
in: header
description: access token to be passed as a header
required: true
schema:
type: string
- name: username
in: path
description: ID of user to delete
required: true
schema:
type: string
responses:
'204':
description: user deleted
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/auth:
get:
description: |
Returns user associated with access token (or expiry details for current key?)
operationId: checkAuth
parameters:
- name: x-access-token
in: header
description: access token to be passed as a header
required: true
schema:
type: string
responses:
'200':
description: user response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
'403':
description: access token invalid
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: user or access token not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
description: Login a user. Duplicates are allowed
operationId: loginUser
requestBody:
description: User to authenticate
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/User'
responses:
'200':
description: User response
content:
application/json:
schema:
$ref: '#/components/schemas/User'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
description: logout a user
operationId: logoutUser
parameters:
- name: x-access-token
in: header
description: access token to be passed as a header
required: true
schema:
type: string
responses:
'204':
description: user logged ut
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
User:
allOf:
- $ref: '#/components/schemas/NewUser'
- type: object
required:
- username
properties:
username:
type: string
NewUser:
type: object
required:
- username
- email
- password
properties:
username: # Need username not just email field for hiding bias of known email
type: string
email:
type: string
role:
type: array
items:
type: string
tag:
type: string