SDK consolidated version release #846

SowaProgramuje · 2025-10-17T14:04:43Z

Description

Please include a summary of the change and which issue is fixed.

If you are a Boxer, please also reference the related DDOC or APIWG tickets.
If you do not have a related Jira ticket and this is more than a bug fix, then
create one now.

Fixes # (issue)
Re DDOC-# (Jira ticket)
Re APIWG-# (Jira ticket)

Checklist

My code follows the style guidelines of this project
I have performed a self-review of my own changes
I have run yarn lint to make sure my changes pass all linters
I have pulled the latest changes from the upstream developer branch

Contribution guidelines

For contribution guidelines, styleguide, and other helpful information please
see the CONTRIBUTING.md file in the root of this project.

lukaszsocha2 · 2025-10-20T11:22:52Z

content/guides/tooling/sdks/sdk-versioning.md


- `(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. Stay tuned for this upcoming release.
- `v10.0.0` version includes **only the Box Next Generation SDK artifact**. Currently, this version is available as a branch for each SDK repository.
+    **Action** Use the major version which includes consolidated packages. Start leveraging convenience methods, new features thanks to the generated package, and gradually migrate your code base. Check version breakdown for each programming language.


Action is not rendered correctly if you tried to achieve bolding

Is it going to be displayed this way? I don't like that you have to scroll to the right to read it all.

This is component specific pill that we have across the project, I think it makes it more prominent.

lukaszsocha2 · 2025-10-20T11:26:30Z

content/guides/tooling/sdks/sdk-versioning.md

-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.
+    **Action** Use ≥`v10.0.0` of the Box core SDK package.
+  </Tile>
+  <Tile type="info" title="4. No Active Development" href="/guides/tooling/sdks/sdk-versioning/#box-core-sdk-versions-and-artifacts-overview">


I would add one more case:

App using both Box Next Generation SDK and old sdk -> use combined SDK

lukaszsocha2 · 2025-10-20T11:29:21Z

content/guides/tooling/sdks/sdk-versioning.md

+- Swift

-### Migrating from Box Next Generations SDKs to core Box SDK `v10`
+### Migrating from Box Next Generation SDKs to core Box SDK `v10`


Migrating from Box Next Generation SDKs

This is because you can either migrate to v10 ( if you were using just next gen sdk) of combined version (if you were using next gen along with old SDK) - we will have these two case covered in the mogration guide

content/guides/tooling/sdks/sdk-versioning.md

content/guides/tooling/sdks/swift-gen.md

content/guides/tooling/sdks/dotnet-gen.md

mwwoda

~~I guess some links for our migration guides are a bit inconsistent in the SDK repos~~

Nevermind, some migration guides are still not done on our side. But .NET and Swift are ready

lszal

Added a couple of final suggestions.

lszal · 2025-10-22T11:03:34Z

content/guides/tooling/sdks/index.md

-The latest generation Box Python SDK, Box TypeScript
-SDK, Box .NET SDK, and Box Swift SDK are designed to elevate the developer
+`v10` of Python SDK, Box TypeScript
+SDK, Box .NET SDK, and Box Swift SDK is designed to elevate the developer


Suggested change

SDK, Box .NET SDK, and Box Swift SDK is designed to elevate the developer

SDK, Box .NET SDK, and Box Swift SDK are designed to elevate the developer

We are enumerating different SDKs, so we need to have a plural verb here (AND).

lszal · 2025-10-22T11:07:35Z

content/guides/tooling/sdks/sdk-versioning.md

+    **Action** Replace the library name in your package manager with Box core SDK package (≥`v10.0.0`). Check migration guides for detailed instructions.
+  </Tile>
+  <Tile type="branch" title="3. Existing App - Box core SDK and the Box Next Generation SDK" href="/guides/tooling/sdks/sdk-versioning/#migration-to-the-generated-package">
+    If you have an existing application that relies both on Box core SDK and  Next Generation SDK:


Suggested change

If you have an existing application that relies both on Box core SDK and Next Generation SDK:

If you have an existing application that relies both on the Box core SDK and the Next Generation SDK:

lszal · 2025-10-22T11:07:44Z

content/guides/tooling/sdks/sdk-versioning.md

-Box core SDKs and Box Next Generation SDKs were created as separate libraries. Going forward, the Box core SDK artifacts will include:
+<TileGrid rows="2">
+  <Tile type="cog" title="1. Existing App - Box core SDK" href="/guides/tooling/sdks/sdk-versioning/#migration-to-the-generated-package">
+    If you have an existing application that relies on Box core SDK and you wish to further develop your project:


Suggested change

If you have an existing application that relies on Box core SDK and you wish to further develop your project:

If you have an existing application that relies on the Box core SDK and you wish to further develop your project:

lszal · 2025-10-22T11:08:14Z

content/guides/tooling/sdks/sdk-versioning.md

-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`). Object imports for most SDKs will persist the same and your code will work as-is; the TypeScript SDK requires additional steps for migrating. Check the section below for detailed guides.
-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 a 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.
+    **Action** Use the major version which includes consolidated packages.


Suggested change

**Action** Use the major version which includes consolidated packages.

**Action** Use the major version that includes consolidated packages.

lszal · 2025-10-22T11:08:26Z

content/guides/tooling/sdks/sdk-versioning.md


- `(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. Stay tuned for this upcoming release.
- `v10.0.0` version includes **only the Box Next Generation SDK artifact**. Currently, this version is available as a branch for each SDK repository.
+    **Action** Use the major version which includes consolidated packages. Start using convenience methods and new features from the generated package, and gradually migrate your codebase.


Suggested change

**Action** Use the major version which includes consolidated packages. Start using convenience methods and new features from the generated package, and gradually migrate your codebase.

**Action** Use the major version that includes consolidated packages. Start using convenience methods and new features from the generated package, and gradually migrate your codebase.

lszal · 2025-10-22T11:09:04Z

content/guides/tooling/sdks/sdk-versioning.md

+  <Tile type="info" title="5. No Active Development" href="/guides/tooling/sdks/sdk-versioning/#box-core-sdk-versions-and-artifacts-overview">
+    If you have an existing application that you don't plan to change:
+
+    **Action** Ensure your package manager includes the specific version of the SDK version to prevent accidental updates. We strongly recommend upgrading to the major version, which includes consolidated packages, to receive ongoing security patches and improvements.


Suggested change

**Action** Ensure your package manager includes the specific version of the SDK version to prevent accidental updates. We strongly recommend upgrading to the major version, which includes consolidated packages, to receive ongoing security patches and improvements.

**Action** Ensure your package manager includes the specific SDK version to prevent accidental updates. We strongly recommend upgrading to the major version, which includes consolidated packages, to receive ongoing security patches and improvements.

lszal · 2025-10-22T11:10:13Z

content/guides/tooling/sdks/sdk-versioning.md

+
+### Migration from Box Next Generation SDKs
+
+Follow detailed migration guides to migrate from from the Box Next Generation SDKs to the Box core SDK `v10`:


Suggested change

Follow detailed migration guides to migrate from from the Box Next Generation SDKs to the Box core SDK `v10`:

Follow detailed migration guides to migrate from the Box Next Generation SDKs to the Box core SDK `v10`:

lszal

Some minor changes.

lszal · 2025-10-23T08:36:29Z

content/guides/tooling/sdks/sdk-versioning.md

 # Box SDK versioning strategy

-As of September 17, 2025 Box Next Generation SDKs are no longer supported as separate artifacts.
+the Box core SDKs and the Box Next Generation SDKs were initially created as separate libraries. However, in keeping with industry best practices, **we are consolidating the Box Next Generation SDKs and the 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 older versions of the Box core SDKs, which were maintained manually.


Suggested change

the Box core SDKs and the Box Next Generation SDKs were initially created as separate libraries. However, in keeping with industry best practices, **we are consolidating the Box Next Generation SDKs and the 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 older versions of the Box core SDKs, which were maintained manually.

The Box core SDKs and the Box Next Generation SDKs were initially created as separate libraries. However, in keeping with industry best practices, **we are consolidating the Box Next Generation SDKs and the 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 older versions of the Box core SDKs, which were maintained manually.

lszal · 2025-10-23T08:37:52Z

content/guides/tooling/sdks/sdk-versioning.md

+To facilitate this migration process, there are two actively maintained major Box core SDK versions:

-## Why we are making this change
+- **A major version that follows sequential versioning for each SDK artifact. includes:** the manually maintained package and the generated one. This SDK version enables leveraging coexisting packages at the same time, and serves as a transition phase. Support for the consolidated version of each Box core SDKs will continue in 2027.


Suggested change

- **A major version that follows sequential versioning for each SDK artifact. includes:** the manually maintained package and the generated one. This SDK version enables leveraging coexisting packages at the same time, and serves as a transition phase. Support for the consolidated version of each Box core SDKs will continue in 2027.

- **A major version that follows sequential versioning for each SDK artifact and includes ** the manually maintained package and the generated one. This SDK version enables leveraging coexisting packages at the same time, and serves as a transition phase. Support for the consolidated version of each Box core SDKs will continue in 2027.

"in 2027" or "until 2027"?

lszal · 2025-10-23T08:38:13Z

content/guides/tooling/sdks/sdk-versioning.md


-## Why we are making this change
+- **A major version that follows sequential versioning for each SDK artifact. includes:** the manually maintained package and the generated one. This SDK version enables leveraging coexisting packages at the same time, and serves as a transition phase. Support for the consolidated version of each Box core SDKs will continue in 2027.
+- `v10` includes **only the generated package**.


Suggested change

- `v10` includes **only the generated package**.

- `v10` that includes **only the generated package**.

…ined

lszal

Tech Pubs approved.

SowaProgramuje added 30 commits February 18, 2025 18:04

Resolve conflicts

ae31a2a

Fix conflict

635c0f8

Merge branch 'main' of github.com:box/developer.box.com

f7b6430

Merge branch 'main' of github.com:box/developer.box.com

dcb6028

Merge branch 'main' of github.com:box/developer.box.com

2d6a3b9

Merge branch 'main' of github.com:box/developer.box.com

c3a5cbb

Merge branch 'main' of github.com:box/developer.box.com

d389c5f

Merge branch 'main' of github.com:box/developer.box.com

06b13d3

Merge branch 'main' of github.com:box/developer.box.com

17517d3

Merge branch 'main' of github.com:box/developer.box.com

121e0a5

Merge branch 'main' of github.com:box/developer.box.com

b19d269

Merge branch 'main' of github.com:box/developer.box.com

eecd9ab

Merge branch 'main' of github.com:box/developer.box.com

2717007

Merge branch 'main' of github.com:box/developer.box.com

dd296a0

Merge branch 'main' of github.com:box/developer.box.com

76d277e

Merge branch 'main' of github.com:box/developer.box.com

f6d4f13

Merge branch 'main' of github.com:box/developer.box.com

ac0278f

Merge branch 'main' of github.com:box/developer.box.com

af5e036

Merge branch 'main' of github.com:box/developer.box.com

b7e625a

Merge branch 'main' of github.com:box/developer.box.com

9bb1b01

Merge branch 'main' of github.com:box/developer.box.com

f296713

Merge branch 'main' of github.com:box/developer.box.com

e8f860d

Merge branch 'main' of github.com:box/developer.box.com

4c2f423

Merge branch 'main' of github.com:box/developer.box.com

374bbe0

Merge branch 'main' of github.com:box/developer.box.com

c40bae8

Merge branch 'main' of github.com:box/developer.box.com

7af9fdb

Merge branch 'main' of github.com:box/developer.box.com

d5ca547

Add content changes

b8b9770

Improve creating mcp instructions

114f781

Change pill colors

128a25c

lukaszsocha2 reviewed Oct 20, 2025

View reviewed changes

mwwoda reviewed Oct 20, 2025

View reviewed changes

content/guides/tooling/sdks/sdk-versioning.md Show resolved Hide resolved

mwwoda reviewed Oct 20, 2025

View reviewed changes

content/guides/tooling/sdks/sdk-versioning.md Outdated Show resolved Hide resolved

mwwoda reviewed Oct 20, 2025

View reviewed changes

content/guides/tooling/sdks/sdk-versioning.md Outdated Show resolved Hide resolved

mwwoda reviewed Oct 20, 2025

View reviewed changes

content/guides/tooling/sdks/swift-gen.md Outdated Show resolved Hide resolved

mwwoda reviewed Oct 20, 2025

View reviewed changes

content/guides/tooling/sdks/dotnet-gen.md Outdated Show resolved Hide resolved

mwwoda reviewed Oct 20, 2025

View reviewed changes

SowaProgramuje added 7 commits October 20, 2025 14:22

Update links and copy

d361c6f

Address change requests

dba7f87

Add joined SDK case

5486654

Update links and tiles

d576c93

Fix wording

3a5ec2c

Update icons

cf4bdd6

Update timing info

d24f45e

SowaProgramuje requested a review from lszal October 22, 2025 10:03

lszal requested changes Oct 22, 2025

View reviewed changes

Adress review comments

e82ac2b

SowaProgramuje requested a review from lszal October 22, 2025 11:29

SowaProgramuje added 5 commits October 22, 2025 13:30

Add artile

0f24e68

Improve migration guides section

1fa1893

Improve recommended actions

1307847

Fix typo

03aedb9

Update migration guide links

1065e9a

lszal requested changes Oct 23, 2025

View reviewed changes

SowaProgramuje added 2 commits October 23, 2025 11:07

Address content review change requests

a90677e

Merge branch 'main' of github.com:box/developer.box.com into sdk-comb…

2dbcde1

…ined

lszal approved these changes Oct 23, 2025

View reviewed changes

SowaProgramuje merged commit 5ae8de5 into main Oct 23, 2025
11 checks passed

	SDK, Box .NET SDK, and Box Swift SDK is designed to elevate the developer
	SDK, Box .NET SDK, and Box Swift SDK are designed to elevate the developer

	If you have an existing application that relies both on Box core SDK and Next Generation SDK:
	If you have an existing application that relies both on the Box core SDK and the Next Generation SDK:

	Action Use the major version which includes consolidated packages.
	Action Use the major version that includes consolidated packages.

	Action Ensure your package manager includes the specific version of the SDK version to prevent accidental updates. We strongly recommend upgrading to the major version, which includes consolidated packages, to receive ongoing security patches and improvements.
	Action Ensure your package manager includes the specific SDK version to prevent accidental updates. We strongly recommend upgrading to the major version, which includes consolidated packages, to receive ongoing security patches and improvements.


		### Migration from Box Next Generation SDKs

		Follow detailed migration guides to migrate from from the Box Next Generation SDKs to the Box core SDK `v10`:

	- A major version that follows sequential versioning for each SDK artifact. includes: the manually maintained package and the generated one. This SDK version enables leveraging coexisting packages at the same time, and serves as a transition phase. Support for the consolidated version of each Box core SDKs will continue in 2027.
	- A major version that follows sequential versioning for each SDK artifact and includes the manually maintained package and the generated one. This SDK version enables leveraging coexisting packages at the same time, and serves as a transition phase. Support for the consolidated version of each Box core SDKs will continue in 2027.

	- `v10` includes only the generated package.
	- `v10` that includes only the generated package.

SDK consolidated version release #846

SDK consolidated version release #846

Uh oh!

Conversation

SowaProgramuje commented Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Contribution guidelines

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Migrating from Box Next Generation SDKs

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mwwoda left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lszal left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lszal left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lszal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

SowaProgramuje commented Oct 17, 2025 •

edited

Loading

mwwoda left a comment •

edited

Loading