Skip to content

fix(openapi): add response body to generic error responses #366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lilkraftwerk wants to merge 2 commits into
base: main
Choose a base branch
from
+84 −7
Open

fix(openapi): add response body to generic error responses #366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a613cf0
fix(openapi): add response body to generic error responses
Jun 4, 2026
80f12ef
chore: update OpenAPI JSON files from YAML sources
lilkraftwerk Jun 4, 2026
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
63 changes: 56 additions & 7 deletions api-reference/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5025,7 +5025,14 @@
}
},
"BadRequest": {
"description": "Bad request. Please check error message and your parameters."
"description": "Bad request. Please check error message and your parameters.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"BadRequestGlossaries": {
"description": "Bad request. Please check error message and your parameters.",
Expand All @@ -5052,16 +5059,37 @@
}
},
"Unauthorized": {
"description": "Authorization failed. Please supply a valid `DeepL-Auth-Key` via the `Authorization` header."
"description": "Authorization failed. Please supply a valid `DeepL-Auth-Key` via the `Authorization` header.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"Forbidden": {
"description": "Authorization failed. Please supply a valid `DeepL-Auth-Key` via the `Authorization` header."
"description": "Authorization failed. Please supply a valid `DeepL-Auth-Key` via the `Authorization` header.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"ForbiddenGlossaries": {
"description": "Forbidden. The access to the requested resource is denied, because of insufficient access rights."
},
"NotFound": {
"description": "The requested resource could not be found."
"description": "The requested resource could not be found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"NotFound404DocTransDownload": {
"description": "Trying to download a document using a non-existing document ID or the wrong document key will result in a 404 error. As stated above, documents can only be downloaded once before they are deleted from the server and their document ID is invalidated.",
Expand All @@ -5082,7 +5110,14 @@
}
},
"PayloadTooLarge": {
"description": "The request size exceeds the limit."
"description": "The request size exceeds the limit.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"URITooLong": {
"description": "The request URL is too long. You can avoid this error by using a POST request instead of a GET request, and sending the parameters in the HTTP body."
Expand All @@ -5091,10 +5126,24 @@
"description": "The requested entries format specified in the `Accept` header is not supported."
},
"TooManyRequests": {
"description": "Too many requests. Please wait and resend your request."
"description": "Too many requests. Please wait and resend your request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"QuotaExceeded": {
"description": "Quota exceeded. The character limit has been reached."
"description": "Quota exceeded. The character limit has been reached.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"QuotaExceededGlossaries": {
"description": "Quota exceeded. Too many requests were made to the glossary endpoints recently."
Expand Down
28 changes: 28 additions & 0 deletions api-reference/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3416,6 +3416,10 @@ components:
message: "/targets/0/type: Value is not valid"
BadRequest:
description: Bad request. Please check error message and your parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
BadRequestGlossaries:
description: Bad request. Please check error message and your parameters.
content:
Expand All @@ -3436,14 +3440,26 @@ components:
Unauthorized:
description: Authorization failed. Please supply a valid `DeepL-Auth-Key` via
the `Authorization` header.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
Forbidden:
description: Authorization failed. Please supply a valid `DeepL-Auth-Key` via
the `Authorization` header.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
ForbiddenGlossaries:
description: Forbidden. The access to the requested resource is denied, because
of insufficient access rights.
NotFound:
description: The requested resource could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
NotFound404DocTransDownload:
description: Trying to download a document using a non-existing document ID
or the wrong document key will result in a 404 error. As stated above, documents
Expand All @@ -3460,6 +3476,10 @@ components:
message: Document not found
PayloadTooLarge:
description: The request size exceeds the limit.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
URITooLong:
description: The request URL is too long. You can avoid this error by using
a POST request instead of a GET request, and sending the parameters in the
Expand All @@ -3469,8 +3489,16 @@ components:
not supported.
TooManyRequests:
description: Too many requests. Please wait and resend your request.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
QuotaExceeded:
description: Quota exceeded. The character limit has been reached.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
QuotaExceededGlossaries:
description: Quota exceeded. Too many requests were made to the glossary endpoints recently.
InternalServerError:
Expand Down