-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.js
317 lines (316 loc) · 13.6 KB
/
openapi.js
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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
module.exports = {
components: {
schemas: {
'morrigan.components.authentication.identityRecord': {
description: "Record of an identity within the system.",
type: 'object',
required: [
'_id',
'name',
'id',
'authId'
],
properties: {
_id: {
description: "Internal ID of this identity record.",
type: 'string'
},
name: {
description: "Username for this identity.",
type: 'string',
minLength: 1
},
id: {
description: "ID number of this identity within the system.",
type: 'string',
format: 'uuid',
readOnly: true
},
authId: {
description: "ID of the corresponding authentication record.",
type: 'string',
format: 'uuid',
readOnly: true
},
functions: {
description: "List of privileges that this user is granted.",
type: 'array',
items: {
$ref: '#/components/schemas/morrigan.components.authentication.function'
}
}
}
},
'morrigan.components.authentication.function': {
description: 'Name of a privilege that a user can hold.',
type: 'string',
minLength: 1,
pattern: '^[a-zA-Z0-9](\.[a-zA-Z0-9])*$'
},
'morrigan.components.authentication.errorMessage': {
description: 'Error information',
type: 'object',
required: [
'state'
],
properties: {
state: {
description: "Error name",
type: 'string',
pattern: '^(request|server)[a-zA-Z0-9]+'
},
reason: {
description: "Human-readable string giving further error details.",
type: 'string'
}
}
},
'morrigan.components.authentication.identityId': {
description: "ID for an existing identity in the system.",
type: 'string',
format: 'uuid',
}
},
parameters: {
'morrigan.components.authentication.identityId': {
name: 'identityId',
in: 'path',
required: true,
description: "ID for an existing identity in the system.",
schema: { $ref: '#/components/schemas/morrigan.components.authentication.identityId'},
allowEmptyValue: false
}
},
requestBodies: {
'morrigan.components.authentication.identitySpec': {
description: "Specifications for a new identity in the system.",
content: {
'application/json': {
schema: {
type: 'object',
required: [
'name',
'auth'
],
properties: {
name: {
description: "The username to be associated with this identity. This must be unique.",
type: 'string',
minLength: 1,
pattern: '[A-z0-9_\-.]+'
},
functions: {
description: "Privileges held by the new user.",
type: 'array',
items: {
type: 'string',
pattern: '[A-z0-9_\-.]+'
}
},
auth: {
description: "Authentication information: how this user should authenticate with the system.",
type: 'object',
required: [
'type'
],
properties: {
type: {
description: "The type of authentication to use. This is should correspond to the name of a loaded authentication provider.",
type: 'string',
minLength: 1,
pattern: '[A-z0-9_\-.]+'
}
}
}
}
}
}
},
required: true
},
'morrigan.components.authentication.identityOptions': {
description: "Options that can be set on an identity record.",
content: {
'application/json': {
schema: {
type: 'object',
properties: {
name: {
description: "A new username to be associated with this identity. This must be unique.",
type: 'string',
minLength: 1,
pattern: '[A-z0-9_\-.]+'
},
functions: {
description: "Set of privileges to be held by this user.",
type: 'array',
items: {
type: 'string',
pattern: '[A-z0-9_\-.]+'
}
},
auth: {
description: "Authentication information: how this user should authenticate with the system.",
type: 'object',
required: [
'type'
],
properties: {
type: {
description: "Name of the authentication method to use.",
type: 'string',
minLength: 1,
pattern: '[A-z0-9_\-.]+'
}
}
}
}
}
}
},
required: true
}
},
responses: {
'morrigan.components.authentication.errorMessage.generic.403': {
description: "No identity provided or the user is not authorized to perform the operation.",
},
'morrigan.components.authentication.errorMessage.generic.500': {
desription: "Someting went wrong on the server side.",
content: {
'application/json': {
schema: { $ref: '#/components/schemas/morrigan.components.authentication.errorMessage' }
}
}
},
'morrigan.components.authentication.patch.success': {
description: "Identity updated successfully.",
content: {
'application/json': {
schema: {
properties: {
state: {
description: "Status message",
pattern: '^success$',
type: 'string'
},
identity: {
$ref: '#/components/schemas/morrigan.components.authentication.identityRecord'
}
}
}
}
}
},
'morrigan.components.authentication.patch.requestError': {
description: "Failed to update the identity, see response body for details.",
content: {
'application/json': {
type: 'object',
schema: {
properties: {
state: {
description: "Error status",
pattern: '^request',
type: 'string'
},
reason: {
description: "More detailed human-readable error status message.",
type: 'string'
}
}
}
}
}
},
'morrigan.components.authentication.getSingle.200': {
description: "Returns the identity record.",
content: {
'application/json': {
schema: {
type: 'object',
properties: {
state: {
description: "Response status",
type: 'string',
pattern: '^success$'
},
identity: { $ref: '#/components/schemas/morrigan.components.authentication.identityRecord' }
}
}
}
}
},
'morrigan.components.authentication.getSingle.404': {
description: "No such identity exists.",
content: {
'application/json': {
schema: {
type: 'object',
properties: {
state: {
description: "Error status message.",
pattern: '^requestError$',
type: 'string'
},
reason: {
description: "More detailed human-readable error message.",
pattern: '^No such identity.$',
type: 'string'
}
}
},
example: { state: 'requestError', reason: 'No such identity.' }
}
}
},
'morrigan.components.authentication.getSingle.500': {
description: "A server error occurred.",
content: {
'application/json': {
schema: {
type: 'object',
properties: {
state: {
description: "Error status message.",
type: 'string',
pattern: '^serverError$'
},
reason: {
description: "More detailed human-readable error message.",
type: 'string',
}
}
},
example: {state: 'serverError', reason: 'Failed to retrieve identity records.'}
}
}
}
},
securitySchemes: {
authorizationToken: {
description: "Once authenticated using an authentication provider, the returned bearer token should be included in each request to the server.",
type: 'http',
scheme: 'bearer',
bearerFormat: 'jwt'
}
}
},
tags: [
{
name: 'Authentication',
description: "Common authentication endpoint for all Morrigan functions."
},
{
name: 'Identity',
description: "Identities form the basic principals of the system."
},
{
name: 'Identity Lifecycle',
description: "Methods used to control the creation and destruction of identities."
}
],
security: [{
authorizationToken: []
}]
}