Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions spec/api_common.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -227,12 +227,12 @@ components:
response:
code: VALIDATION_ERROR
errors:
key: unknown.field
message: >-
The field unknown.parameter was not expected. Please
consult the documentation to verify the fields you are
submitting.
details: unknown.parameter
- key: unknown.field
message: >-
The field unknown.parameter was not expected. Please
consult the documentation to verify the fields you are
submitting.
details: {}

Error401ResponseDefinition:
description: Provided credentials are not valid.
Expand All @@ -246,9 +246,9 @@ components:
response:
code: AUTHENTICATION_ERROR
errors:
details: {}
key: invalid_token
message: Invalid token
- key: invalid_token
details: {}
message: Invalid token

Error429ResponseDefinition:
description: Too many simultaneous API requests.
Expand All @@ -262,10 +262,10 @@ components:
response:
code: MAX_OPERATIONS_LIMIT_EXCEEDED
errors:
key: too.many.requests
message: >-
The limit of 10 concurrent Smartling file API
operations for this project has been exceeded.
- key: too.many.requests
message: >-
The limit of 10 concurrent Smartling file API
operations for this project has been exceeded.

Error500ResponseDefinition:
description: Unexpected error
Expand Down
10 changes: 5 additions & 5 deletions spec/file_translation/fts_common.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,8 @@ components:
response:
code: VALIDATION_ERROR
errors:
key: not.found
message: >-
mtUid jtcorrr3 not found
details:
mtUid: jtcorrr3
- key: not.found
message: >-
mtUid jtcorrr3 not found
details:
mtUid: jtcorrr3
44 changes: 37 additions & 7 deletions spec/issues/account_issue_sub_types.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ x-paths:
$ref: '#/components/schemas/AccountIssueSubtypeModel'
required: true
responses:
'200':
200:
content:
application/json:
examples:
Expand All @@ -40,6 +40,14 @@ x-paths:
schema:
$ref: '#/components/schemas/AccountIssueSubTypeResponse'
description: OK
400:
$ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition'
401:
$ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition'
429:
$ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition'
500:
$ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition'
x-code-samples:
- lang: curl
source: >
Expand Down Expand Up @@ -81,7 +89,7 @@ x-paths:
$ref: '#/components/schemas/AccountIssueSubtypeDescriptionField'
required: true
responses:
'200':
200:
content:
application/json:
examples:
Expand All @@ -95,6 +103,14 @@ x-paths:
schema:
$ref: '#/components/schemas/AccountIssueSubTypeResponse'
description: OK
400:
$ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition'
401:
$ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition'
429:
$ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition'
500:
$ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition'
x-code-samples:
- lang: curl
source: >
Expand Down Expand Up @@ -126,7 +142,7 @@ x-paths:
schema:
type: string
responses:
'200':
200:
description: OK
content:
application/json:
Expand All @@ -135,9 +151,15 @@ x-paths:
examples:
response:
value:
response:
code: SUCCESS
data: null
code: SUCCESS
400:
$ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition'
401:
$ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition'
429:
$ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition'
500:
$ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition'
x-code-samples:
- lang: curl
source: >
Expand Down Expand Up @@ -178,7 +200,7 @@ x-paths:
$ref: '#/components/schemas/AccountIssueSubtypeStateField'
required: true
responses:
'200':
200:
content:
application/json:
examples:
Expand All @@ -191,6 +213,14 @@ x-paths:
schema:
$ref: '#/components/schemas/AccountIssueSubTypeStateResponse'
description: OK
400:
$ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition'
401:
$ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition'
429:
$ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition'
500:
$ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition'
x-code-samples:
- lang: curl
source: >
Expand Down
38 changes: 35 additions & 3 deletions spec/issues/dictionaries.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ x-paths:
- Issues
operationId: getAllIssuesStates
responses:
'200':
200:
content:
application/json:
examples:
Expand All @@ -29,6 +29,14 @@ x-paths:
schema:
$ref: '#/components/schemas/IssueStatesResponse'
description: OK
400:
$ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition'
401:
$ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition'
429:
$ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition'
500:
$ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition'
x-code-samples:
- lang: curl
source: >
Expand Down Expand Up @@ -64,6 +72,14 @@ x-paths:
- description: High
issueSeverityLevelCode: HIGH
totalCount: 3
400:
$ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition'
401:
$ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition'
429:
$ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition'
500:
$ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition'
x-code-samples:
- lang: curl
source: >
Expand Down Expand Up @@ -124,6 +140,14 @@ x-paths:
- description: MT Error
issueSubTypeCode: MT_ERROR
totalCount: 2
400:
$ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition'
401:
$ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition'
429:
$ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition'
500:
$ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition'
x-code-samples:
- lang: curl
source: >
Expand All @@ -145,7 +169,7 @@ x-paths:
- Issues
operationId: getAllIssueTypes
responses:
'200':
200:
content:
application/json:
examples:
Expand Down Expand Up @@ -179,6 +203,14 @@ x-paths:
schema:
$ref: '#/components/schemas/IssueTypesResponse'
description: OK
400:
$ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition'
401:
$ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition'
429:
$ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition'
500:
$ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition'

components:
schemas:
Expand Down Expand Up @@ -310,6 +342,7 @@ components:
- TRANSLATION
type: string
subTypes:
type: array
properties:
description:
description: Issue subtype description
Expand All @@ -326,7 +359,6 @@ components:
- CUSTOM
- MT_ERROR
type: string
type: object
type: object
type: array
totalCount:
Expand Down
50 changes: 45 additions & 5 deletions spec/issues/issue_comments.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ x-paths:
schema:
type: string
responses:
'200':
200:
content:
application/json:
examples:
Expand All @@ -44,6 +44,14 @@ x-paths:
schema:
$ref: '#/components/schemas/IssueCommentsGetResponse'
description: OK
400:
$ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition'
401:
$ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition'
429:
$ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition'
500:
$ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition'
x-code-samples:
- lang: curl
source: >
Expand Down Expand Up @@ -83,7 +91,7 @@ x-paths:
$ref: '#/components/schemas/CommentRequest'
required: true
responses:
'200':
200:
content:
application/json:
examples:
Expand All @@ -99,6 +107,14 @@ x-paths:
schema:
$ref: '#/components/schemas/IssueCommentAddResponse'
description: OK
400:
$ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition'
401:
$ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition'
429:
$ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition'
500:
$ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition'
x-code-samples:
- lang: curl
source: >
Expand Down Expand Up @@ -151,7 +167,7 @@ x-paths:
$ref: '#/components/schemas/CommentRequest'
required: true
responses:
'200':
200:
content:
application/json:
examples:
Expand All @@ -168,6 +184,14 @@ x-paths:
schema:
$ref: '#/components/schemas/IssueCommentEditResponse'
description: OK
400:
$ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition'
401:
$ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition'
429:
$ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition'
500:
$ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition'
x-code-samples:
- lang: curl
source: >
Expand Down Expand Up @@ -206,7 +230,7 @@ x-paths:
schema:
type: string
responses:
'200':
200:
content:
application/json:
examples:
Expand All @@ -222,6 +246,14 @@ x-paths:
schema:
$ref: '#/components/schemas/IssueCommentGetResponse'
description: OK
400:
$ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition'
401:
$ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition'
429:
$ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition'
500:
$ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition'
x-code-samples:
- lang: curl
source: >
Expand Down Expand Up @@ -258,7 +290,7 @@ x-paths:
schema:
type: string
responses:
'200':
200:
content:
application/json:
examples:
Expand All @@ -269,6 +301,14 @@ x-paths:
schema:
$ref: '#/components/schemas/IssueCommentDeleteResponse'
description: OK
400:
$ref: '../openapi.yaml#/components/responses/Error400ResponseDefinition'
401:
$ref: '../openapi.yaml#/components/responses/Error401ResponseDefinition'
429:
$ref: '../openapi.yaml#/components/responses/Error429ResponseDefinition'
500:
$ref: '../openapi.yaml#/components/responses/Error500ResponseDefinition'
x-code-samples:
- lang: curl
source: >
Expand Down
Loading