forked from openedx/edx-enterprise-data
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.yaml
178 lines (177 loc) · 5.79 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
# 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_with_mapping_template_for_uuid:
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
}
statusCode: "200"
401:
statusCode: "401"
403:
statusCode: "403"
404:
statusCode: "404"
429:
statusCode: "429"
500:
statusCode: "500"
default:
statusCode: "400"
auth_header:
in: header
name: Authorization
required: true
type: string
endpoints:
v1:
enterpriseCustomerLearnerSummary:
get:
operationId: get_enterprise_customer_learner_summary
parameters:
-
in: header
name: Authorization
required: true
type: string
-
in: path
name: uuid
required: true
type: string
-
in: query
name: page
required: false
type: number
-
in: query
name: page_size
required: false
type: number
produces:
- application/json
- application/csv
responses:
200:
description: OK
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:
httpMethod: GET
requestParameters:
integration.request.header.Authorization: method.request.header.Authorization
integration.request.path.uuid: method.request.path.uuid
integration.request.querystring.page: method.request.querystring.page
integration.request.querystring.page_size: method.request.querystring.page_size
responses:
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
}
statusCode: "200"
401:
statusCode: "401"
403:
statusCode: "403"
404:
statusCode: "404"
429:
statusCode: "429"
500:
statusCode: "500"
default:
statusCode: "400"
type: http
uri: "https://${stageVariables.analytics_api_host}/enterprise/api/v0/enterprise/{uuid}/enrollments/"
page_qs_parameter:
in: query
name: page
required: false
type: number
page_size_qs_parameter:
in: query
name: page_size
required: false
type: number
produces:
- application/json
- application/csv
responses:
200:
description: OK
400:
description: "Bad Request"
401:
description: Unauthorized
403:
description: Forbidden
404:
description: "Not Found"
429:
description: "Too Many Requests"
500:
description: "Internal Server Error"
uuid_parameter:
in: path
name: uuid
required: true
type: string
x-amazon-apigateway-integration-enterprise-customer-learner-summary:
httpMethod: GET
requestParameters:
integration.request.header.Authorization: method.request.header.Authorization
integration.request.path.uuid: method.request.path.uuid
integration.request.querystring.page: method.request.querystring.page
integration.request.querystring.page_size: method.request.querystring.page_size
responses:
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
}
statusCode: "200"
401:
statusCode: "401"
403:
statusCode: "403"
404:
statusCode: "404"
429:
statusCode: "429"
500:
statusCode: "500"
default:
statusCode: "400"
type: http