This repository has been archived by the owner on Jun 23, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 107
/
api.yaml
424 lines (421 loc) · 12.7 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
openapi: 3.0.0
info:
title:
Fn::Sub: realworld-serverless-application-backend-${Stage}
description: A simplified implementation of AWS Serverless Application Repository
version: 2019-10-13
# Enable request validator. See doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-validation-sample-api-swagger.html
x-amazon-apigateway-request-validators:
all:
validateRequestBody: true
validateRequestParameters: true
x-amazon-apigateway-request-validator: all
x-amazon-apigateway-gateway-responses:
# Provide more detailed error message for bad request body errors. See doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-gateway-responses.html
BAD_REQUEST_BODY:
responseTemplates:
application/json: '{"errorCode": "BadRequestBody", "message": "$context.error.validationErrorString"}'
responseParameters:
gatewayresponse.header.Access-Control-Allow-Origin: "'*'"
DEFAULT_4XX:
responseParameters:
gatewayresponse.header.Access-Control-Allow-Origin: "'*'"
DEFAULT_5XX:
responseParameters:
gatewayresponse.header.Access-Control-Allow-Origin: "'*'"
paths:
/applications:
post:
operationId: CreateApplication
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/CreateApplicationInput"
required: true
responses:
"201":
description: "Successfully Created an application."
content:
application/json:
schema:
$ref: "#/components/schemas/Application"
"400":
description: "Bad Request Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/BadRequestException"
"401":
description: "Unauthorized Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/UnauthorizedException"
"409":
description: "Conflict Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/ConflictException"
"429":
description: "Too Many Requests Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/TooManyRequestsException"
"500":
description: "Internal Server Error"
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerErrorException"
x-amazon-apigateway-integration:
uri:
Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${ApiLambda.Arn}:live/invocations
httpMethod: POST
type: aws_proxy
passthroughBehavior: never
security:
- cognitoAuthorizer: []
get:
operationId: ListApplications
parameters:
- name: nextToken
in: query
required: false
schema:
type: string
- name: maxItems
in: query
required: false
schema:
type: integer
minimum: 1
maximum: 100
responses:
"200":
description: "Successfully list applications"
content:
application/json:
schema:
$ref: "#/components/schemas/ApplicationList"
"400":
description: "Bad Request Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/BadRequestException"
"401":
description: "Unauthorized Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/UnauthorizedException"
"429":
description: "Too Many Requests Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/TooManyRequestsException"
"500":
description: "Internal Server Error"
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerErrorException"
x-amazon-apigateway-integration:
uri:
Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${ApiLambda.Arn}:live/invocations
httpMethod: POST
type: aws_proxy
passthroughBehavior: never
security:
- cognitoAuthorizer: []
"/applications/{applicationId}":
get:
operationId: GetApplication
parameters:
- name: applicationId
in: path
required: true
schema:
type: string
pattern: ^[a-zA-Z0-9\-]{3,128}$
responses:
"200":
description: "Successfully get an application"
content:
application/json:
schema:
$ref: "#/components/schemas/Application"
"400":
description: "Bad Request Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/BadRequestException"
"401":
description: "Unauthorized Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/UnauthorizedException"
"404":
description: "Not Found Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundException"
"429":
description: "Too Many Requests Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/TooManyRequestsException"
"500":
description: "Internal Server Error"
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerErrorException"
x-amazon-apigateway-integration:
uri:
Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${ApiLambda.Arn}:live/invocations
httpMethod: POST
type: aws_proxy
passthroughBehavior: never
security:
- cognitoAuthorizer: []
patch:
operationId: UpdateApplication
parameters:
- name: applicationId
in: path
required: true
schema:
type: string
pattern: ^[a-zA-Z0-9\-]{3,128}$
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateApplicationInput"
required: true
responses:
"200":
description: "Successfully update an application"
content:
application/json:
schema:
$ref: "#/components/schemas/Application"
"400":
description: "Bad Request Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/BadRequestException"
"401":
description: "Unauthorized Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/UnauthorizedException"
"404":
description: "Not Found Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundException"
"429":
description: "Too Many Requests Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/TooManyRequestsException"
"500":
description: "Internal Server Error"
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerErrorException"
x-amazon-apigateway-integration:
uri:
Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${ApiLambda.Arn}:live/invocations
httpMethod: POST
type: aws_proxy
passthroughBehavior: never
security:
- cognitoAuthorizer: []
delete:
operationId: DeleteApplication
parameters:
- name: applicationId
in: path
required: true
schema:
type: string
pattern: ^[a-zA-Z0-9\-]{3,128}$
responses:
"204":
description: "Successfully delete an application"
"400":
description: "Bad Request Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/BadRequestException"
"401":
description: "Unauthorized Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/UnauthorizedException"
"404":
description: "Not Found Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundException"
"429":
description: "Too Many Requests Exception"
content:
application/json:
schema:
$ref: "#/components/schemas/TooManyRequestsException"
"500":
description: "Internal Server Error"
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerErrorException"
x-amazon-apigateway-integration:
uri:
Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${ApiLambda.Arn}:live/invocations
httpMethod: POST
type: aws_proxy
passthroughBehavior: never
security:
- cognitoAuthorizer: []
components:
securitySchemes:
cognitoAuthorizer:
type: apiKey
name: Authorization
in: header
x-amazon-apigateway-authtype: cognito_user_pools
x-amazon-apigateway-authorizer:
providerARNs:
- Fn::GetAtt: ApplicationsApiUserPool.Arn
type: cognito_user_pools
schemas:
BadRequestException:
type: object
properties:
message:
type: string
errorCode:
type: string
UnauthorizedException:
type: object
properties:
message:
type: string
errorCode:
type: string
NotFoundException:
type: object
properties:
message:
type: string
errorCode:
type: string
ConflictException:
type: object
properties:
message:
type: string
errorCode:
type: string
TooManyRequestsException:
type: object
properties:
message:
type: string
errorCode:
type: string
InternalServerErrorException:
type: object
properties:
message:
type: string
errorCode:
type: string
CreateApplicationInput:
type: object
required:
- applicationId
- description
- author
properties:
applicationId:
type: string
pattern: ^[a-zA-Z0-9\-]{3,128}$
description:
type: string
minLength: 3
maxLength: 256
author:
type: string
pattern: ^[a-zA-Z0-9\-]{1,128}$
homePageUrl:
type: string
pattern: ^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/)?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$
UpdateApplicationInput:
type: object
properties:
description:
type: string
minLength: 3
maxLength: 256
author:
type: string
pattern: ^[a-zA-Z0-9\-]{1,128}$
homePageUrl:
type: string
pattern: ^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/)?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$
Application:
type: object
required:
- applicationId
- description
- author
properties:
applicationId:
type: string
description:
type: string
author:
type: string
creationTime:
type: string
homePageUrl:
type: string
ApplicationSummary:
type: object
properties:
applicationId:
type: string
description:
type: string
creationTime:
type: string
ApplicationList:
type: object
properties:
applications:
type: array
items:
$ref: "#/components/schemas/ApplicationSummary"
nextToken:
type: string