Skip to content

Commit d193b02

Browse files
Improve clarity of v2/v3 glossary API docs (#129)
* parvatichanges * added links for write rephrase variant use * resolved comments on mr for updates to v3 glossary documentation
1 parent f552e5b commit d193b02

4 files changed

Lines changed: 11 additions & 9 deletions

File tree

api-reference/glossaries.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,10 @@ description: "Manage glossaries using the v2 endpoints"
88
<Info>
99
This page documents `v2` glossary endpoints, legacy endpoints that let you create and manage glossaries for a single language pair.
1010

11-
[See here](/api-reference/multilingual-glossaries) for information on `v3` endpoints, which allow you to create, manage, and edit glossaries with entries in multiple language pairs. [See here](/api-reference/glossaries/v2-vs-v3-endpoints) for an overview of the difference.
11+
[See here](/api-reference/multilingual-glossaries) for information on current `v3` endpoints. Using `v3` allows you to create, manage, and edit glossaries with entries in multiple language pairs, while still supporting monolingual functionality. [See here](/api-reference/glossaries/v2-vs-v3-endpoints) for an overview of the difference.
1212
</Info>
1313

14-
This page describes how to use the `v2` endpoints to work with _monolingual_ glossaries - glossaries that map phrases in one language to phrases in another language. If you're new to glossaries, we suggest you use `v3` instead. `v3` allows you to work with multilingual glossaries, and it lets you edit any glossaries as well.
15-
16-
### Create a glossary
14+
This page describes how to use the `v2` endpoints to work with _monolingual_ glossaries - glossaries that map phrases in one language to phrases in another language. If you're new to glossaries, we suggest you use `v3` instead.
1715

1816
<Tabs>
1917
<Tab title="cURL">

api-reference/multilingual-glossaries.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,15 @@ description: "Manage and use DeepL glossaries"
66
---
77

88
<Info>
9-
This page documents `v3` glossary endpoints, which let you edit glossaries and makes them multilingual. [See here](/api-reference/glossaries) for information on `v2` glossaries. [See here](/api-reference/glossaries/v2-vs-v3-endpoints) for an overview of the difference.
10-
11-
At present, the `v3` endpoint is only used for working with multilingual glossaries.
9+
This page documents `v3` glossary endpoints, which let you **edit** glossaries and allow for **multilingual** functionality.
10+
11+
The current`v3` endpoints are used for working with **both multilingual and monolingual** glossaries. Thus, we recommend you start using the `v3` endpoints described below for all glossary needs.
12+
13+
The previously used [v2 glossary endpoints](/api-reference/glossaries) can only be used with **monolingual** glossaries. [See here](/api-reference/glossaries/v2-vs-v3-endpoints) for more on the difference between `v2` and `v3` glossary endpoints.
1214
</Info>
1315

16+
17+
1418
## Overview
1519

1620
The `glossaries` endpoints let you work with [DeepL glossaries](https://support.deepl.com/hc/en-us/articles/360021634540-About-the-glossary), which let you specify specific translations for words or short phrases. Each glossary contains a mapping of source phrases to target phrases. During translation, DeepL intelligently flexes entries to account for case, gender, tense, and other grammar features (if the target language has flexion).

api-reference/translate.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ Note that we do not include examples for our client libraries in every single se
169169
<Info>
170170
Please note that the Translate API is intended to be used for translation between different languages, but requests with the same source and target language are still counted toward billing.
171171

172-
If trying to convert between variants of the same language (e.g. `EN-US` to `EN-GB`), please consider using the [/write/rephrase](/api-reference/improve-text) API instead. Translating between variants of the same language will result in no change to the text.
172+
If trying to convert between variants of the same language (e.g. `EN-US` to `EN-GB`), please consider using the [/write/rephrase](/api-reference/improve-text) API instead. Please see [here](/docs/getting-started/supported-languages#text-improvement-languages-deepl-api-for-write) for supported target languages for this use case. Translating between variants of the same language will result in no change to the text.
173173
</Info>
174174

175175
### Request Body Descriptions

docs/getting-started/supported-languages.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ public: true
55
---
66

77
<Info>
8-
If trying to convert between variants of the same language (e.g. `EN-US` to `EN-GB`), please use the [/write/rephrase](/api-reference/improve-text) API.
8+
If trying to convert between variants of the same language (e.g. `EN-US` to `EN-GB`), please consider using the [/write/rephrase](/api-reference/improve-text) API. Please see [here](supported-languages#text-improvement-languages-deepl-api-for-write) for supported target languages for this use case.
99
</Info>
1010

1111
### Translation source languages

0 commit comments

Comments
 (0)