-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathapi.txt
More file actions
398 lines (363 loc) · 30.1 KB
/
api.txt
File metadata and controls
398 lines (363 loc) · 30.1 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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
@userdashboard/dashboard 1.0.383
http://localhost:8000
|--------------------------------------------|
| /account/organizations/create-invitation |
| EXCEPTIONS---------------------------------|
| undefined |
| * invalid-account |
| before |
| * should bind data to req |
| view |
| * should present the form |
| submit |
| * should create invitation (screenshots) |
|--------------------------------------------|
|--------------------------------------------|
| /account/organizations/delete-invitation |
| EXCEPTIONS---------------------------------|
| undefined |
| * invalid-account |
| before |
| * should bind data |
| view |
| * should present the form |
| submit |
| * should delete invitation (screenshots) |
|--------------------------------------------|
|--------------------------------------------|
| /account/organizations/delete-membership |
| EXCEPTIONS---------------------------------|
| undefined |
| * invalid-account |
| before |
| * should bind data to req |
| view |
| * should present the form |
| submit |
| * should delete membership (screenshots) |
|--------------------------------------------|
|----------------------------------------------|
| /account/organizations/delete-organization |
| EXCEPTIONS-----------------------------------|
| undefined |
| * invalid-account |
| before |
| * should bind data to req |
| view |
| * should present the form |
| submit |
| * should delete organization (screenshots) |
|----------------------------------------------|
|----------------------------------------------------|
| /account/organizations/edit-organization |
| EXCEPTIONS-----------------------------------------|
| undefined |
| * should require owner |
| before |
| * should bind data to req |
| view |
| * should present the form |
| submit |
| * should apply organization update (screenshots) |
| errors |
| * invalid-organization-name |
| * invalid-organization-name-length |
| * invalid-organization-email |
|----------------------------------------------------|
|--------------------------------------------|
| /account/organizations/revoke-membership |
| EXCEPTIONS---------------------------------|
| undefined |
| * invalid-account |
| before |
| * should bind data to req |
| view |
| * should present the form |
| submit |
| * should delete membership (screenshots) |
|--------------------------------------------|
|-----------------------------------------------|
| /account/organizations/transfer-organization |
| EXCEPTIONS------------------------------------|
| undefined |
| * invalid-account |
| before |
| * should bind data to req |
| view |
| * should present the form |
| submit |
| * should transfer ownership (screenshots) |
|-----------------------------------------------|
|--------------------------------------------------------------------------------------------------------|
| /api/administrator/organizations/invitation |
| RECEIVES---------------------------| RETURNS--| REDACTS---------| EXCEPTIONS---------------------------|
| required querystring invitationid | object | secretCodeHash | invalid-invitationid |
| | | | * missing querystring invitationid |
| | | | * invalid querystring invitationid |
|------------------------------------|----------|-----------------|--------------------------------------|
|-----------------------------------------------------------------------------------|
| /api/administrator/organizations/invitations |
| RECEIVES--------------------------------------| RETURNS--| CONFIGURATION----------|
| optional querystring offset (integer) | array | environment PAGE_SIZE |
| optional querystring limit (integer) | | |
| optional querystring all (boolean) | | |
| optional querystring accountid (string) | | |
| optional querystring organizationid (string) | | |
|-----------------------------------------------|----------|------------------------|
|-----------------------------------------------------|
| /api/administrator/organizations/invitations-count |
| RETURNS---------------------------------------------|
| integer |
|-----------------------------------------------------|
|--------------------------------------------------------------------------------------|
| /api/administrator/organizations/membership |
| RECEIVES---------------------------| RETURNS--| EXCEPTIONS---------------------------|
| required querystring membershipid | object | invalid-membershipid |
| | | * missing querystring membershipid |
| | | * invalid querystring membershipid |
|------------------------------------|----------|--------------------------------------|
|-----------------------------------------------------------------------------------|
| /api/administrator/organizations/memberships |
| RECEIVES--------------------------------------| RETURNS--| CONFIGURATION----------|
| optional querystring offset (integer) | array | environment PAGE_SIZE |
| optional querystring limit (integer) | | |
| optional querystring all (boolean) | | |
| optional querystring accountid (string) | | |
| optional querystring organizationid (string) | | |
|-----------------------------------------------|----------|------------------------|
|-----------------------------------------------------|
| /api/administrator/organizations/memberships-count |
| RETURNS---------------------------------------------|
| integer |
|-----------------------------------------------------|
|-------------------------------------------------------|
| /api/administrator/organizations/organization |
| RETURNS--| EXCEPTIONS---------------------------------|
| object | invalid-organizationid |
| | * unspecified querystring organizationid |
| | * invalid querystring organizationid |
|----------|--------------------------------------------|
|------------------------------------------------------------------------------|
| /api/administrator/organizations/organizations |
| RECEIVES---------------------------------| RETURNS--| CONFIGURATION----------|
| optional querystring offset (integer) | array | environment PAGE_SIZE |
| optional querystring limit (integer) | | |
| optional querystring all (boolean) | | |
| optional querystring accountid (string) | | |
|------------------------------------------|----------|------------------------|
|-------------------------------------------------------|
| /api/administrator/organizations/organizations-count |
| RETURNS-----------------------------------------------|
| integer |
|-------------------------------------------------------|
|---------------------------------------------------------------------------------------------------|
| /api/user/organizations/create-invitation |
| RECEIVES-----------------------------| RETURNS--| EXCEPTIONS--------------------------------------|
| required posted secret-code | object | invalid-organizationid |
| required querystring organizationid | | * missing querystring organizationid |
| required posted secret-code | | * invalid querystring organizationid |
| | | invalid-secret-code |
| | | * missing posted secret-code |
| | | invalid-secret-code-length |
| | | * posted secret-code too short |
| | | * posted secret-code too long |
| | | invalid-account |
| | | * accessing account is not organization owner |
|--------------------------------------|----------|-------------------------------------------------|
|-----------------------------------------------------------------------------------------------------|
| /api/user/organizations/create-membership |
| RECEIVES---------------------------| RETURNS--| EXCEPTIONS------------------------------------------|
| required posted profileid | object | invalid-invitationid |
| required posted secret-code | | * missing querystring invitationid |
| required querystring invitationid | | * invalid querystring invitationid |
| required posted secret-code | | invalid-invitation |
| required posted profileid | | * querystring invitationid has been used |
| | | * posted secret-code has been used |
| | | * querystring invitationid is not open invitation |
| | | invalid-secret-code |
| | | * missing posted secret-code |
| | | * invalid posted secret-code |
| | | invalid-account |
| | | * accessing account is organization owner |
| | | * accessing account is organization member |
| | | invalid-profileid |
| | | * missing posted profileid |
| | | * invalid posted profileid |
| | | invalid-profile |
| | | * ineligible posted profileid is missing fields |
|------------------------------------|----------|-----------------------------------------------------|
|-------------------------------------------------------------------------------------------------|
| /api/user/organizations/create-organization |
| RECEIVES----------------------------| RETURNS--| EXCEPTIONS-------------------------------------|
| required posted profileid | object | invalid-organization-name |
| required posted email | | * missing posted name |
| required posted name | | invalid-organization-name-length |
| required posted organization-email | | * posted name too short |
| required posted organization-name | | * posted name too long |
| required posted profileid | | invalid-organization-email |
| | | * missing posted email |
| | | * invalid posted email |
| | | invalid-profile |
| | | * missing posted profileid |
| | | * invalid posted profileid |
| | | * ineligible posted profileid missing fields |
|-------------------------------------|----------|------------------------------------------------|
|-------------------------------------------------------------------------------------------------|
| /api/user/organizations/delete-invitation |
| RECEIVES---------------------------| RETURNS--| EXCEPTIONS--------------------------------------|
| required querystring invitationid | boolean | invalid-invitationid |
| | | * missing querystring invitationid |
| | | * invalid querystring invitationid |
| | | invalid-invitation |
| | | * querystring invitationid is used invitation |
| | | invalid-account |
| | | * accessing account is not organization owner |
|------------------------------------|----------|-------------------------------------------------|
|---------------------------------------------------------------------------------------------------------------|
| /api/user/organizations/delete-membership |
| RECEIVES---------------------------| RETURNS--| EXCEPTIONS----------------------------------------------------|
| required querystring membershipid | boolean | invalid-membershipid |
| | | * missing querystring membershipid |
| | | * invalid querystring membershipid |
| | | invalid-account |
| | | * accessing account is not membership or organization owner |
|------------------------------------|----------|---------------------------------------------------------------|
|---------------------------------------------------------------------------------------------------|
| /api/user/organizations/delete-organization |
| RECEIVES-----------------------------| RETURNS--| EXCEPTIONS--------------------------------------|
| required querystring organizationid | boolean | invalid-organizationid |
| | | * missing querystring organizationid |
| | | * invalid querystring organizationid |
| | | invalid-account |
| | | * accessing account does not own organization |
|--------------------------------------|----------|-------------------------------------------------|
|--------------------------------------------------------------------------------------|
| /api/user/organizations/invitation |
| RECEIVES---------------------------| RETURNS--| EXCEPTIONS---------------------------|
| required querystring invitationid | object | invalid-invitationid |
| | | * missing querystring invitationid |
| | | * invalid querystring invitationid |
| | | invalid-invitation |
| | | * querystring invitationid is used |
|------------------------------------|----------|--------------------------------------|
|-----------------------------------------------------------------------------------------------------------------------|
| /api/user/organizations/invitations |
| RECEIVES--------------------------------------| RETURNS--| EXCEPTIONS------------------------| CONFIGURATION----------|
| required querystring accountid | array | invalid-accountid | environment PAGE_SIZE |
| optional querystring offset (integer) | | * missing querystring accountid | |
| optional querystring limit (integer) | | * invalid querystring accountid | |
| optional querystring all (boolean) | | invalid-account | |
| optional querystring organizationid (string) | | * ineligible accessing account | |
|-----------------------------------------------|----------|-----------------------------------|------------------------|
|--------------------------------------------------------------------------------|
| /api/user/organizations/invitations-count |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS------------------------|
| required querystring accountid | integer | invalid-accountid |
| | | * missing querystring accountid |
| | | * invalid querystring accountid |
| | | invalid-account |
| | | * ineligible accessing account |
|---------------------------------|----------|-----------------------------------|
|------------------------------------------------------------------------------------------------------------|
| /api/user/organizations/membership |
| RECEIVES---------------------------| RETURNS--| EXCEPTIONS-------------------------------------------------|
| required querystring membershipid | object | invalid-membershipid |
| | | * missing querystring membershipid |
| | | * invalid querystring membershipid |
| | | invalid-account |
| | | * accessing account must be organization member or owner |
|------------------------------------|----------|------------------------------------------------------------|
|-----------------------------------------------------------------------------------------------------------------------|
| /api/user/organizations/memberships |
| RECEIVES--------------------------------------| RETURNS--| EXCEPTIONS------------------------| CONFIGURATION----------|
| required querystring accountid | array | invalid-accountid | environment PAGE_SIZE |
| optional querystring offset (integer) | | * missing querystring accountid | |
| optional querystring limit (integer) | | * invalid querystring accountid | |
| optional querystring all (boolean) | | invalid-account | |
| optional querystring organizationid (string) | | * ineligible accessing account | |
|-----------------------------------------------|----------|-----------------------------------|------------------------|
|--------------------------------------------------------------------------------|
| /api/user/organizations/memberships-count |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS------------------------|
| required querystring accountid | integer | invalid-accountid |
| | | * missing querystring accountid |
| | | * invalid querystring accountid |
| | | invalid-account |
| | | * ineligible accessing account |
|---------------------------------|----------|-----------------------------------|
|--------------------------------------------------------------------------------------------------------|
| /api/user/organizations/open-invitation |
| RECEIVES---------------------------| RETURNS--| REDACTS---------| EXCEPTIONS---------------------------|
| required querystring invitationid | object | secretCodeHash | invalid-invitationid |
| | | | * missing querystring invitationid |
| | | | * invalid querystring invitationid |
| | | | invalid-invitation |
| | | | * querystring invitationid is used |
|------------------------------------|----------|-----------------|--------------------------------------|
|-----------------------------------------------------------------------------------------------------|
| /api/user/organizations/organization |
| RECEIVES-----------------------------| RETURNS--| EXCEPTIONS----------------------------------------|
| required querystring organizationid | object | invalid-organizationid |
| | | * missing querystring organizationid |
| | | * invalid querystring organizationid |
| | | invalid-account |
| | | * accessing account must be organization member |
|--------------------------------------|----------|---------------------------------------------------|
|-----------------------------------------------------------------------------------------------------|
| /api/user/organizations/organization-membership |
| RECEIVES-----------------------------| RETURNS--| EXCEPTIONS----------------------------------------|
| required querystring organizationid | object | invalid-organizationid |
| | | * missing querystring organizationid |
| | | * invalid querystring organizationid |
| | | invalid-account |
| | | * accessing account must be organization member |
|--------------------------------------|----------|---------------------------------------------------|
|----------------------------------------------------------------------------------------------------------------|
| /api/user/organizations/organizations |
| RECEIVES-------------------------------| RETURNS--| EXCEPTIONS------------------------| CONFIGURATION----------|
| required querystring accountid | array | invalid-accountid | environment PAGE_SIZE |
| optional querystring offset (integer) | | * missing querystring accountid | |
| optional querystring limit (integer) | | * invalid querystring accountid | |
| optional querystring all (boolean) | | invalid-account | |
| | | * ineligible accessing account | |
|----------------------------------------|----------|-----------------------------------|------------------------|
|--------------------------------------------------------------------------------|
| /api/user/organizations/organizations-count |
| RECEIVES------------------------| RETURNS--| EXCEPTIONS------------------------|
| required querystring accountid | integer | invalid-accountid |
| | | * missing querystring accountid |
| | | * invalid querystring accountid |
| | | invalid-account |
| | | * ineligible accessing account |
|---------------------------------|----------|-----------------------------------|
|---------------------------------------------------------------------------------------------------|
| /api/user/organizations/set-organization-owner |
| RECEIVES-----------------------------| RETURNS--| EXCEPTIONS--------------------------------------|
| required querystring organizationid | object | invalid-organizationid |
| | | * missing querystring organizationid |
| | | * invalid querystring organizationid |
| | | invalid-accountid |
| | | * posted accountid is missing |
| | | * posted accountid is invalid |
| | | invalid-account |
| | | * accessing account is not organization owner |
| | | * posted accountid is organization owner |
| | | * posted accountid is not member |
|--------------------------------------|----------|-------------------------------------------------|
|---------------------------------------------------------------------------------------------------|
| /api/user/organizations/update-organization |
| RECEIVES-----------------------------| RETURNS--| EXCEPTIONS--------------------------------------|
| required posted email | object | invalid-organizationid |
| required posted name | | * missing querystring organizationid |
| required querystring organizationid | | * invalid querystring organizationid |
| required posted name | | invalid-account |
| required posted email | | * accessing account is not organization owner |
| | | invalid-organization-name |
| | | * missing posted name |
| | | invalid-organization-name-length |
| | | * posted name is too short |
| | | * posted name is too long |
| | | invalid-organization-email |
| | | * missing posted email |
| | | * invalid posted email |
|--------------------------------------|----------|-------------------------------------------------|