Skip to content

Commit d0b38b0

Browse files
author
Lucas Mathis
committed
spec: align glossary, translation memory, and usage response schemas with the live API
1 parent c443ee6 commit d0b38b0

1 file changed

Lines changed: 53 additions & 1 deletion

File tree

api-reference/openapi.yaml

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1337,6 +1337,8 @@ paths:
13371337
target_lang: EN
13381338
entry_count: 2
13391339
creation_time: '2021-08-03T14:16:18.329Z'
1340+
400:
1341+
$ref: '#/components/responses/BadRequestGlossaries'
13401342
401:
13411343
$ref: '#/components/responses/Unauthorized'
13421344
403:
@@ -1390,6 +1392,8 @@ paths:
13901392
target_lang: EN
13911393
entry_count: 2
13921394
creation_time: '2021-08-03T14:16:18.429Z'
1395+
400:
1396+
$ref: '#/components/responses/BadRequestGlossaries'
13931397
401:
13941398
$ref: '#/components/responses/Unauthorized'
13951399
403:
@@ -1547,7 +1551,13 @@ paths:
15471551
content:
15481552
application/json:
15491553
schema:
1550-
$ref: '#/components/schemas/GlossaryDictionary'
1554+
type: object
1555+
properties:
1556+
dictionaries:
1557+
description: The dictionaries of the glossary, each with its entries in the requested format.
1558+
type: array
1559+
items:
1560+
$ref: '#/components/schemas/MultilingualGlossaryEntries'
15511561
400:
15521562
$ref: '#/components/responses/BadRequestGlossaries'
15531563
401:
@@ -2678,6 +2688,8 @@ paths:
26782688
- zh
26792689
segment_count: 23
26802690
total_count: 2
2691+
400:
2692+
$ref: '#/components/responses/BadRequest'
26812693
401:
26822694
$ref: '#/components/responses/Unauthorized'
26832695
403:
@@ -2730,6 +2742,8 @@ paths:
27302742
type: array
27312743
items:
27322744
$ref: '#/components/schemas/StyleRuleList'
2745+
400:
2746+
$ref: '#/components/responses/BadRequest'
27332747
401:
27342748
$ref: '#/components/responses/Unauthorized'
27352749
403:
@@ -2843,6 +2857,8 @@ paths:
28432857
application/json:
28442858
schema:
28452859
$ref: '#/components/schemas/StyleRuleList'
2860+
400:
2861+
$ref: '#/components/responses/BadRequest'
28462862
401:
28472863
$ref: '#/components/responses/Unauthorized'
28482864
403:
@@ -2920,6 +2936,8 @@ paths:
29202936
headers:
29212937
X-Trace-ID:
29222938
$ref: '#/components/headers/X-Trace-ID'
2939+
400:
2940+
$ref: '#/components/responses/BadRequest'
29232941
401:
29242942
$ref: '#/components/responses/Unauthorized'
29252943
403:
@@ -3074,6 +3092,8 @@ paths:
30743092
application/json:
30753093
schema:
30763094
$ref: '#/components/schemas/CustomInstruction'
3095+
400:
3096+
$ref: '#/components/responses/BadRequest'
30773097
401:
30783098
$ref: '#/components/responses/Unauthorized'
30793099
403:
@@ -3173,6 +3193,8 @@ paths:
31733193
headers:
31743194
X-Trace-ID:
31753195
$ref: '#/components/headers/X-Trace-ID'
3196+
400:
3197+
$ref: '#/components/responses/BadRequest'
31763198
401:
31773199
$ref: '#/components/responses/Unauthorized'
31783200
403:
@@ -5296,6 +5318,10 @@ components:
52965318
$ref: '#/components/schemas/GlossaryEntries'
52975319
entries_format:
52985320
$ref: '#/components/schemas/GlossaryEntriesFormat'
5321+
entry_count:
5322+
allOf:
5323+
- $ref: '#/components/schemas/GlossaryEntryCount'
5324+
readOnly: true
52995325
GlossaryEntries:
53005326
type: string
53015327
description: The entries of the glossary. The entries have to be specified
@@ -5598,6 +5624,16 @@ components:
55985624
description: The number of segments stored in the translation memory.
55995625
type: integer
56005626
example: 34
5627+
creation_time:
5628+
description: 'The creation time of the translation memory in the ISO 8601-1:2019 format (e.g.: `2021-08-03T14:16:18.329Z`).'
5629+
type: string
5630+
format: date-time
5631+
example: '2026-04-01T16:34:25.223Z'
5632+
updated_time:
5633+
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`).'
5634+
type: string
5635+
format: date-time
5636+
example: '2026-04-01T16:34:25.264Z'
56015637
TranslationMemoryId:
56025638
type: string
56035639
format: uuid
@@ -5772,6 +5808,22 @@ components:
57725808
type: integer
57735809
format: int64
57745810
example: 1250000
5811+
document_count:
5812+
description: Documents translated so far in the current billing period. Only present for accounts with a document limit.
5813+
type: integer
5814+
format: int64
5815+
document_limit:
5816+
description: Current maximum number of documents that can be translated per billing period. Only present for accounts with a document limit.
5817+
type: integer
5818+
format: int64
5819+
team_document_count:
5820+
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.
5821+
type: integer
5822+
format: int64
5823+
team_document_limit:
5824+
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.
5825+
type: integer
5826+
format: int64
57755827
products:
57765828
type: array
57775829
description: Only present for API Pro users. Per-product usage details.

0 commit comments

Comments
 (0)