Skip to content

[DX-631 & DX-812] Redirect existing Pub/Sub JavaScript API references #3501

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

Merged
m-hulbert merged 7 commits into from
Jul 30, 2026
Merged

[DX-631 & DX-812] Redirect existing Pub/Sub JavaScript API references #3501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fef83c4
Add JavaScript migration banners to legacy Pub/Sub API reference pages
m-hulbert Jul 27, 2026
bc5a87d
Point JavaScript-context links at the new Pub/Sub JS API reference
m-hulbert Jul 27, 2026
9ee8b30
Route JS/Node readers to the new API reference from mixed-language pages
m-hulbert Jul 27, 2026
4502940
Remove JavaScript and Node.js from legacy Pub/Sub API reference langu…
m-hulbert Jul 27, 2026
5993d9a
Strip JavaScript and Node.js content from legacy Realtime SDK reference
m-hulbert Jul 27, 2026
5436740
Strip JavaScript and Node.js content from legacy REST SDK reference
m-hulbert Jul 27, 2026
07cce8f
Fix dead anchors in links to the new JavaScript API reference
m-hulbert Jul 27, 2026
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
92 changes: 22 additions & 70 deletions src/data/nav/pubsub.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -483,17 +483,17 @@ export default {
{
name: 'Constructor',
link: '/docs/api/realtime-sdk',
languages: ['javascript', 'nodejs', 'ruby', 'java', 'swift', 'objc', 'csharp', 'flutter'],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp', 'flutter'],
},
{
name: 'Connection',
link: '/docs/api/realtime-sdk/connection',
languages: ['javascript', 'nodejs', 'ruby', 'java', 'swift', 'objc', 'csharp', 'flutter'],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp', 'flutter'],
},
{
name: 'Channels',
link: '/docs/api/realtime-sdk/channels',
languages: ['javascript', 'nodejs', 'ruby', 'java', 'swift', 'objc', 'csharp', 'flutter'],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp', 'flutter'],
},
{
name: 'Channel Metadata',
Expand All @@ -502,47 +502,47 @@ export default {
{
name: 'Messages',
link: '/docs/api/realtime-sdk/messages',
languages: ['javascript', 'nodejs', 'ruby', 'java', 'swift', 'objc', 'csharp', 'flutter'],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp', 'flutter'],
},
{
name: 'Presence',
link: '/docs/api/realtime-sdk/presence',
languages: ['javascript', 'nodejs', 'ruby', 'java', 'swift', 'objc', 'csharp'],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp'],
},
{
name: 'Authentication',
link: '/docs/api/realtime-sdk/authentication',
languages: ['javascript', 'nodejs', 'ruby', 'java', 'swift', 'objc', 'csharp'],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp'],
},
{
name: 'History',
link: '/docs/api/realtime-sdk/history',
languages: ['javascript', 'nodejs', 'ruby', 'java', 'swift', 'objc', 'csharp'],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp'],
},
{
name: 'Push Notifications - Admin',
link: '/docs/api/realtime-sdk/push-admin',
languages: ['javascript', 'nodejs', 'ruby', 'java', 'swift', 'objc', 'python', 'android'],
languages: ['ruby', 'java', 'swift', 'objc', 'python', 'android'],
},
{
name: 'Push Notifications - Devices',
link: '/docs/api/realtime-sdk/push',
languages: ['javascript', 'nodejs', 'swift', 'objc', 'android'],
languages: ['swift', 'objc', 'android'],
},
{
name: 'Encryption',
link: '/docs/api/realtime-sdk/encryption',
languages: ['javascript', 'nodejs', 'ruby', 'java', 'swift', 'objc', 'csharp'],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp'],
},
{
name: 'Statistics',
link: '/docs/api/realtime-sdk/statistics',
languages: ['javascript', 'nodejs', 'ruby', 'java', 'swift', 'objc', 'csharp'],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp'],
},
{
name: 'Types',
link: '/docs/api/realtime-sdk/types',
languages: ['javascript', 'nodejs', 'ruby', 'java', 'swift', 'objc', 'csharp', 'flutter', 'go'],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp', 'flutter', 'go'],
},
],
},
Expand All @@ -552,36 +552,12 @@ export default {
{
name: 'Constructor',
link: '/docs/api/rest-sdk',
languages: [
'javascript',
'nodejs',
'ruby',
'java',
'swift',
'objc',
'csharp',
'flutter',
'go',
'python',
'php',
],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp', 'flutter', 'go', 'python', 'php'],
},
{
name: 'Channels',
link: '/docs/api/rest-sdk/channels',
languages: [
'javascript',
'nodejs',
'ruby',
'java',
'swift',
'objc',
'csharp',
'flutter',
'go',
'python',
'php',
],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp', 'flutter', 'go', 'python', 'php'],
},
{
name: 'Channel Status',
Expand All @@ -590,66 +566,42 @@ export default {
{
name: 'Messages',
link: '/docs/api/rest-sdk/messages',
languages: [
'javascript',
'nodejs',
'ruby',
'java',
'swift',
'objc',
'csharp',
'flutter',
'go',
'python',
'php',
],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp', 'flutter', 'go', 'python', 'php'],
},
{
name: 'Presence',
link: '/docs/api/rest-sdk/presence',
languages: ['javascript', 'nodejs', 'ruby', 'java', 'swift', 'objc', 'csharp', 'go', 'python', 'php'],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp', 'go', 'python', 'php'],
},
{
name: 'Authentication',
link: '/docs/api/rest-sdk/authentication',
languages: ['javascript', 'nodejs', 'ruby', 'java', 'swift', 'objc', 'csharp', 'go', 'python', 'php'],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp', 'go', 'python', 'php'],
},
{
name: 'History',
link: '/docs/api/rest-sdk/history',
languages: ['javascript', 'nodejs', 'ruby', 'java', 'swift', 'objc', 'csharp', 'go', 'python', 'php'],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp', 'go', 'python', 'php'],
},
{
name: 'Push Notifications - Admin',
link: '/docs/api/rest-sdk/push-admin',
languages: ['javascript', 'nodejs', 'ruby', 'java', 'swift', 'objc', 'php', 'android'],
languages: ['ruby', 'java', 'swift', 'objc', 'php', 'android'],
},
{
name: 'Encryption',
link: '/docs/api/rest-sdk/encryption',
languages: ['javascript', 'nodejs', 'ruby', 'java', 'swift', 'objc', 'csharp', 'go', 'python', 'php'],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp', 'go', 'python', 'php'],
},
{
name: 'Statistics',
link: '/docs/api/rest-sdk/statistics',
languages: ['javascript', 'nodejs', 'ruby', 'java', 'swift', 'objc', 'csharp', 'go', 'python', 'php'],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp', 'go', 'python', 'php'],
},
{
name: 'Types',
link: '/docs/api/rest-sdk/types',
languages: [
'javascript',
'nodejs',
'ruby',
'java',
'swift',
'objc',
'csharp',
'flutter',
'go',
'python',
'php',
],
languages: ['ruby', 'java', 'swift', 'objc', 'csharp', 'flutter', 'go', 'python', 'php'],
},
],
},
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/ai-transport/api/react/core/use-ably-messages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ This hook must be used within a [`ClientSessionProvider`](/docs/ai-transport/api

The accumulated raw Ably messages in chronological order. Resets to an empty array when the resolved session changes.

Each `InboundMessage` carries the wire fields you would see from `channel.subscribe`: `name`, `data`, `serial`, `clientId`, `extras`, `timestamp`, and so on. The [Ably SDK reference](/docs/pub-sub/api/javascript/realtime/messages#message) documents the full type.
Each `InboundMessage` carries the wire fields you would see from `channel.subscribe`: `name`, `data`, `serial`, `clientId`, `extras`, `timestamp`, and so on. The [Ably SDK reference](/docs/pub-sub/api/javascript/realtime/message) documents the full type.

## Example <a id="example"/>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/ai-transport/features/token-streaming.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ By default, Ably delivers a single response stream at 25 messages per second, or

### Configure rollup behaviour <a id="configure-rollup"/>

On the client, set the rollup window for a connection using the `appendRollupWindow` [transport parameter](/docs/api/realtime-sdk#client-options):
On the client, set the rollup window for a connection using the `appendRollupWindow` [transport parameter](/docs/pub-sub/api/javascript/realtime/realtime-client#constructor-params):

| `appendRollupWindow` | Maximum message rate for a single response |
|---|---|
Expand Down
Loading
Loading