Skip to content
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

Jump to bottom

Channel Params docs are missing inbound occupancy #1492

Open
mattheworiordan opened this issue Jul 17, 2022 · 0 comments
Open

Channel Params docs are missing inbound occupancy #1492

mattheworiordan opened this issue Jul 17, 2022 · 0 comments
Labels
bug A broken link, image etc

Comments

@mattheworiordan
Copy link
Member

mattheworiordan commented Jul 17, 2022 •
edited by ably-sync-bot
Loading

See https://ably.com/docs/realtime/channels#setting-channel-parameters

It incorrectly states:

"The are two parameters that can be specified:... rewind... delta"

Yet there are three sets of channel params (inband occupancy https://ably.com/docs/realtime/inband-occupancy#occupancy-channel-parameter), and I am sure there will be more in future.

In addition, if you go to https://ably.com/docs/realtime/channels/channel-parameters/overview, there is no mention of inband occupancy.

This needs a rethink, we to have a more scalable way of ensuring the docs grow as we add support for channel params.

┆Issue is synchronized with this Jira Bug by Unito
@mattheworiordan mattheworiordan added bug A broken link, image etc api-reference Anything that appears below the API reference blue fold labels Jul 17, 2022
@leggetter leggetter removed the api-reference Anything that appears below the API reference blue fold label Jul 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug A broken link, image etc
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mattheworiordan @leggetter