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.

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

Change naming of the id field of namespace resource to make it more self-explanatory #47

Open
kavalerov opened this issue Aug 19, 2022 · 2 comments
Labels
breaking Backwards incompatible changes made to the public API. enhancement New feature or improved functionality.

Comments

@kavalerov
Copy link
Contributor

kavalerov commented Aug 19, 2022

Currently the field is called ID, based on the naming adopted in the Control API.

This name is not very self-explanatory, as according to the documentation it is

"The namespace or channel name that the channel rule will apply to. For example, if you specify namespace the namespace will be set to namespace and will match with channels namespace:* and namespace."

On the Namespaces endpoint, when we want to create a new namespace the field that contains the channel name or namespace filter is called id: https://ably.com/docs/api/control-api#tag/namespaces/paths/~1apps~1{app_id}~1namespaces/post. Similarly it is called id when we just get a list of namespaces.

This seems to be a very confusing name for what it is. This also additionally adds to the confusion that the same functionality in the dashboard is called “Channel Rules”, and corresponding field is called “Namespace or Channel ID” in the UI.

┆Issue is synchronized with this Jira Task by Unito

@kavalerov
Copy link
Contributor Author

@sync-by-unito
Copy link

sync-by-unito bot commented Nov 24, 2022

➤ Automation for Jira commented:

The link to the corresponding Jira issue is https://ably.atlassian.net/browse/SDK-3043

@QuintinWillison QuintinWillison added enhancement New feature or improved functionality. breaking Backwards incompatible changes made to the public API. labels Dec 8, 2022
@sync-by-unito sync-by-unito bot closed this as completed Jan 22, 2025
@jamienewcomb jamienewcomb reopened this Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking Backwards incompatible changes made to the public API. enhancement New feature or improved functionality.
Development

No branches or pull requests

3 participants