Skip to content

Commit eb79c1d

Browse files
daniel-jones-devdaniel-jones-dev
committed
docs: format changelog
1 parent 5bfddcd commit eb79c1d

File tree

1 file changed

+52
-67
lines changed

1 file changed

+52
-67
lines changed

‎CHANGELOG.md‎

Lines changed: 52 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -5,187 +5,172 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

77
## [Unreleased]
8-
98
### Added
10-
* Added `extraRequestParameters` option to text and document translation methods to pass arbitrary parameters in the request body. This can be used to access beta features or override built-in parameters (such as `target_lang`, `source_lang`, etc.).
9+
- Added `extraRequestParameters` option to text and document translation methods to pass arbitrary parameters in the request body. This can be used to access beta features or override built-in parameters (such as `target_lang`, `source_lang`, etc.).
1110

1211
## [1.10.3] - 2025-08-22
1312
### Security
14-
* Updated `org.apache.httpcomponents:httpclient` to 4.5.14 due to [CVE-2020-13956](https://nvd.nist.gov/vuln/detail/CVE-2020-13956).
15-
* Thanks to [warm-tune](https://github.com/warm-tune) for reporting in [#72](https://github.com/DeepLcom/deepl-java/issues/72).
16-
13+
- Updated `org.apache.httpcomponents:httpclient` to 4.5.14 due to [CVE-2020-13956](https://nvd.nist.gov/vuln/detail/CVE-2020-13956).
14+
* Thanks to [warm-tune](https://github.com/warm-tune) for reporting in [#72](https://github.com/DeepLcom/deepl-java/issues/72).
1715

1816
## [1.10.2] - 2025-07-11
1917
### Changed
20-
* Migrate to Sonatype Portal OSSRH Staging API due to legacy OSSRH being sunsetted.
21-
* Whitespace surrounding auth key is now stripped.
18+
- Migrate to Sonatype Portal OSSRH Staging API due to legacy OSSRH being sunsetted.
19+
- Whitespace surrounding auth key is now stripped.
2220
* Thanks to [timazhum](https://github.com/timazhum) for the fix in [#64](https://github.com/DeepLcom/deepl-java/pull/69).
2321

24-
2522
## [1.10.1] - 2025-06-18
2623
### Fixed
27-
* Fixed `DeepLClient::deleteMultilingualGlossary(String glossaryId)` being package private, made it public instead.
24+
- Fixed `DeepLClient::deleteMultilingualGlossary(String glossaryId)` being package private, made it public instead.
2825
* Thanks to [MTSxoff](https://github.com/MTSxoff) for the report in [#68](https://github.com/DeepLcom/deepl-java/issues/68) and the fix in [#69](https://github.com/DeepLcom/deepl-java/pull/69).
2926

30-
3127
## [1.10.0] - 2025-04-30
3228
### Added
33-
* Added support for the /v3 Multilingual Glossary APIs in the client library
29+
- Added support for the /v3 Multilingual Glossary APIs in the client library
3430
while providing backwards compatability for the previous /v2 Glossary
3531
endpoints. Please refer to the README or
3632
[upgrading_to_multilingual_glossaries.md](upgrading_to_multilingual_glossaries.md)
3733
for usage instructions.
38-
* Added Ukrainian language code
39-
34+
- Added Ukrainian language code
4035

4136
## [1.9.0] - 2025-02-21
4237
### Added
43-
* Allow specifying the API version to use. This is mostly for users who have an
38+
- Allow specifying the API version to use. This is mostly for users who have an
4439
API subscription that includes an API key for CAT tool usage, who need to use
4540
the v1 API.
4641

47-
4842
## [1.8.1] - 2025-02-07
4943
### Fixed
50-
* Added a constructor for `DeepLClient` that only takes an `authKey`, to fix the
44+
- Added a constructor for `DeepLClient` that only takes an `authKey`, to fix the
5145
README example and be in line with `Translator`.
52-
* Un-deprecated the `Translator` and `TranslatorOptions` class and moved it to
46+
- Un-deprecated the `Translator` and `TranslatorOptions` class and moved it to
5347
their constructors. The functionality in them continues to work and be supported,
5448
user code should just use `DeepLClient` and `DeepLClientOptions`.
5549

5650
## [1.8.0] - 2025-01-17
5751
### Added
58-
* Added support for the Write API in the client library, the implementation
52+
- Added support for the Write API in the client library, the implementation
5953
can be found in the `DeepLClient` class. Please refer to the README for usage
6054
instructions.
55+
6156
### Changed
62-
* The main functionality of the library is now also exposed via the `DeepLClient`
57+
- The main functionality of the library is now also exposed via the `DeepLClient`
6358
class. Please change your code to use this over the `Translator` class whenever
6459
convenient.
6560

6661
## [1.7.0] - 2024-11-15
6762
### Added
68-
* Added `modelType` option to `translateText()` to use models with higher
63+
- Added `modelType` option to `translateText()` to use models with higher
6964
translation quality (available for some language pairs), or better latency.
7065
Options are `'quality_optimized'`, `'latency_optimized'`, and `'prefer_quality_optimized'`
71-
* Added the `modelTypeUsed` field to `translateText()` response, that
66+
- Added the `modelTypeUsed` field to `translateText()` response, that
7267
indicates the translation model used when the `modelType` option is
7368
specified.
7469

75-
7670
## [1.6.0] - 2024-09-17
7771
### Added
78-
* Added `getBilledCharacters()` to text translation response.
79-
72+
- Added `getBilledCharacters()` to text translation response.
8073

8174
## [1.5.1] - 2024-09-05
8275
### Fixed
83-
* Fixed parsing for usage count and limit for large values.
84-
* Thanks to [lubo-dev](https://github.com/lubo-dev) in [#45](https://github.com/DeepLcom/deepl-java/pull/45).
85-
76+
- Fixed parsing for usage count and limit for large values.
77+
* Thanks to [lubo-dev](https://github.com/lubo-dev) in [#45](https://github.com/DeepLcom/deepl-java/pull/45).
8678

8779
## [1.5.0] - 2024-04-10
8880
### Added
89-
* New language available: Arabic (MSA) (`'ar'`). Add language code constants and tests.
81+
- New language available: Arabic (MSA) (`'ar'`). Add language code constants and tests.
9082

9183
Note: older library versions also support the new language, this update only
9284
adds new code constants.
85+
9386
### Fixed
94-
* Change document upload to use the path `/v2/document` instead of `/v2/document/` (no trailing `/`).
87+
- Change document upload to use the path `/v2/document` instead of `/v2/document/` (no trailing `/`).
9588
Both paths will continue to work in the v2 version of the API, but `/v2/document` is the intended one.
9689

97-
9890
## [1.4.0] - 2023-11-03
9991
### Added
100-
* Add optional `context` parameter for text translation, that specifies
92+
- Add optional `context` parameter for text translation, that specifies
10193
additional context to influence translations, that is not translated itself.
102-
### Fixed
103-
* Remove unused `commons-math` dependency
104-
10594

106-
## [1.3.0] - 2023-06-09
10795
### Fixed
108-
* Changed document translation to poll the server every 5 seconds. This should greatly reduce observed document translation processing time.
109-
* Fix getUsage request to be a HTTP GET request, not POST.
96+
- Remove unused `commons-math` dependency
11097

98+
## [1.3.0] - 2023-06-09
99+
### Fixed
100+
- Changed document translation to poll the server every 5 seconds. This should greatly reduce observed document translation processing time.
101+
- Fix getUsage request to be a HTTP GET request, not POST.
111102

112103
## [1.2.0] - 2023-03-22
113104
### Added
114-
* Script to check our source code for license headers and a step for them in the CI.
115-
* Added system and java version information to the user-agent string that is sent with API calls, along with an opt-out.
116-
* Added method for applications that use this library to identify themselves in API requests they make.
117-
105+
- Script to check our source code for license headers and a step for them in the CI.
106+
- Added system and java version information to the user-agent string that is sent with API calls, along with an opt-out.
107+
- Added method for applications that use this library to identify themselves in API requests they make.
118108

119109
## [1.1.0] - 2023-01-26
120110
### Added
121-
* Add example maven project using this library.
122-
* New languages available: Korean (`'ko'`) and Norwegian (bokmål) (`'nb'`). Add
111+
- Add example maven project using this library.
112+
- New languages available: Korean (`'ko'`) and Norwegian (bokmål) (`'nb'`). Add
123113
language code constants and tests.
124114

125115
Note: older library versions also support the new languages, this update only
126116
adds new code constants.
127-
### Fixed
128-
* Send Formality options in API requests even if it is default.
129117

118+
### Fixed
119+
- Send Formality options in API requests even if it is default.
130120

131121
## [1.0.1] - 2023-01-02
132122
### Fixed
133-
* Always send SentenceSplittingMode option in requests.
134-
* [#3](https://github.com/DeepLcom/deepl-java/issues/3) thanks to
123+
- Always send SentenceSplittingMode option in requests.
124+
* [#3](https://github.com/DeepLcom/deepl-java/issues/3) thanks to
135125
[nicStuff](https://github.com/nicStuff)
136126

137-
138127
## [1.0.0] - 2022-12-15
139128
### Added
140-
* Add support for glossary management functions.
129+
- Add support for glossary management functions.
130+
141131
### Changed
142-
* `parsing.ErrorResponse` fields `message` and `detail` are now private,
132+
- `parsing.ErrorResponse` fields `message` and `detail` are now private,
143133
encapsulated with getters.
144134

145-
146135
## [0.2.1] - 2022-10-19
147136
### Fixed
148-
* Handle case where HTTP response is not valid JSON.
149-
137+
- Handle case where HTTP response is not valid JSON.
150138

151139
## [0.2.0] - 2022-09-26
152140
### Added
153-
* Add new `Formality` options: `PreferLess` and `PreferMore`.
141+
- Add new `Formality` options: `PreferLess` and `PreferMore`.
142+
154143
### Changed
155-
* Requests resulting in `503 Service Unavailable` errors are now retried.
144+
- Requests resulting in `503 Service Unavailable` errors are now retried.
156145
Attempting to download a document before translation is completed will now
157146
wait and retry (up to 5 times by default), rather than throwing an exception.
147+
158148
### Fixed
159-
* Use `Locale.ENGLISH` when changing string case.
149+
- Use `Locale.ENGLISH` when changing string case.
160150
* Thanks to [seratch](https://github.com/seratch).
161-
* Avoid cases in `HttpContent` and `StreamUtils` where temporary objects might
151+
- Avoid cases in `HttpContent` and `StreamUtils` where temporary objects might
162152
not be closed.
163153
* Thanks to [seratch](https://github.com/seratch).
164154

165-
166155
## [0.1.3] - 2022-09-09
167156
### Fixed
168-
* Fixed examples in readme.
169-
* `Usage.Detail` `count` and `limit` properties type changed from `int` to `long`.
170-
157+
- Fixed examples in readme.
158+
- `Usage.Detail` `count` and `limit` properties type changed from `int` to `long`.
171159

172160
## [0.1.2] - 2022-09-08
173161
### Fixed
174-
* Fix publishing to Maven Central by including sourcesJar and javadocJar.
175-
162+
- Fix publishing to Maven Central by including sourcesJar and javadocJar.
176163

177164
## [0.1.1] - 2022-09-08
178165
### Fixed
179-
* Fix CI publishing step.
180-
166+
- Fix CI publishing step.
181167

182168
## [0.1.0] - 2022-09-08
183169
Initial version.
184170

185-
186171
[Unreleased]: https://github.com/DeepLcom/deepl-java/compare/v1.10.3...HEAD
187172
[1.10.3]: https://github.com/DeepLcom/deepl-java/compare/v1.10.2...v1.10.3
188-
[1.10.2]: https://github.com/DeepLcom/deepl-java/compare/v1.10.0...v1.10.2
173+
[1.10.2]: https://github.com/DeepLcom/deepl-java/compare/v1.10.1...v1.10.2
189174
[1.10.1]: https://github.com/DeepLcom/deepl-java/compare/v1.10.0...v1.10.1
190175
[1.10.0]: https://github.com/DeepLcom/deepl-java/compare/v1.9.0...v1.10.0
191176
[1.9.0]: https://github.com/DeepLcom/deepl-java/compare/v1.8.1...v1.9.0

0 commit comments

Comments
 (0)