From fab9ac22c65331fdbfce61e7ae2f617eed17e0fd Mon Sep 17 00:00:00 2001 From: Olga Stefaniuk Date: Tue, 5 Aug 2025 10:10:33 +0200 Subject: [PATCH 1/2] Update sdk guides --- content/guides/tooling/sdks/index.md | 2 +- content/guides/tooling/sdks/sdk-versioning.md | 2 +- content/pages/sdks-and-tools/index.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/content/guides/tooling/sdks/index.md b/content/guides/tooling/sdks/index.md index ebd4fc818..e46d357ff 100644 --- a/content/guides/tooling/sdks/index.md +++ b/content/guides/tooling/sdks/index.md @@ -65,7 +65,7 @@ Refer to [this][android-docs] documentation for more details. In keeping with industry best practices, we are consolidating the Next Gen and legacy SDKs into a single package. This makes migration efforts much easier and allows you to seamlessly add new capabilities to existing applications still powered by the legacy SDKs. - Ultimately, the Next Generation SDKs will replace the current legacy SDKs as the latest major version release. Read more to learn the details. + Ultimately, the Next Generation SDKs will replace the current legacy SDKs as the latest major version release. To learn more visit our SDK [versioning strategy document][versioning] diff --git a/content/guides/tooling/sdks/sdk-versioning.md b/content/guides/tooling/sdks/sdk-versioning.md index d2199bd62..c41ebb683 100644 --- a/content/guides/tooling/sdks/sdk-versioning.md +++ b/content/guides/tooling/sdks/sdk-versioning.md @@ -19,7 +19,7 @@ In mid-August, we will be deprecating the Box Next Gen SDKs in its current form. In keeping with industry best practices, we are consolidating the Next Gen and legacy SDKs into a single package. This makes migration efforts much easier and allows you to seamlessly add new capabilities to existing applications still powered by the legacy SDKs. -Ultimately, the Next Generation SDKs will replace the current legacy SDKs as the latest major version release. Read more to learn the details. +Ultimately, the Next Generation SDKs will replace the current legacy SDKs as the latest major version release. ## How it will work diff --git a/content/pages/sdks-and-tools/index.md b/content/pages/sdks-and-tools/index.md index 0ff230084..3574d434f 100644 --- a/content/pages/sdks-and-tools/index.md +++ b/content/pages/sdks-and-tools/index.md @@ -71,7 +71,7 @@ Refer to [this][android-docs] documentation for more details. In keeping with industry best practices, we are consolidating the Next Gen and legacy SDKs into a single package. This makes migration efforts much easier and allows you to seamlessly add new capabilities to existing applications still powered by the legacy SDKs. - Ultimately, the Next Generation SDKs will replace the current legacy SDKs as the latest major version release. Read more to learn the details. + Ultimately, the Next Generation SDKs will replace the current legacy SDKs as the latest major version release. To learn more visit our SDK [versioning strategy document][versioning] From 0921dfa2624774d5a156b8fbd34b194182a1d205 Mon Sep 17 00:00:00 2001 From: Olga Stefaniuk Date: Mon, 15 Sep 2025 14:06:12 +0200 Subject: [PATCH 2/2] Update SDK messaging --- content/guides/tooling/sdks/dotnet-gen.md | 16 +++---- content/guides/tooling/sdks/index.md | 16 +++---- content/guides/tooling/sdks/python-gen.md | 8 +++- content/guides/tooling/sdks/sdk-versioning.md | 46 +++++++++---------- content/guides/tooling/sdks/swift-gen.md | 14 +++--- content/guides/tooling/sdks/typescript-gen.md | 10 ++-- content/pages/sdks-and-tools/index.md | 23 ++++------ 7 files changed, 67 insertions(+), 66 deletions(-) diff --git a/content/guides/tooling/sdks/dotnet-gen.md b/content/guides/tooling/sdks/dotnet-gen.md index 4bc2f906b..36d34d628 100644 --- a/content/guides/tooling/sdks/dotnet-gen.md +++ b/content/guides/tooling/sdks/dotnet-gen.md @@ -14,10 +14,14 @@ alias_paths: [] # Deprecated .NET SDK - In mid-August, we will be deprecating the Box Next Gen SDKs in its current form. **Don’t worry, your existing code will continue to work without changes**. + As of September 17, 2025 Box Next Generation SDKs are no longer supported as separate artifacts. - To learn more visit our SDK [versioning strategy document][versioning] - + Don’t worry, your existing code will continue to work without changes. You can still use your applications based on Box Next Generation SDK with no impact, but you won't receive new features, updates, or bug fixes. + + All future development, including new features and updates for Next Generation SDKs, will now be delivered through Box core SDKs starting with version `v10`. + + For more details, see our [SDK versioning strategy document][versioning]. + - Learn more about .NET SDK on GitHub - - To install the .NET SDK in the .NET framework, run the following command using the [Nuget][nuget] package manager. @@ -37,4 +37,4 @@ PM> Install-Package Box.Sdk.Gen ``` [nuget]: https://www.nuget.org/ -[versioning]: g://tooling/sdks/sdk-versioning +[versioning]: g://tooling/sdks/sdk-versioning \ No newline at end of file diff --git a/content/guides/tooling/sdks/index.md b/content/guides/tooling/sdks/index.md index e46d357ff..1ad004360 100644 --- a/content/guides/tooling/sdks/index.md +++ b/content/guides/tooling/sdks/index.md @@ -10,7 +10,7 @@ alias_paths: - /docs/community-supported-projects --- -# SDKs +# Box SDKs Box offers a set of SDKs you can use to build your application. @@ -30,7 +30,7 @@ with partial API parity lack some functionality while we work on bringing these projects to full parity. -The table lists legacy Box SDKs that you can use when building your +The table lists Box SDKs that you can use when building your applications. For latest API support and features, use the next generation SDKs. @@ -56,18 +56,18 @@ build apps on Android. Refer to [this][android-docs] documentation for more details. -## Next generation SDKs +## Next Generation SDKs - In mid-August, we will be deprecating the Box Next Gen SDKs in its current form. **Don’t worry, your existing code will continue to work without changes**. + As of September 17, 2025 Box Next Generation SDKs are no longer supported as separate artifacts. - ## Why we are making this change + Don't worry, your existing code will continue to work without changes. You can still use your applications based on Box Next Generation SDK with no impact, but you won't receive new features, updates, or bug fixes. - In keeping with industry best practices, we are consolidating the Next Gen and legacy SDKs into a single package. This makes migration efforts much easier and allows you to seamlessly add new capabilities to existing applications still powered by the legacy SDKs. + In keeping with industry best practices, we are consolidating the Box Next Generation SDKs and Box core SDKs into a single package for each programming language. This makes migration efforts much easier and allows to seamlessly add new capabilities to existing applications still powered by the manually maintained Box core SDKs. - Ultimately, the Next Generation SDKs will replace the current legacy SDKs as the latest major version release. + Box Next Generation SDKs are now available as the latest major version release (`v10`) of Box core SDKs. - To learn more visit our SDK [versioning strategy document][versioning] + For more details, see our [SDK versioning strategy document][versioning]. The latest generation Box Python SDK, Box TypeScript diff --git a/content/guides/tooling/sdks/python-gen.md b/content/guides/tooling/sdks/python-gen.md index 2391e51dd..3478041b1 100644 --- a/content/guides/tooling/sdks/python-gen.md +++ b/content/guides/tooling/sdks/python-gen.md @@ -14,9 +14,13 @@ alias_paths: [] # Deprecated Python SDK - In mid-August, we will be deprecating the Box Next Gen SDKs in its current form. **Don’t worry, your existing code will continue to work without changes**. + As of September 17, 2025 Box Next Generation SDKs are no longer supported as separate artifacts. - To learn more visit our SDK [versioning strategy document][versioning] + Don’t worry, your existing code will continue to work without changes. You can still use your applications based on Box Next Generation SDK with no impact, but you won't receive new features, updates, or bug fixes. + + All future development, including new features and updates for Next Generation SDKs, will now be delivered through Box core SDKs starting with version `v10`. + + For more details, see our [SDK versioning strategy document][versioning]. You can use the **auto-generated** Box Python SDK to call Box APIs in a Python project. diff --git a/content/guides/tooling/sdks/sdk-versioning.md b/content/guides/tooling/sdks/sdk-versioning.md index c41ebb683..5414fd5aa 100644 --- a/content/guides/tooling/sdks/sdk-versioning.md +++ b/content/guides/tooling/sdks/sdk-versioning.md @@ -13,48 +13,48 @@ alias_paths: [] # Box SDK versioning strategy -In mid-August, we will be deprecating the Box Next Gen SDKs in its current form. Don’t worry, your existing code will continue to work without changes. +As of September 17, 2025 Box Next Generation SDKs are no longer supported as separate artifacts. + +Don’t worry, your existing code will continue to work without changes. You can still use your applications based on Box Next Generation SDK with no impact, but you won't receive new features, updates, or bug fixes. ## Why we are making this change -In keeping with industry best practices, we are consolidating the Next Gen and legacy SDKs into a single package. This makes migration efforts much easier and allows you to seamlessly add new capabilities to existing applications still powered by the legacy SDKs. +In keeping with industry best practices, we are consolidating the Box Next Generation SDKs and Box core SDKs into a single package for each programming language. This makes migration efforts much easier and allows seamless addition of new capabilities to existing applications still powered by Box core SDKs, which were maintained manually. -Ultimately, the Next Generation SDKs will replace the current legacy SDKs as the latest major version release. +All future development, including new features and updates for Next Generation SDKs, will now be delivered through Box core SDKs starting with version `v10`. ## How it will work -Currently, the legacy SDKs and the Next Gen SDKs are separate libraries. Going forward, two new major versions will be available within the legacy SDK artifact: +Box core SDKs and Box Next Generation SDKs were created as separate libraries. Going forward, within the Box core SDK artifacts will include: -- `(n+1)` major version that includes legacy SDK and Next Gen SDK artifacts. This version enables you to leverage coexisting artifacts at the same time, and serve as a transition phase. -- `v10.0.0` version that includes only the Next Gen SDK artifact. +- `(n+1)` major version will include manually maintained **Box core SDK and Box Next Generation SDK artifacts**. This version enables leveraging coexisting artifacts at the same time, and serve as a transition phase. +- `v10.0.0` version includes **only the Box Next Generation SDK artifact**. ## How to decide -1. If you are writing a new application, use the latest major release of the SDK package. -2. If you have an existing application relying on the **Next Gen SDK** and you wish to further develop your project, replace the name of this library in the package manager with the latest major release of the legacy SDK package (`v10.0.0`). Most SDKs object imports persist the same and your code will work as-is; only the TypeScript SDK requires additional steps for migrating. -3. If you have an existing application relying on the **legacy SDK** and you wish to further develop your project, once released, bump the library version by one major release. See the table above, for detailed breakdown of recommended versions. +1. If you are creating a new application, use `v10` of the Box core SDK package. +2. If you have an existing application relying on the **Box Next Generation SDK** and you wish to further develop your project, replace the name of this library in the package manager with the Box core SDK package (`v10.0.0`). Most SDKs object imports persist the same and your code will work as-is; only the TypeScript SDK requires additional steps for migrating. +3. If you have an existing application relying on **Box core SDK** and you wish to further develop your project, once released, bump the library version by one major release. See the table above, for detailed breakdown of recommended versions. 4. If you have an existing application that you don’t plan to change, ensure your package manager includes the version of SDK you are using to prevent an accidental rebuild that pulls in a version you aren’t expecting. ## Versioning overview ### Box SDK versions and artifacts -| SDK Package Name | Current latest version | Combined legacy and Next Gen artifacts | Next Gen SDK artifact | -|--------------------|---------|--------|----------| -| `box-node-sdk` | `v3.8.2` | `v4.0.0` | `v10.0.0` | -| `box-python-sdk` | `v3.14.0` | `v4.0.0` | `v10.0.0` | -| `box-java-sdk` | `v4.16.3` | `v5.0.0` | `v10.0.0` | -| `box-windows-sdk-v2` | `v5.8.0` | `v6.0.0` | `v10.0.0` | -| `box-ios-sdk` | `v5.6.0` | `v6.0.0` | `v10.0.0` | +| SDK Package Name | Current latest version | Next Gen SDK artifact | +|--------------------|---------|----------| +| `box-node-sdk` | `v3.8.2` | `v10.0.0` | +| `box-python-sdk` | `v3.14.0` | `v10.0.0` | +| `box-java-sdk` | `v4.16.3` | `v10.0.0` | +| `box-windows-sdk-v2` | `v5.8.0` | `v10.0.0` | +| `box-ios-sdk` | `v5.6.0` | `v10.0.0` | ### Box Next Gen SDK deprecation status | SDK Package Name | Current latest version | Note |------------------|-------------------------|-------| -| `box-typescript-sdk-gen` | `v1.16.0` | deprecation in mid-August 2025, use `box-node-sdk` `v10.0.0` | -| `box-python-sdk-gen` | `v1.15.0` | deprecation in mid-August 2025, use `box-python-sdk` `v10.0.0` | -| `box-java-sdk-gen` | `v0.7.0` | deprecation in mid-August 2025, use `box-java-sdk` `v10.0.0` | -| `box-dotnet-sdk-gen` | `v1.10.0` | deprecation in mid-August 2025, use `box-windows-sdk-v2` `v10.0.0` | -| `box-swift-sdk-gen` | `v0.6.1` | deprecation in mid-August 2025, use `box-ios-sdk` `v10.0.0` | - -Follow the change log and Box Developer blog for further instructions and announcements. +| `box-typescript-sdk-gen` | `v1.19.0` | Deprecated, use `box-node-sdk` `v10.0.0` | +| `box-python-sdk-gen` | `v1.17.0` | Deprecated, use `box-python-sdk` `v10.0.0` | +| `box-java-sdk-gen` | `v0.8.1` | Deprecated, use `box-java-sdk` `v10.0.0` | +| `box-dotnet-sdk-gen` | `v1.12.0` | Deprecated, use `box-windows-sdk-v2` `v10.0.0` | +| `box-swift-sdk-gen` | `v0.6.3` | Deprecated, use `box-ios-sdk` `v10.0.0` | diff --git a/content/guides/tooling/sdks/swift-gen.md b/content/guides/tooling/sdks/swift-gen.md index f1a63fa60..cf3e39d50 100644 --- a/content/guides/tooling/sdks/swift-gen.md +++ b/content/guides/tooling/sdks/swift-gen.md @@ -12,18 +12,18 @@ alias_paths: [] # Deprecated Swift SDK - In mid-August, we will be deprecating the Box Next Gen SDKs in its current form. **Don’t worry, your existing code will continue to work without changes**. + As of September 17, 2025 Box Next Generation SDKs are no longer supported as separate artifacts. - To learn more visit our SDK [versioning strategy document][versioning] - + Don’t worry, your existing code will continue to work without changes. You can still use your applications based on Box Next Generation SDK with no impact, but you won't receive new features, updates, or bug fixes. + + All future development, including new features and updates for Next Generation SDKs, will now be delivered through Box core SDKs starting with version `v10`. + + For more details, see our [SDK versioning strategy document][versioning]. + -Swift SDK is in a Public Beta phase. - - ## Swift Package Manager [Swift Package Manager][spm] is a tool for managing the distribution of Swift code. It is integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies. diff --git a/content/guides/tooling/sdks/typescript-gen.md b/content/guides/tooling/sdks/typescript-gen.md index 20787c074..d371e471f 100644 --- a/content/guides/tooling/sdks/typescript-gen.md +++ b/content/guides/tooling/sdks/typescript-gen.md @@ -14,10 +14,14 @@ alias_paths: [] # Deprecated TypeScript SDK - In mid-August, we will be deprecating the Box Next Gen SDKs in its current form. **Don’t worry, your existing code will continue to work without changes**. + As of September 17, 2025 Box Next Generation SDKs are no longer supported as separate artifacts. - To learn more visit our SDK [versioning strategy document][versioning] - + Don’t worry, your existing code will continue to work without changes. You can still use your applications based on Box Next Generation SDK with no impact, but you won't receive new features, updates, or bug fixes. + + All future development, including new features and updates for Next Generation SDKs, will now be delivered through Box core SDKs starting with version `v10`. + + For more details, see our [SDK versioning strategy document][versioning]. + -### Next generation SDKs +### Next Generation SDKs - In mid-August, we will be deprecating the Box Next Gen SDKs in its current form. **Don’t worry, your existing code will continue to work without changes**. + As of September 17, 2025 Box Next Generation SDKs are no longer supported as separate artifacts. - ## Why we are making this change + Don’t worry, your existing code will continue to work without changes. You can still use your applications based on Box Next Generation SDK with no impact, but you won't receive new features, updates, or bug fixes. - In keeping with industry best practices, we are consolidating the Next Gen and legacy SDKs into a single package. This makes migration efforts much easier and allows you to seamlessly add new capabilities to existing applications still powered by the legacy SDKs. + All future development, including new features and updates for Next Generation SDKs, will now be delivered through Box core SDKs starting with version `v10`. - Ultimately, the Next Generation SDKs will replace the current legacy SDKs as the latest major version release. + For more details, see our [SDK versioning strategy document][versioning]. + - -The latest generation Box Python SDK, Box TypeScript -SDK, .NET SDK, and Swift SDK are designed to elevate the developer -experience and streamline your integration -with the Box Content Cloud. - -Here's what you can expect from the new SDKs: +Here's what you can expect from generated SDKs: - **Full API Support**: New Box SDKs empower developers with complete coverage of the Box API ecosystem. You can access all the latest features and functionalities offered by Box and build feature-rich applications. - **Rapid API Updates**: The new auto-generation development approach allows for adding Box APIs to SDKs at a much faster pace (in a matter of days). This means you can leverage the most up-to-date features in your applications without delay.