Automatic_Translations/API/translate-API-translatetext-swagger-postman.json at master · agzsoftsi/Automatic_Translations · GitHub

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
{
  "swagger": "2.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.",
    "version": "2020-06-11T21:51:45Z",
    "title": "translate-API",
    "contact": {
      "name": "Skillshare Mentorship",
      "email": "hello@skillshare.com"
    }
  },
  "host": "ytuln8zsz1.execute-api.us-east-1.amazonaws.com",
  "basePath": "/translatetext",
  "schemes": [
    "https"
  ],
  "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\tstart: hh: mm: ss, ms -> hh: mm: ss, ms,\n\t content: Text Translated",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "Bucketkey",
            "in": "query",
            "description": "name of s3 file, Bucket Key",
            "required": true,
            "type": "string"
          },
          {
            "name": "TargetLang",
            "in": "query",
            "description": "Target language to translate Text",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Access-Control-Allow-Origin": {
                "type": "string",
                "description": "console.aws.amazon.com"
              },
              "body": {
                "type": "string",
                "description": "Object JSON format with the text translated into the target language"
              },
              "targetKey": {
                "type": "string",
                "description": "translated s3 resource name"
              },
              "Content-Type": {
                "type": "string",
                "description": "Always application/json"
              },
              "status": {
                "type": "string",
                "description": "OK"
              }
            }
          },
          "404": {
            "description": "Bad QueryString Parameter:Video transcription file not found or Translation was not possible",
            "headers": {
              "Access-Control-Allow-Origin": {
                "type": "string",
                "description": "console.aws.amazon.com"
              },
              "body": {
                "type": "string",
                "description": "Bad QueryString Parameter:Video transcription file not found or Translation was not possible"
              },
              "targetKey": {
                "type": "string",
                "description": "translated s3 resource name"
              },
              "Content-Type": {
                "type": "string",
                "description": "Always application/json"
              },
              "status": {
                "type": "string",
                "description": "Not Found"
              }
            }
          },
          "412": {
            "description": "Video language not soported",
            "headers": {
              "Access-Control-Allow-Origin": {
                "type": "string",
                "description": "console.aws.amazon.com"
              },
              "body": {
                "type": "string",
                "description": "Video language not soported"
              },
              "targetKey": {
                "type": "string",
                "description": "translated s3 resource name"
              },
              "Content-Type": {
                "type": "string",
                "description": "Always application/json"
              },
              "status": {
                "type": "string",
                "description": "Precondition Failed"
              }
            }
          },
          "500": {
            "description": "An error occurred executing the aws Translate service",
            "headers": {
              "Access-Control-Allow-Origin": {
                "type": "string",
                "description": "console.aws.amazon.com"
              },
              "body": {
                "type": "string",
                "description": "Internal Error"
              },
              "targetKey": {
                "type": "string",
                "description": "translated s3 resource name"
              },
              "Content-Type": {
                "type": "string",
                "description": "Always application/json"
              },
              "status": {
                "type": "string",
                "description": "Internal Error"
              }
            }
          }
        }
      }
    }
  }
}