-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathtranslate-API-translatetext-oas30-apigateway.yaml
389 lines (389 loc) · 11.7 KB
/
translate-API-translatetext-oas30-apigateway.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
openapi: "3.0.1"
info:
title: "translate-API"
description: "API that takes a transcript file in srt format and translates it into\
\ a target language. The file is taken from an aws s3 bucket, which must have\
\ read permissions and its defined an a enviroment variable called [bucket] defined\
\ in al lambda function(translate-function) . A lambda function is executed that\
\ receives 2 query string parameters, [TargetLang] as the target language and\
\ [Bucketkey] as the file name."
contact:
name: "Skillshare Mentorship"
email: "hello@skillshare.com"
version: "2020-06-11T21:51:45Z"
servers:
- url: "https://ytuln8zsz1.execute-api.us-east-1.amazonaws.com/{basePath}"
variables:
basePath:
default: "/translatetext"
paths:
/:
get:
description: "Gets a JSON format translated into a target language, for an SRT\
\ file of a source language transcript\nJSON format:\n\tindex: integer,\n\t\
start: hh: mm: ss, ms -> hh: mm: ss, ms,\n\t content: Text Translated"
parameters:
- name: "Bucketkey"
in: "query"
description: "name of s3 file, Bucket Key"
required: true
schema:
type: "string"
- name: "TargetLang"
in: "query"
description: "Target language to translate Text"
required: true
schema:
type: "string"
responses:
404:
description: "Bad QueryString Parameter:Video transcription file not found\
\ or Translation was not possible"
headers:
Access-Control-Allow-Origin:
description: "console.aws.amazon.com"
schema:
type: "string"
body:
description: "Bad QueryString Parameter:Video transcription file not\
\ found or Translation was not possible"
schema:
type: "string"
targetKey:
description: "translated s3 resource name"
schema:
type: "string"
Content-Type:
description: "Always application/json"
schema:
type: "string"
status:
description: "Not Found"
schema:
type: "string"
content: {}
200:
description: "OK"
headers:
Access-Control-Allow-Origin:
description: "console.aws.amazon.com"
schema:
type: "string"
body:
description: "Object JSON format with the text translated into the target\
\ language"
schema:
type: "string"
targetKey:
description: "translated s3 resource name"
schema:
type: "string"
Content-Type:
description: "Always application/json"
schema:
type: "string"
status:
description: "OK"
schema:
type: "string"
content: {}
500:
description: "An error occurred executing the aws Translate service"
headers:
Access-Control-Allow-Origin:
description: "console.aws.amazon.com"
schema:
type: "string"
body:
description: "Internal Error"
schema:
type: "string"
targetKey:
description: "translated s3 resource name"
schema:
type: "string"
Content-Type:
description: "Always application/json"
schema:
type: "string"
status:
description: "Internal Error"
schema:
type: "string"
content: {}
412:
description: "Video language not soported"
headers:
Access-Control-Allow-Origin:
description: "console.aws.amazon.com"
schema:
type: "string"
body:
description: "Video language not soported"
schema:
type: "string"
targetKey:
description: "translated s3 resource name"
schema:
type: "string"
Content-Type:
description: "Always application/json"
schema:
type: "string"
status:
description: "Precondition Failed"
schema:
type: "string"
content: {}
x-amazon-apigateway-request-validator: "Validate body, query string parameters,\
\ and headers"
x-amazon-apigateway-integration:
uri: "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:017784105438:function:translate-function/invocations"
responses:
default:
statusCode: "200"
passthroughBehavior: "when_no_match"
httpMethod: "POST"
contentHandling: "CONVERT_TO_TEXT"
type: "aws_proxy"
components: {}
x-amazon-apigateway-documentation:
version: "1.3"
createdDate: "2020-06-12T00:13:52Z"
documentationParts:
- location:
type: "API"
properties:
title: "translate-API"
version: "1.0"
info:
description: "API that takes a transcript file in srt format and translates\
\ it into a target language. The file is taken from an aws s3 bucket, which\
\ must have read permissions and its defined an a enviroment variable called\
\ [bucket] defined in al lambda function(translate-function) . A lambda\
\ function is executed that receives 2 query string parameters, [TargetLang]\
\ as the target language and [Bucketkey] as the file name."
contact:
name: "Skillshare Mentorship"
email: "hello@skillshare.com"
- location:
type: "METHOD"
method: "GET"
properties:
description: "Gets a JSON format translated into a target language, for an SRT\
\ file of a source language transcript\nJSON format:\n\tindex: integer,\n\t\
start: hh: mm: ss, ms -> hh: mm: ss, ms,\n\t content: Text Translated"
consumes: "ytuln8zsz1.execute-api.us-east-1.amazonaws.com/translatetext"
produced: "application/json"
- location:
type: "QUERY_PARAMETER"
method: "GET"
name: "Bucketkey"
properties:
description: "name of s3 file, Bucket Key"
- location:
type: "QUERY_PARAMETER"
method: "GET"
name: "TargetLang"
properties:
description: "Target language to translate Text"
- location:
type: "RESOURCE"
properties:
properties:
description: "The root resource with the default path specification."
- location:
type: "RESPONSE"
method: "GET"
statusCode: "200"
properties:
description: "OK"
- location:
type: "RESPONSE"
method: "GET"
statusCode: "404"
properties:
description: "Bad QueryString Parameter:Video transcription file not found or\
\ Translation was not possible"
- location:
type: "RESPONSE"
method: "GET"
statusCode: "412"
properties:
description: "Video language not soported"
- location:
type: "RESPONSE"
method: "GET"
statusCode: "500"
properties:
description: "An error occurred executing the aws Translate service"
- location:
type: "RESPONSE_BODY"
method: "GET"
statusCode: "200"
properties:
description: "JSON Object with SRT s3 file Translated Text to target language"
- location:
type: "RESPONSE_BODY"
method: "GET"
statusCode: "404"
properties:
description: "Bad QueryString Parameter:Video transcription file not found or\
\ Translation was not possible"
- location:
type: "RESPONSE_BODY"
method: "GET"
statusCode: "412"
properties:
description: "Video language not soported"
- location:
type: "RESPONSE_BODY"
method: "GET"
statusCode: "500"
properties:
description: "Internal Error: None []"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "200"
name: "Access-Control-Allow-Origin"
properties:
description: "console.aws.amazon.com"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "404"
name: "Access-Control-Allow-Origin"
properties:
description: "console.aws.amazon.com"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "412"
name: "Access-Control-Allow-Origin"
properties:
description: "console.aws.amazon.com"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "500"
name: "Access-Control-Allow-Origin"
properties:
description: "console.aws.amazon.com"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "200"
name: "Content-Type"
properties:
description: "Always application/json"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "404"
name: "Content-Type"
properties:
description: "Always application/json"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "412"
name: "Content-Type"
properties:
description: "Always application/json"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "500"
name: "Content-Type"
properties:
description: "Always application/json"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "200"
name: "body"
properties:
description: "Object JSON format with the text translated into the target language"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "404"
name: "body"
properties:
description: "Bad QueryString Parameter:Video transcription file not found or\
\ Translation was not possible"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "412"
name: "body"
properties:
description: "Video language not soported"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "500"
name: "body"
properties:
description: "Internal Error"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "200"
name: "status"
properties:
description: "OK"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "404"
name: "status"
properties:
description: "Not Found"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "412"
name: "status"
properties:
description: "Precondition Failed"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "500"
name: "status"
properties:
description: "Internal Error"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "200"
name: "targetKey"
properties:
description: "translated s3 resource name"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "404"
name: "targetKey"
properties:
description: "translated s3 resource name"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "412"
name: "targetKey"
properties:
description: "translated s3 resource name"
- location:
type: "RESPONSE_HEADER"
method: "GET"
statusCode: "500"
name: "targetKey"
properties:
description: "translated s3 resource name"
x-amazon-apigateway-request-validators:
Validate body, query string parameters, and headers:
validateRequestParameters: true
validateRequestBody: true