Skip to content

Commit 55f3271

Browse files
Merge pull request #282 from DeepLcom/v3-languages-changelog
docs(v3-languages): add beta changelog page
2 parents 565ec22 + 070bbc4 commit 55f3271

3 files changed

Lines changed: 97 additions & 2 deletions

File tree

api-reference/languages/retrieve-supported-languages-by-product.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ Get information about all currently supported languages across all DeepL API pro
1515
for a full list of differences and code examples.
1616

1717
**These endpoints are available for testing in BETA.** Breaking changes may be pushed with little or no advance
18-
notice, and we provide no guarantees of stability. Please do not use `/v3/languages` in production.
18+
notice, and we provide no guarantees of stability. Please do not use `/v3/languages` in production. See the
19+
[changelog](/api-reference/languages/v3-languages-changelog) for planned changes.
1920
</Info>
2021

2122
We also provide auto-generated API specs from DeepL's OpenAPI file, for use with API clients and code generation tools:
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
title: 'v3/languages changelog [BETA]'
3+
sidebarTitle: 'Changelog'
4+
description: 'Changes and planned updates to the v3/languages endpoints during the beta period.'
5+
---
6+
7+
<Info>
8+
These endpoints are in **BETA**. We will try to announce breaking changes here before they land, but cannot guarantee
9+
advance notice. Do not use these endpoints in production.
10+
</Info>
11+
12+
## Changes since the initial beta release
13+
14+
This section will list dated changes to the API since the initial beta release.
15+
16+
### 19 March 2026
17+
18+
Initial beta release.
19+
20+
## Planned changes
21+
22+
The following changes are planned before general availability. They are not yet live.
23+
24+
---
25+
26+
### Breaking: rename `required_on_source` / `required_on_target`
27+
28+
The feature dependency flags on `/v3/languages/products` will be renamed:
29+
30+
| Current name | New name |
31+
|---|---|
32+
| `required_on_source` | `needs_source_support` |
33+
| `required_on_target` | `needs_target_support` |
34+
35+
The semantics are unchanged — only the field names differ. Update any code that reads these fields.
36+
37+
*Reasoning*: "required" reads like a JSON schema constraint (mandatory field) rather than a language support check.
38+
39+
---
40+
41+
### Breaking: remove `endpoints` from `/v3/languages/products`
42+
43+
The `endpoints` array will be removed from each product object in the `/v3/languages/products` response.
44+
45+
*Reasoning*: endpoint information is not useful programmatically. The applicable endpoints will still be described in
46+
the documentation for each product.
47+
48+
---
49+
50+
### New: language `status` field
51+
52+
Language objects returned by `GET /v3/languages` will include an optional `status` field for languages not yet in general availability:
53+
54+
```json
55+
{
56+
"lang": "xyz",
57+
"name": "Example Language",
58+
"usable_as_source": true,
59+
"usable_as_target": true,
60+
"features": [],
61+
"status": "beta"
62+
}
63+
```
64+
65+
Possible values: `"beta"`, `"early_access"`. Languages in GA omit this field entirely.
66+
67+
---
68+
69+
### New: `auto_detection` feature across multiple products
70+
71+
An `auto_detection` feature will be added to indicate whether a language can be auto-detected as the source.
72+
This is a source-only feature (`needs_source_support: true`, `needs_target_support: false`).
73+
74+
---
75+
76+
### New: expanded Voice features
77+
78+
The `voice` product will expose a richer set of features in `/v3/languages/products` and per-language `features` arrays,
79+
details are still being worked out.
80+
81+
---
82+
83+
## Possible additions
84+
85+
These are under consideration and may or may not land before GA.
86+
87+
- **`native_name` field** on language objects — the language's name in that language (e.g. `"Deutsch"` for German).
88+
89+
---
90+
91+
## Current beta state
92+
93+
For the current API contract, see the [overview](/api-reference/languages/retrieve-supported-languages-by-product) and the auto-generated reference pages linked there.

docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,8 @@
218218
"api-reference/languages/retrieve-languages-by-product",
219219
"api-reference/languages/retrieve-products",
220220
"api-reference/languages/retrieve-language-pair-exceptions",
221-
"api-reference/languages/migrate-from-v2-languages"
221+
"api-reference/languages/migrate-from-v2-languages",
222+
"api-reference/languages/v3-languages-changelog"
222223
]
223224
}
224225
]

0 commit comments

Comments
 (0)