forked from openedx/enterprise-access
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.yaml
385 lines (385 loc) · 12.1 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
# 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"
"202":
statusCode: "202"
"401":
statusCode: "401"
"403":
statusCode: "403"
"404":
statusCode: "404"
"422":
statusCode: "422"
"429":
statusCode: "429"
"500":
statusCode: "500"
default:
statusCode: "400"
learner_content_assignment_list_remind_cancel_responses:
"200":
description: OK
"400":
description: Bad Request
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Not Found
"422":
description: Not Cancellable
"500":
description: Internal Server Error
learner_content_assignment_allocate_responses:
"202":
description: Accepted
"400":
description: Bad Request
"401":
description: Unauthorized
"404":
description: Not Found
"500":
description: Internal Server Error
assignment_configuration_uuid:
name: assignment_configuration_uuid
in: path
required: true
type: string
auth_header:
name: Authorization
in: header
required: true
type: string
definitions:
LearnerContentAssignmentActionRequest:
type: object
properties:
assignment_uuids:
type: array
description: List of assignment uuids
items:
type: string
description: assignment uuid
PolicyAllocationRequestBody:
type: object
properties:
learner_emails:
type: array
description: Learner emails to whom LearnerContentAssignments should be allocated.
required: true
items:
type: string
description: email of a learner
content_key:
type: string
description: Course content_key to which these learners are assigned.
required: true
content_price_cents:
type: integer
description: The price, in USD cents, of this content at the time of allocation.
Must be >= 0.
required: true
endpoints:
v1:
subsidyAccessPolicyAllocation:
post:
description: creates or updates allocated LearnerContentAssignment records for a
requested list of user email addresses, in the requested content_key
and at the requested price of content_price_cents
operationId: api_v1_policy_allocation_allocate_create
consumes:
- application/json
produces:
- application/json
parameters:
- name: Authorization
in: header
required: true
type: string
- in: path
name: policy_uuid
type: string
description: The uuid that uniquely identifies this policy record.
required: true
- name: PolicyAllocationRequestBody
in: body
description: Contains learner emails, content keys and price
required: true
schema:
type: array
items:
$ref: "#/definitions/PolicyAllocationRequestBody"
responses:
"202":
description: Accepted
"400":
description: Bad Request
"401":
description: Unauthorized
"404":
description: Not Found
"500":
description: Internal Server Error
x-amazon-apigateway-integration:
responses:
"200":
statusCode: "200"
"201":
statusCode: "201"
"202":
statusCode: "202"
"401":
statusCode: "401"
"403":
statusCode: "403"
"404":
statusCode: "404"
"422":
statusCode: "422"
"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.policy_uuid: method.request.path.policy_uuid
uri: https://${stageVariables.enterprise_access_host}/api/v1/policy-allocation/{policy_uuid}/allocate/
learnerContentAssignmentRemindRequest:
post:
description: Send reminders to a list of learners with associated
``LearnerContentAssignment`` record by list of uuids.
operationId: api_v1_assignment_configurations_admin_assignments_remind_create
consumes:
- application/json
produces:
- application/json
parameters:
- name: Authorization
in: header
required: true
type: string
- name: assignment_configuration_uuid
in: path
required: true
type: string
- name: LearnerContentAssignmentRemindRequest
in: body
description: Single or multiple assignment_uuids in the array
required: true
schema:
type: array
items:
$ref: "#/definitions/LearnerContentAssignmentActionRequest"
responses:
"200":
description: OK
"400":
description: Bad Request
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Not Found
"422":
description: Not Cancellable
"500":
description: Internal Server Error
x-amazon-apigateway-integration:
responses:
"200":
statusCode: "200"
"201":
statusCode: "201"
"202":
statusCode: "202"
"401":
statusCode: "401"
"403":
statusCode: "403"
"404":
statusCode: "404"
"422":
statusCode: "422"
"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.assignment_configuration_uuid: method.request.path.assignment_configuration_uuid
uri: https://${stageVariables.enterprise_access_host}/api/v1/assignment-configurations/{assignment_configuration_uuid}/admin/assignments/remind/
learnerContentAssignmentCancelRequest:
post:
description: Cancel a list of ``LearnerContentAssignment`` records by uuid
operationId: api_v1_assignment_configurations_admin_assignments_cancel_create
consumes:
- application/json
produces:
- application/json
parameters:
- name: Authorization
in: header
required: true
type: string
- name: assignment_configuration_uuid
in: path
required: true
type: string
- name: LearnerContentAssignmentActionRequest
in: body
description: Single or multiple assignment_uuids in the array
required: true
schema:
type: array
items:
$ref: "#/definitions/LearnerContentAssignmentActionRequest"
responses:
"200":
description: OK
"400":
description: Bad Request
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Not Found
"422":
description: Not Cancellable
"500":
description: Internal Server Error
x-amazon-apigateway-integration:
responses:
"200":
statusCode: "200"
"201":
statusCode: "201"
"202":
statusCode: "202"
"401":
statusCode: "401"
"403":
statusCode: "403"
"404":
statusCode: "404"
"422":
statusCode: "422"
"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.assignment_configuration_uuid: method.request.path.assignment_configuration_uuid
uri: https://${stageVariables.enterprise_access_host}/api/v1/assignment-configurations/{assignment_configuration_uuid}/admin/assignments/cancel/
subsidyAccessPolicies:
get:
description: Lists SubsidyAccessPolicy records, filtered by the given query
parameters.
operationId: api_v1_subsidy_access_policies_list
consumes:
- application/json
produces:
- application/json
parameters:
- name: Authorization
in: header
required: true
type: string
- in: query
name: active
type: boolean
description: Set to FALSE to deactivate and hide this policy. Use this when you
want to disable redemption and make it disappear from all
frontends, effectively soft-deleting it. Default is False
(deactivated).
required: false
- in: query
name: enterprise_customer_uuid
type: string
description: The owning Enterprise Customer's UUID. Cannot be blank or null.
required: true
- in: query
name: page
type: integer
description: A page number within the paginated result set.
required: false
- in: query
name: page_size
type: integer
description: Number of results to return per page.
required: false
- in: query
name: policy_type
type: string
description: The type of this policy (e.g. the name of an access policy proxy
model).
required: false
responses:
"200":
description: OK
"400":
description: Bad Request
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: Not Found
"422":
description: Not Cancellable
"500":
description: Internal Server Error
x-amazon-apigateway-integration:
responses:
"200":
statusCode: "200"
"201":
statusCode: "201"
"202":
statusCode: "202"
"401":
statusCode: "401"
"403":
statusCode: "403"
"404":
statusCode: "404"
"422":
statusCode: "422"
"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.active: method.request.querystring.active
integration.request.querystring.enterprise_customer_uuid: method.request.querystring.enterprise_customer_uuid
integration.request.querystring.page: method.request.querystring.page
integration.request.querystring.page_size: method.request.querystring.page_size
integration.request.querystring.policy_type: method.request.querystring.policy_type
uri: https://${stageVariables.enterprise_access_host}/api/v1/subsidy-access-policies/