Skip to content

spec: align glossary, translation memory, and usage response schemas with the live API #397

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

Merged
lilkraftwerk merged 2 commits into from
Jul 13, 2026
Merged

spec: align glossary, translation memory, and usage response schemas with the live API #397

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
d0b38b0
spec: align glossary, translation memory, and usage response schemas …
Jul 13, 2026
0692d09
chore: update OpenAPI JSON files from YAML sources
lilkraftwerk Jul 13, 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
75 changes: 74 additions & 1 deletion api-reference/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1752,6 +1752,9 @@
}
}
},
"400": {
"$ref": "#/components/responses/BadRequestGlossaries"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
Expand Down Expand Up @@ -1836,6 +1839,9 @@
}
}
},
"400": {
"$ref": "#/components/responses/BadRequestGlossaries"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
Expand Down Expand Up @@ -2086,7 +2092,16 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlossaryDictionary"
"type": "object",
"properties": {
"dictionaries": {
"description": "The dictionaries of the glossary, each with its entries in the requested format.",
"type": "array",
"items": {
"$ref": "#/components/schemas/MultilingualGlossaryEntries"
}
}
}
}
}
}
Expand Down Expand Up @@ -3783,6 +3798,9 @@
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
Expand Down Expand Up @@ -3865,6 +3883,9 @@
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
Expand Down Expand Up @@ -4040,6 +4061,9 @@
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
Expand Down Expand Up @@ -4164,6 +4188,9 @@
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
Expand Down Expand Up @@ -4407,6 +4434,9 @@
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
Expand Down Expand Up @@ -4561,6 +4591,9 @@
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
Expand Down Expand Up @@ -7403,6 +7436,14 @@
},
"entries_format": {
"$ref": "#/components/schemas/GlossaryEntriesFormat"
},
"entry_count": {
"allOf": [
{
"$ref": "#/components/schemas/GlossaryEntryCount"
}
],
"readOnly": true
}
}
},
Expand Down Expand Up @@ -7744,6 +7785,18 @@
"description": "The number of segments stored in the translation memory.",
"type": "integer",
"example": 34
},
"creation_time": {
"description": "The creation time of the translation memory in the ISO 8601-1:2019 format (e.g.: `2021-08-03T14:16:18.329Z`).",
"type": "string",
"format": "date-time",
"example": "2026-04-01T16:34:25.223Z"
},
"updated_time": {
"description": "The time of the last update to the translation memory in the ISO 8601-1:2019 format (e.g.: `2021-08-03T14:16:18.329Z`).",
"type": "string",
"format": "date-time",
"example": "2026-04-01T16:34:25.264Z"
}
}
},
Expand Down Expand Up @@ -7918,6 +7971,26 @@
"format": "int64",
"example": 1250000
},
"document_count": {
"description": "Documents translated so far in the current billing period. Only present for accounts with a document limit.",
"type": "integer",
"format": "int64"
},
"document_limit": {
"description": "Current maximum number of documents that can be translated per billing period. Only present for accounts with a document limit.",
"type": "integer",
"format": "int64"
},
"team_document_count": {
"description": "Documents translated by all users in the team so far in the current billing period. Only present for accounts with a team document limit.",
"type": "integer",
"format": "int64"
},
"team_document_limit": {
"description": "Current maximum number of documents that can be translated by the team per billing period. Only present for accounts with a team document limit.",
"type": "integer",
"format": "int64"
},
"products": {
"type": "array",
"description": "Only present for API Pro users. Per-product usage details.",
Expand Down
54 changes: 53 additions & 1 deletion api-reference/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1337,6 +1337,8 @@ paths:
target_lang: EN
entry_count: 2
creation_time: '2021-08-03T14:16:18.329Z'
400:
$ref: '#/components/responses/BadRequestGlossaries'
401:
$ref: '#/components/responses/Unauthorized'
403:
Expand Down Expand Up @@ -1390,6 +1392,8 @@ paths:
target_lang: EN
entry_count: 2
creation_time: '2021-08-03T14:16:18.429Z'
400:
$ref: '#/components/responses/BadRequestGlossaries'
401:
$ref: '#/components/responses/Unauthorized'
403:
Expand Down Expand Up @@ -1547,7 +1551,13 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/GlossaryDictionary'
type: object
properties:
dictionaries:
description: The dictionaries of the glossary, each with its entries in the requested format.
type: array
items:
$ref: '#/components/schemas/MultilingualGlossaryEntries'
400:
$ref: '#/components/responses/BadRequestGlossaries'
401:
Expand Down Expand Up @@ -2678,6 +2688,8 @@ paths:
- zh
segment_count: 23
total_count: 2
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/Unauthorized'
403:
Expand Down Expand Up @@ -2730,6 +2742,8 @@ paths:
type: array
items:
$ref: '#/components/schemas/StyleRuleList'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/Unauthorized'
403:
Expand Down Expand Up @@ -2843,6 +2857,8 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/StyleRuleList'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/Unauthorized'
403:
Expand Down Expand Up @@ -2920,6 +2936,8 @@ paths:
headers:
X-Trace-ID:
$ref: '#/components/headers/X-Trace-ID'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/Unauthorized'
403:
Expand Down Expand Up @@ -3074,6 +3092,8 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/CustomInstruction'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/Unauthorized'
403:
Expand Down Expand Up @@ -3173,6 +3193,8 @@ paths:
headers:
X-Trace-ID:
$ref: '#/components/headers/X-Trace-ID'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/Unauthorized'
403:
Expand Down Expand Up @@ -5296,6 +5318,10 @@ components:
$ref: '#/components/schemas/GlossaryEntries'
entries_format:
$ref: '#/components/schemas/GlossaryEntriesFormat'
entry_count:
allOf:
- $ref: '#/components/schemas/GlossaryEntryCount'
readOnly: true
GlossaryEntries:
type: string
description: The entries of the glossary. The entries have to be specified
Expand Down Expand Up @@ -5598,6 +5624,16 @@ components:
description: The number of segments stored in the translation memory.
type: integer
example: 34
creation_time:
description: 'The creation time of the translation memory in the ISO 8601-1:2019 format (e.g.: `2021-08-03T14:16:18.329Z`).'
type: string
format: date-time
example: '2026-04-01T16:34:25.223Z'
updated_time:
description: 'The time of the last update to the translation memory in the ISO 8601-1:2019 format (e.g.: `2021-08-03T14:16:18.329Z`).'
type: string
format: date-time
example: '2026-04-01T16:34:25.264Z'
TranslationMemoryId:
type: string
format: uuid
Expand Down Expand Up @@ -5772,6 +5808,22 @@ components:
type: integer
format: int64
example: 1250000
document_count:
description: Documents translated so far in the current billing period. Only present for accounts with a document limit.
type: integer
format: int64
document_limit:
description: Current maximum number of documents that can be translated per billing period. Only present for accounts with a document limit.
type: integer
format: int64
team_document_count:
description: Documents translated by all users in the team so far in the current billing period. Only present for accounts with a team document limit.
type: integer
format: int64
team_document_limit:
description: Current maximum number of documents that can be translated by the team per billing period. Only present for accounts with a team document limit.
type: integer
format: int64
products:
type: array
description: Only present for API Pro users. Per-product usage details.
Expand Down