Skip to content

Commit 9f66827

Browse files
Fix examples that are not rendering properly
1 parent d398f3e commit 9f66827

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

openapi_gitbook.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -306,12 +306,14 @@ paths:
306306
the translation process. Must be used when referring to this
307307
particular document in subsequent API requests.
308308
type: string
309+
example: 04DE5AD98A02647D83285A36021911C6
309310
document_key:
310311
description: A unique key that is used to encrypt the uploaded
311312
document as well as the resulting translation on the server
312313
side. Must be provided with every subsequent API request regarding
313314
this particular document.
314315
type: string
316+
example: 0CB0054F1C132C1625B392EADDA41CB754A742822F6877173029A6C487E7F60A
315317
example:
316318
document_id: 04DE5AD98A02647D83285A36021911C6
317319
document_key: 0CB0054F1C132C1625B392EADDA41CB754A742822F6877173029A6C487E7F60A
@@ -377,6 +379,7 @@ paths:
377379
the requested translation process. The same ID that was used
378380
when requesting the translation status.
379381
type: string
382+
example: 04DE5AD98A02647D83285A36021911C6
380383
status:
381384
description: |-
382385
A short description of the state the document translation process is currently in. Possible values are:
@@ -385,6 +388,7 @@ paths:
385388
* `done` - the translation is done and the translated document is ready for download
386389
* `error` - an irrecoverable error occurred while translating the document
387390
type: string
391+
example: translating
388392
enum:
389393
- queued
390394
- translating
@@ -395,11 +399,13 @@ paths:
395399
Estimated number of seconds until the translation is done.
396400
This parameter is only included while `status` is `"translating"`.
397401
type: integer
402+
example: 20
398403
billed_characters:
399404
description: The number of characters billed to your account.
400405
The characters will only be billed after a successful download
401406
request.
402407
type: integer
408+
example: 1337
403409
error_message:
404410
description: |-
405411
A short description of the error, if available.
@@ -537,10 +543,12 @@ paths:
537543
description: The language in which the source texts in the
538544
glossary are specified.
539545
type: string
546+
example: en
540547
target_lang:
541548
description: The language in which the target texts in the
542549
glossary are specified.
543550
type: string
551+
example: de
544552
example:
545553
supported_languages:
546554
- source_lang: de
@@ -903,13 +911,16 @@ paths:
903911
language:
904912
description: The language code of the given language.
905913
type: string
914+
example: de
906915
name:
907916
description: Name of the language in English.
908917
type: string
918+
example: German
909919
supports_formality:
910920
description: Denotes formality support in case of a target language
911921
listing.
912922
type: boolean
923+
example: true
913924
example:
914925
- language: BG
915926
name: Bulgarian

0 commit comments

Comments
 (0)