Skip to content

Commit ed268b9

Browse files
authored
Update README with deprecation information for v5
Clarified deprecation details for the `com.box.sdk` package and its support timeline.
1 parent 4b1c6f8 commit ed268b9

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,6 @@ The `com.box.sdkgen` package is available in two major supported versions: v5 an
4747
In v5 of the Box Java SDK, we are introducing a version that consolidates both the manually written package (`com.box.sdk`)
4848
and the new generated package (`com.box.sdkgen`). This allows developers to use both packages simultaneously within a single project.
4949

50-
Version v5 of the Box Java SDK will be supported until 2027. During this period,
51-
the `com.box.sdk` package will be marked as deprecated and will receive only bug fixes and security patches.
52-
All new features and support for new Box APIs will be provided exclusively in the `com.box.sdkgen` package.
53-
5450
The codebase for v5 of the Box Java SDK is currently available on the [combined-sdk](https://github.com/box/box-java-sdk/tree/combined-sdk) branch.
5551
Migration guide which would help with migration from `com.box.sdk` to `com.box.sdkgen` can be found [here](./migration-guides/from-com.box.sdk-to-com.box.sdkgen.md).
5652

@@ -67,6 +63,11 @@ Version v10 is intended for:
6763
- New users of the Box Java SDK.
6864
- Developers already working with the generated Box Java SDK previously available under the [Box Java SDK Gen repository](https://github.com/box/box-java-sdk-gen).
6965

66+
## Deprecation of `com.box.sdk`
67+
68+
The `com.box.sdk` package will be marked as deprecated, will receive only bug fixes and security patches, and reach end of support in 2027.
69+
All new features and support for new Box APIs will be provided exclusively in the `com.box.sdkgen` package.
70+
7071
## Which Version Should I Use?
7172

7273
| Scenario | Recommended Version | Example gradle dependency |
@@ -78,6 +79,7 @@ Version v10 is intended for:
7879

7980
For full guidance on SDK versioning, see the [Box SDK Versioning Guide](https://developer.box.com/guides/tooling/sdks/sdk-versioning/).
8081

82+
8183
# Installing
8284

8385
The SDK is available on [Maven Central Repository](https://central.sonatype.com/artifact/com.box/box-java-sdk).
@@ -221,7 +223,7 @@ We highly recommend upgrading to the latest SDK major release at the earliest co
221223
| Version | Supported Environments | State | First Release | EOL/Terminated |
222224
|---------|---------------------------------------------------------|-----------|---------------|----------------|
223225
| 10 | Java 8 and up | Supported | 17 Sep 2025 | TBD |
224-
| 5 | Java 8 and up | Supported | 23 Oct 2025 | 2027 |
226+
| 5 | Java 8 and up | Supported | 23 Oct 2025 | 2027 or v6 is released |
225227
| 4 | Java 8 and up | Supported | 17 Jan 2023 | 23 Oct 2025 |
226228
| 3 | Java 8 and up | EOL | 17 Jan 2022 | 17 Jan 2023 |
227229
| 2 | | EOL | 07 Jan 2016 | 17 Jan 2022 |

0 commit comments

Comments
 (0)