Skip to content

Commit 8cf7879

Browse files
chore: prepare 0.6.0 release
1 parent a37cfd5 commit 8cf7879

File tree

4 files changed

+25
-56
lines changed

4 files changed

+25
-56
lines changed

docs/changelog/0.6.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### 0.6.0
22

3-
_Not Released Yet_
3+
_Released 2024 Oct 25_
44

55
#### Fixes
66

docs/changelog/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
### Version History
66

7-
* ????-??-?? [0.6.0](0.6.0.md) (TBD; work in progress)
8-
* 2024-07-22 [0.5.0](0.5.0.md) (latest)
7+
* 2024-10-25 [0.6.0](0.6.0.md) (latest)
8+
* 2024-07-22 [0.5.0](0.5.0.md)
99
* 2022-07-27 [0.4.0](0.4.0.md)
1010
* 2021-07-14 [0.3.0](0.3.0.md)
1111
* 2021-01-25 [0.2.0](0.2.0.md)

docs/changelog/full.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
### 0.6.0
2+
3+
_Released 2024 Oct 25_
4+
5+
#### Fixes
6+
7+
- Fixed a critical bug in the path parameter substitution logic that caused
8+
requests with path parameters to target invalid endpoints.
9+
10+
#### Breaking Changes
11+
12+
- `api-client-ktor` now requires Ktor 3.
13+
14+
15+
---
16+
117
### 0.5.0
218

319
_Released 2024 Jul 22_

docs/changelog/latest.md

Lines changed: 6 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,12 @@
1-
### 0.5.0
1+
### 0.6.0
22

3-
_Released 2024 Jul 22_
3+
_Released 2024 Oct 25_
44

5-
#### Overview
5+
#### Fixes
66

7-
This release is a long overdue major update to the project. The entire API
8-
surface has been touched up and improved to provide a better developer
9-
experience.
10-
11-
The most significant change is the decoupling of request creation from request
12-
execution:
13-
14-
```kotlin
15-
// Old
16-
suspend fun main() {
17-
val client = GW2APIClient(...)
18-
val requestBuilder = client.gw2v2Build()
19-
20-
val request = coroutineScope { requestBuilder.execute(this) }
21-
val response = request.get()
22-
23-
val gw2v2Build = response.data.getOrNull() ?: error("Could not decode request")
24-
25-
println("Build ID: ${gw2v2Build.id}")
26-
}
27-
```
28-
29-
Whereas the old way to create request contained a lot of ceremony to support
30-
asynchronous and synchronous execution at the same time, the new way is much
31-
more straightforward:
32-
33-
```kotlin
34-
// New
35-
suspend fun main() {
36-
val client = Gw2ApiClient()
37-
val gw2v2Build = client.executeAsync(gw2v2Build()).dataOrNull ?: error("Failed to fetch build ID.")
38-
39-
println("Build ID: {$gw2v2Build.id}")
40-
}
41-
```
42-
43-
There is no full migration guide available. Please refer to the updated
44-
documentation for more information.
45-
46-
#### Improvements
47-
48-
- Added an explicit Java module descriptor for `api-types`.
49-
- Added a simple API to allow blocking execution of requests on the JVM.
50-
- This is especially useful in combination with virtual threads.
51-
- Replaced placeholder exception that is thrown when an unknown type is
52-
encountered with a `SerializationException`.
53-
- Migrated to schema version `2022-03-23T19:00:00.000Z`.
7+
- Fixed a critical bug in the path parameter substitution logic that caused
8+
requests with path parameters to target invalid endpoints.
549

5510
#### Breaking Changes
5611

57-
- Migrated to schema version `2022-03-23T19:00:00.000Z`.
58-
- The entire API client has been rewritten to decouple request creation from
59-
execution. Please see the updated documentation for more information.
12+
- `api-client-ktor` now requires Ktor 3.

0 commit comments

Comments
 (0)