Skip to content

Commit 680263a

Browse files
author
Travis-CI
committed
Deployed to Github Pages
0 parents  commit 680263a

File tree

5,541 files changed

+4356184
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

5,541 files changed

+4356184
-0
lines changed

‎CNAME‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
api-reference.smartling.com

‎index.html‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<!-- Global site tag (gtag.js) - Google Analytics -->
5+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-11307836-5"></script>
6+
<script>
7+
window.dataLayer = window.dataLayer || [];
8+
function gtag(){dataLayer.push(arguments);}
9+
gtag('js', new Date());
10+
11+
gtag('config', 'UA-11307836-5');
12+
</script>
13+
14+
<title>Smartling API Specification</title>
15+
<!-- needed for adaptive design -->
16+
<meta charset="utf-8"/>
17+
<meta name="viewport" content="width=device-width, initial-scale=1">
18+
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
19+
20+
<!--
21+
ReDoc doesn't change outer page styles
22+
-->
23+
<style>
24+
body {
25+
margin: 0;
26+
padding: 0;
27+
}
28+
</style>
29+
</head>
30+
<body>
31+
<redoc spec-url="./swagger.json"></redoc>
32+
33+
<script src="https://cdn.jsdelivr.net/npm/redoc@latest/bundles/redoc.standalone.js"> </script>
34+
</body>
35+
</html>

‎openapi.json‎

Lines changed: 18154 additions & 0 deletions
Large diffs are not rendered by default.

‎openapi.yaml‎

Lines changed: 13183 additions & 0 deletions
Large diffs are not rendered by default.

‎preview/add-job-number/index.html‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<!-- Global site tag (gtag.js) - Google Analytics -->
5+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-11307836-5"></script>
6+
<script>
7+
window.dataLayer = window.dataLayer || [];
8+
function gtag(){dataLayer.push(arguments);}
9+
gtag('js', new Date());
10+
11+
gtag('config', 'UA-11307836-5');
12+
</script>
13+
14+
<title>Smartling API Specification</title>
15+
<!-- needed for adaptive design -->
16+
<meta charset="utf-8"/>
17+
<meta name="viewport" content="width=device-width, initial-scale=1">
18+
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
19+
20+
<!--
21+
ReDoc doesn't change outer page styles
22+
-->
23+
<style>
24+
body {
25+
margin: 0;
26+
padding: 0;
27+
}
28+
</style>
29+
</head>
30+
<body>
31+
<redoc spec-url="./swagger.json"></redoc>
32+
33+
<script src="https://cdn.jsdelivr.net/npm/redoc@latest/bundles/redoc.standalone.js"> </script>
34+
</body>
35+
</html>

‎preview/add-job-number/smartling_logo.png‎

11.3 KB
Loading

‎preview/add-job-number/spec/api_common.yaml‎

Lines changed: 272 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,272 @@
1+
components:
2+
parameters:
3+
accountUid:
4+
name: accountUid
5+
in: path
6+
type: string
7+
required: true
8+
description: The account’s unique identifier. This can be found in the Smartling Dashboard under Account Settings > API.
9+
10+
projectId:
11+
name: projectId
12+
in: path
13+
required: true
14+
type: string
15+
description: A unique project identifier. This can be found in the Smartling Dashboard under Account Settings > API.
16+
17+
localeId:
18+
name: localeId
19+
in: path
20+
required: true
21+
type: string
22+
description: A valid Smartling Locale ID.
23+
24+
requestBodies:
25+
26+
sourceLocaleId:
27+
type: object
28+
properties:
29+
sourceLocaleId:
30+
type: string
31+
description: The locale identifier for the source locale of the project. This indicates the base locale for which content should be uploaded to the project.
32+
example: "en-US"
33+
34+
hashcode:
35+
type: object
36+
properties:
37+
hashcode:
38+
type: string
39+
description: string hashcode
40+
example: "7191152182c69d9b72069ac1290fe24b"
41+
42+
schemas:
43+
44+
SuccessResponse:
45+
type: object
46+
required:
47+
- code
48+
properties:
49+
code:
50+
type: string
51+
enum:
52+
- SUCCESS
53+
description: Indicates whether the response was successful or what error has occurred.
54+
55+
EmptyResponse:
56+
type: object
57+
required:
58+
- response
59+
properties:
60+
response:
61+
allOf:
62+
- $ref: '#/components/schemas/SuccessResponse'
63+
- properties:
64+
data:
65+
description: Always null.
66+
type: object
67+
type: object
68+
69+
Error:
70+
type: object
71+
properties:
72+
key:
73+
example: general_error
74+
type: string
75+
message:
76+
example: Unexpected server error
77+
type: string
78+
details:
79+
example: {}
80+
type: object
81+
required:
82+
- key
83+
- message
84+
85+
Error400Response:
86+
type: object
87+
properties:
88+
response:
89+
properties:
90+
code:
91+
description: >-
92+
Indicates whether the response was successful or what error has occured.
93+
enum:
94+
- VALIDATION_ERROR
95+
type: string
96+
errors:
97+
items:
98+
$ref: '#/components/schemas/Error'
99+
type: array
100+
required:
101+
- code
102+
- errors
103+
type: object
104+
required:
105+
- response
106+
107+
Error401Response:
108+
properties:
109+
response:
110+
properties:
111+
code:
112+
description: >-
113+
Indicates whether the response was successful or what error has occured.
114+
enum:
115+
- AUTHENTICATION_ERROR
116+
- AUTHORIZATION_ERROR
117+
type: string
118+
errors:
119+
items:
120+
$ref: '#/components/schemas/Error'
121+
type: array
122+
required:
123+
- code
124+
- errors
125+
type: object
126+
required:
127+
- response
128+
type: object
129+
Error404Response:
130+
properties:
131+
response:
132+
properties:
133+
code:
134+
description: >-
135+
Indicates whether the response was successful or what error has occured.
136+
enum:
137+
- NOT_FOUND_ERROR
138+
type: string
139+
errors:
140+
items:
141+
$ref: '#/components/schemas/Error'
142+
type: array
143+
required:
144+
- code
145+
- errors
146+
type: object
147+
required:
148+
- response
149+
type: object
150+
Error423Response:
151+
properties:
152+
response:
153+
properties:
154+
code:
155+
description: >-
156+
Indicates whether the response was successful or what error has occured.
157+
enum:
158+
- RESOURCE_LOCKED
159+
type: string
160+
errors:
161+
items:
162+
$ref: '#/components/schemas/Error'
163+
type: array
164+
required:
165+
- code
166+
- errors
167+
type: object
168+
required:
169+
- response
170+
type: object
171+
Error429Response:
172+
properties:
173+
response:
174+
properties:
175+
code:
176+
description: >-
177+
Indicates whether the response was successful or what error has occured.
178+
enum:
179+
- MAX_OPERATIONS_LIMIT_EXCEEDED
180+
type: string
181+
errors:
182+
items:
183+
$ref: '#/components/schemas/Error'
184+
type: array
185+
required:
186+
- code
187+
- errors
188+
type: object
189+
required:
190+
- response
191+
type: object
192+
Error500Response:
193+
properties:
194+
response:
195+
properties:
196+
code:
197+
description: >-
198+
Indicates whether the response was successful or what error has occured.
199+
enum:
200+
- GENERAL_ERROR
201+
- MAINTENANCE_MODE_ERROR
202+
type: string
203+
errors:
204+
items:
205+
$ref: '#/components/schemas/Error'
206+
type: array
207+
required:
208+
- code
209+
- errors
210+
type: object
211+
required:
212+
- response
213+
type: object
214+
responses:
215+
Error400ResponseDefinition:
216+
description: Provided request parameters are invalid.
217+
content:
218+
application/json:
219+
schema:
220+
$ref: '#/components/schemas/Error400Response'
221+
examples:
222+
response:
223+
value:
224+
response:
225+
code: VALIDATION_ERROR
226+
errors:
227+
key: unknown.field
228+
message: >-
229+
The field unknown.parameter was not expected. Please
230+
consult the documentation to verify the fields you are
231+
submitting.
232+
details: unknown.parameter
233+
234+
Error401ResponseDefinition:
235+
description: Provided credentials are not valid.
236+
content:
237+
application/json:
238+
schema:
239+
$ref: '#/components/schemas/Error401Response'
240+
examples:
241+
response:
242+
value:
243+
response:
244+
code: AUTHENTICATION_ERROR
245+
errors:
246+
details: {}
247+
key: invalid_token
248+
message: Invalid token
249+
250+
Error429ResponseDefinition:
251+
description: Too many simultaneous API requests.
252+
content:
253+
application/json:
254+
schema:
255+
$ref: '#/components/schemas/Error429Response'
256+
examples:
257+
response:
258+
value:
259+
response:
260+
code: MAX_OPERATIONS_LIMIT_EXCEEDED
261+
errors:
262+
key: too.many.requests
263+
message: >-
264+
The limit of 10 concurrent Smartling file API
265+
operations for this project has been exceeded.
266+
267+
Error500ResponseDefinition:
268+
description: Unexpected error
269+
content:
270+
application/json:
271+
schema:
272+
$ref: '#/components/schemas/Error500Response'

0 commit comments

Comments
 (0)