-
Notifications
You must be signed in to change notification settings - Fork 28
/
api.yaml
508 lines (505 loc) · 14.3 KB
/
api.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
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
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
# This file is a "de-compacted" version of api-compact.yaml. The consuming tools are unable to process YAML anchors.
# This file was generated using http://www.yamllint.com/.
---
apigateway_responses:
"200":
statusCode: "200"
"201":
statusCode: "201"
"401":
statusCode: "401"
"403":
statusCode: "403"
"404":
statusCode: "404"
"429":
statusCode: "429"
"500":
statusCode: "500"
default:
statusCode: "400"
apigateway_get_responses:
"200":
statusCode: "200"
"301":
statusCode: "301"
"401":
statusCode: "401"
"403":
statusCode: "403"
"404":
statusCode: "404"
"429":
statusCode: "429"
"500":
statusCode: "500"
default:
statusCode: "400"
bulk_revoke_apigateway_responses:
"204":
statusCode: "204"
"401":
statusCode: "401"
"403":
statusCode: "403"
"404":
statusCode: "404"
"429":
statusCode: "429"
"500":
statusCode: "500"
default:
statusCode: "400"
apigateway_responses_with_mapping_template_for_uuid:
"200":
statusCode: "200"
responseTemplates:
application/json: >
#set($inputRoot = $input.path('$')) #set($host =
$stageVariables.gateway_host) #set($uuid = $input.params('uuid'))
#set($URLMatchRegex = "(^https?://)[^/]*[^?]*(.*$)") #set($updatedURL = "$1$host$context.resourcePath$2") #set($resourceUuidMatch = "{uuid}")
{
"count": $inputRoot.count,
"next": "$inputRoot.next.replaceAll($URLMatchRegex, $updatedURL).replace($resourceUuidMatch, $uuid)",
"previous": "$inputRoot.previous.replaceAll($URLMatchRegex, $updatedURL).replace($resourceUuidMatch, $uuid)",
"results": $inputRoot.results
}
"401":
statusCode: "401"
"403":
statusCode: "403"
"404":
statusCode: "404"
"429":
statusCode: "429"
"500":
statusCode: "500"
default:
statusCode: "400"
responses:
"200":
description: OK
"201":
description: Created
"400":
description: Bad Request
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Not Found
"429":
description: Too Many Requests
"500":
description: Internal Server Error
get_responses:
"200":
description: OK
"301":
description: Moved Permanently
"400":
description: Bad Request
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Not Found
"429":
description: Too Many Requests
"500":
description: Internal Server Error
bulk_revoke_responses:
"204":
description: No Content - All revocations were successful
"400":
description: Bad Request
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Not Found
"429":
description: Too Many Requests
"500":
description: Internal Server Error
produces:
- application/json
- application/csv
enterprise_customer_uuid_qs_param:
in: query
name: enterprise_customer_uuid
required: true
type: string
enterprise_customer_uuid_qs_param_optional:
in: query
name: enterprise_customer_uuid
required: false
type: string
enroll_all_qs_param:
in: query
name: enroll_all
required: false
type: string
subscription_uuid_qs_param:
in: query
name: subscription_uuid
required: false
type: string
uuid:
name: uuid
in: path
required: true
type: string
auth_header:
name: Authorization
in: header
required: true
type: string
endpoints:
v1:
assignLicenses:
post:
description: Assigns a license to given user emails and sends an activation email.
operationId: assign_licenses
consumes:
- application/json
produces:
- application/json
parameters:
- name: Authorization
in: header
required: true
type: string
- name: uuid
in: path
required: true
type: string
- name: data
in: body
description: User emails, sfids, and email content.
required: true
schema:
type: array
items:
type: object
properties:
user_emails:
description: List of emails to assign licenses.
type: array
required: true
items:
type: string
description: user email
user_sfids:
description: List of salesforce user ids to assign licenses.
type: array
items:
type: string
description: user's salesforce opportunity id
greeting:
description: Email template closing e.g Hello.
type: string
closing:
description: Email template closing e.g Goodbye.
type: string
notify_users:
description: Send license assignment email or not.
type: boolean
responses:
"200":
description: OK
"201":
description: Created
"400":
description: Bad Request
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Not Found
"429":
description: Too Many Requests
"500":
description: Internal Server Error
x-amazon-apigateway-integration:
responses:
"200":
statusCode: "200"
"201":
statusCode: "201"
"401":
statusCode: "401"
"403":
statusCode: "403"
"404":
statusCode: "404"
"429":
statusCode: "429"
"500":
statusCode: "500"
default:
statusCode: "400"
httpMethod: POST
type: http
requestParameters:
integration.request.header.Authorization: method.request.header.Authorization
integration.request.path.uuid: method.request.path.uuid
uri: https://${stageVariables.license_manager_host}/api/v1/subscriptions/{uuid}/licenses/assign/
revokeLicenses:
post:
description: Revokes one or more licenses in a subscription plan
operationId: revoke_licenses
consumes:
- application/json
produces:
- application/json
parameters:
- name: Authorization
in: header
required: true
type: string
- name: uuid
in: path
required: true
type: string
- name: RequestPayload
in: body
description: User emails OR search filters for emails and status
required: true
schema:
type: array
items:
$ref: "#/definitions/RequestPayload"
responses:
"204":
description: No Content - All revocations were successful
"400":
description: Bad Request
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Not Found
"429":
description: Too Many Requests
"500":
description: Internal Server Error
x-amazon-apigateway-integration:
responses:
"204":
statusCode: "204"
"401":
statusCode: "401"
"403":
statusCode: "403"
"404":
statusCode: "404"
"429":
statusCode: "429"
"500":
statusCode: "500"
default:
statusCode: "400"
httpMethod: POST
type: http
requestParameters:
integration.request.header.Authorization: method.request.header.Authorization
integration.request.path.uuid: method.request.path.uuid
uri: https://${stageVariables.license_manager_host}/api/v1/subscriptions/{uuid}/licenses/bulk-revoke/
bulkLicenseEnrollment:
post:
description: Enrolls a list of learners in a given list of courses after
verifying license subsidies.
operationId: bulk_license_enrollment
consumes:
- application/json
produces:
- application/json
parameters:
- name: Authorization
in: header
required: true
type: string
- in: query
name: enterprise_customer_uuid
required: true
type: string
- in: query
name: enroll_all
required: false
type: string
- in: query
name: subscription_uuid
required: false
type: string
- name: payload
in: body
description: User emails and course run keys along with a notify learners flag
required: true
schema:
type: array
items:
type: object
properties:
emails:
description: list of learner emails
type: array
required: true
items:
type: string
description: user email
course_run_keys:
description: list of courses to enroll learners into
type: array
required: true
items:
type: string
description: course run key
notify:
description: Whether to notify learner of their enrollment
type: boolean
required: true
responses:
"200":
description: OK
"201":
description: Created
"400":
description: Bad Request
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Not Found
"429":
description: Too Many Requests
"500":
description: Internal Server Error
x-amazon-apigateway-integration:
responses:
"200":
statusCode: "200"
"201":
statusCode: "201"
"401":
statusCode: "401"
"403":
statusCode: "403"
"404":
statusCode: "404"
"429":
statusCode: "429"
"500":
statusCode: "500"
default:
statusCode: "400"
httpMethod: POST
type: http
requestParameters:
integration.request.header.Authorization: method.request.header.Authorization
integration.request.querystring.enterprise_customer_uuid: method.request.querystring.enterprise_customer_uuid
integration.request.querystring.enroll_all: method.request.querystring.enroll_all
integration.request.querystring.subscription_uuid: method.request.querystring.subscription_uuid
uri: https://${stageVariables.license_manager_host}/api/v1/bulk-license-enrollment
subscriptionsList:
get:
operationId: subscriptions_summary_endpoint
description: Returns a list of subscription plans for a customer
consumes:
- application/json
produces:
- application/json
parameters:
- name: Authorization
in: header
required: true
type: string
- in: query
name: enterprise_customer_uuid
required: false
type: string
- name: page
in: query
required: false
type: integer
- name: current
in: query
required: false
type: string
responses:
"200":
description: OK
"301":
description: Moved Permanently
"400":
description: Bad Request
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Not Found
"429":
description: Too Many Requests
"500":
description: Internal Server Error
x-amazon-apigateway-integration:
responses:
"200":
statusCode: "200"
"301":
statusCode: "301"
"401":
statusCode: "401"
"403":
statusCode: "403"
"404":
statusCode: "404"
"429":
statusCode: "429"
"500":
statusCode: "500"
default:
statusCode: "400"
httpMethod: GET
type: http
requestParameters:
integration.request.header.Authorization: method.request.header.Authorization
integration.request.querystring.enterprise_customer_uuid: method.request.querystring.enterprise_customer_uuid
integration.request.querystring.page: method.request.querystring.page
integration.request.querystring.current: method.request.querystring.current
uri: https://${stageVariables.license_manager_host}/api/v1/subscriptions/
definitions:
BulkRevokeFilters:
type: object
properties:
user_email:
type: string
description: User email filter
status_in:
type: array
description: Array of valid license statuses
items:
type: string
description: status of the license
description: Values provided to perform filtering against.
RequestPayload:
type: object
properties:
user_emails:
type: array
description: List of emails with which licenses are associated
items:
type: string
description: user email
filters:
type: array
description: Filters for lookup and filtering of licenses to revoke.
items:
$ref: "#/definitions/BulkRevokeFilters"