Skip to content

docs: add error code 40025 for unsupported SDK API #3386

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
umair-ably wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add error code 40025 for unsupported SDK API #3386

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/pages/docs/platform/errors/codes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,14 @@ Examples of this error include attempting to use [channel objects](/docs/liveobj
Resolution: The following steps can help resolve this issue:
* Upgrade the Ably SDK to a version that supports the requested operation.

## 40025: Unsupported SDK API <a id="40025"/>

This error occurs when an SDK method is called using an API shape that is no longer supported.
Copy link
Copy Markdown
Contributor

@AndyTWF AndyTWF May 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Specifically API shape, or just "a version of the API"?

Copy link
Copy Markdown
Contributor Author

@umair-ably umair-ably May 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm leaning towards shape because "version of the API" implies we're talking about deprecated versions and not individual deprecated APIs (which this error code can also apply to)


An example of this error is calling an ably-js v2 method using the v1 Node-style callback signature. The v2 SDK is Promise-based and no longer accepts a trailing callback argument. See the [ably-js v2 migration guide](https://github.com/ably/ably-js/blob/main/docs/migration-guides/v2/lib.md) for details on migrating from v1 callbacks to Promises.

Resolution: Update the call site to use the supported API for your SDK and version.

## 40030: Invalid publish request (unspecified) <a id="40030"/>

This error occurs when a [publish request](/docs/pub-sub#publish) is malformed.
Expand Down