Skip to content

Commit 35bc7a9

Browse files
authored
docs: Update README with deprecation information for com.box.sdk (#1516)
1 parent 4b1c6f8 commit 35bc7a9

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
- [Supported versions](#supported-versions)
1717
- [Version v5](#version-v5)
1818
- [Version v10](#version-v10)
19+
- [Deprecation of `com.box.sdk`](#deprecation-of-comboxsdk)
1920
- [Which Version Should I Use?](#which-version-should-i-use)
2021
- [Installing](#installing)
2122
- [Getting Started](#getting-started)
@@ -47,10 +48,6 @@ The `com.box.sdkgen` package is available in two major supported versions: v5 an
4748
In v5 of the Box Java SDK, we are introducing a version that consolidates both the manually written package (`com.box.sdk`)
4849
and the new generated package (`com.box.sdkgen`). This allows developers to use both packages simultaneously within a single project.
4950

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-
5451
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.
5552
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).
5653

@@ -67,6 +64,11 @@ Version v10 is intended for:
6764
- New users of the Box Java SDK.
6865
- 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).
6966

67+
## Deprecation of `com.box.sdk`
68+
69+
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.
70+
All new features and support for new Box APIs will be provided exclusively in the `com.box.sdkgen` package.
71+
7072
## Which Version Should I Use?
7173

7274
| Scenario | Recommended Version | Example gradle dependency |
@@ -218,14 +220,14 @@ We highly recommend upgrading to the latest SDK major release at the earliest co
218220

219221
### Version schedule
220222

221-
| Version | Supported Environments | State | First Release | EOL/Terminated |
222-
|---------|---------------------------------------------------------|-----------|---------------|----------------|
223-
| 10 | Java 8 and up | Supported | 17 Sep 2025 | TBD |
224-
| 5 | Java 8 and up | Supported | 23 Oct 2025 | 2027 |
225-
| 4 | Java 8 and up | Supported | 17 Jan 2023 | 23 Oct 2025 |
226-
| 3 | Java 8 and up | EOL | 17 Jan 2022 | 17 Jan 2023 |
227-
| 2 | | EOL | 07 Jan 2016 | 17 Jan 2022 |
228-
| 1 | | EOL | 15 Apr 2015 | 07 Jan 2016 |
223+
| Version | Supported Environments | State | First Release | EOL/Terminated |
224+
|---------|------------------------|-----------|---------------|------------------------|
225+
| 10 | Java 8 and up | Supported | 17 Sep 2025 | TBD |
226+
| 5 | Java 8 and up | Supported | 23 Oct 2025 | 2027 or v6 is released |
227+
| 4 | Java 8 and up | Supported | 17 Jan 2023 | 23 Oct 2025 |
228+
| 3 | Java 8 and up | EOL | 17 Jan 2022 | 17 Jan 2023 |
229+
| 2 | | EOL | 07 Jan 2016 | 17 Jan 2022 |
230+
| 1 | | EOL | 15 Apr 2015 | 07 Jan 2016 |
229231

230232
# Contributing
231233

0 commit comments

Comments
 (0)