From c6ef9e3b60f9aaca41cdc8242ccd40bb50637f5c Mon Sep 17 00:00:00 2001 From: sacOO7 Date: Mon, 1 Jul 2024 09:19:42 +0530 Subject: [PATCH 1/3] updated REST and Realtime API limitations with links to active issues --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7fe037639..b4e1be616 100644 --- a/README.md +++ b/README.md @@ -405,18 +405,15 @@ As of release 1.2.0, the following are not implemented and will be covered in fu - [Push notifications admin API](https://ably.com/docs/general/push/admin) is not implemented. -- [JWT authentication](https://ably.com/docs/core-features/authentication#ably-jwt-process) is not implemented. +- [JWT authentication](https://ably.com/docs/core-features/authentication#ably-jwt-process) using `auth-url` is not implemented. +Check [jwt auth issue](https://github.com/ably/ably-go/issues/569) for more details. ### Realtime API -- There is no channel `suspended` state; this means that the client will not automatically reattach to channels if a - connection becomes `suspended` and then resumes, and presence members associated with the client will not be - automatically re-entered. - - Inband reauthentication is not supported; expiring tokens will trigger a disconnection and resume of a realtime - connection. + connection. Check [server initiated auth](https://github.com/ably/ably-go/issues/228) for more details. -- Realtime connection failure handling is partially implemented. +- Realtime connection failure handling is partially implemented. Check [host fallback](https://github.com/ably/ably-go/issues/225) for more details. - Realtime Ping function is not implemented. From 3b7de621d32386797821435b51ff6002b3a34a78 Mon Sep 17 00:00:00 2001 From: sacOO7 Date: Mon, 1 Jul 2024 16:59:44 +0530 Subject: [PATCH 2/3] Added limitation on suspended channel state, refactored limitations --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b4e1be616..4b401c352 100644 --- a/README.md +++ b/README.md @@ -406,14 +406,16 @@ As of release 1.2.0, the following are not implemented and will be covered in fu - [Push notifications admin API](https://ably.com/docs/general/push/admin) is not implemented. - [JWT authentication](https://ably.com/docs/core-features/authentication#ably-jwt-process) using `auth-url` is not implemented. -Check [jwt auth issue](https://github.com/ably/ably-go/issues/569) for more details. +See [jwt auth issue](https://github.com/ably/ably-go/issues/569) for more details. ### Realtime API - Inband reauthentication is not supported; expiring tokens will trigger a disconnection and resume of a realtime - connection. Check [server initiated auth](https://github.com/ably/ably-go/issues/228) for more details. + connection. See [server initiated auth](https://github.com/ably/ably-go/issues/228) for more details. -- Realtime connection failure handling is partially implemented. Check [host fallback](https://github.com/ably/ably-go/issues/225) for more details. +- Realtime connection failure handling is partially implemented. See [host fallback](https://github.com/ably/ably-go/issues/225) for more details. + +- Channel suspended state is partially implemented. See [suspended channel state](https://github.com/ably/ably-go/issues/568). - Realtime Ping function is not implemented. From a5b17363c5b5714404382488c509b4b4de58020a Mon Sep 17 00:00:00 2001 From: sacOO7 Date: Fri, 5 Jul 2024 16:47:01 +0530 Subject: [PATCH 3/3] updated readme#limitations link to ably docs --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4b401c352..305737846 100644 --- a/README.md +++ b/README.md @@ -403,9 +403,9 @@ As of release 1.2.0, the following are not implemented and will be covered in fu ### REST API -- [Push notifications admin API](https://ably.com/docs/general/push/admin) is not implemented. +- [Push notifications admin API](https://ably.com/docs/api/rest-sdk/push-admin) is not implemented. -- [JWT authentication](https://ably.com/docs/core-features/authentication#ably-jwt-process) using `auth-url` is not implemented. +- [JWT authentication](https://ably.com/docs/auth/token?lang=javascript#jwt) using `auth-url` is not implemented. See [jwt auth issue](https://github.com/ably/ably-go/issues/569) for more details. ### Realtime API