From d8a0f4f71d84aaff9fad81d3e39d8407b3f5dab6 Mon Sep 17 00:00:00 2001 From: beroussel Date: Tue, 26 Nov 2024 14:38:57 +0100 Subject: [PATCH] chore(sdk): update references to LumApps API docs --- README.md | 3 +-- docs/authentication.md | 2 +- docs/guides/comments.md | 6 +++--- docs/guides/community.md | 4 +--- docs/guides/community_posts.md | 8 ++++---- docs/guides/user_base.md | 2 +- docs/index.md | 2 +- lumapps/api/client.py | 4 ++-- 8 files changed, 14 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 85edf35f..12a8e6db 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@

-LumApps SDK is a set of tools to manipulate the [LumApps API](https://apiv1.lumapps.com/) +LumApps SDK is a set of tools to manipulate the [LumApps API](https://api.lumapps.com/) This includes: @@ -40,7 +40,6 @@ Python >= 3.8 ```python from lumapps.api import BaseClient - token = "MY TOKEN" base_client = BaseClient( api_info={"base_url": "https://your-cell.api.lumapps.com"}, # e.g. "https://go-cell-001.api.lumapps.com" auth_info={ diff --git a/docs/authentication.md b/docs/authentication.md index aa371f95..fa50f887 100644 --- a/docs/authentication.md +++ b/docs/authentication.md @@ -2,7 +2,7 @@ The first thing you'll need in order for you to be able to use the LumApps Api is a valid token. -You can see them [here](https://apiv1.lumapps.com/#tag/Authentication) +You can see them [here](https://api.lumapps.com/docs/lumapps-public-api/b87d37ae48a0d-authentication) The LumApps SDK requires an OAuth application to be set up on your LumApps platform (see how to do that in the [LumApps Developer Portal](https://developer.lumapps.com/documentation/oauth.html). Once it is done, all you have to do is to give the sdk the credentials infos and the subsequent calls made by the tool will be authenticated using those credentials. diff --git a/docs/guides/comments.md b/docs/guides/comments.md index dfaa985a..131ce7c0 100644 --- a/docs/guides/comments.md +++ b/docs/guides/comments.md @@ -12,7 +12,7 @@ comments = api.get_call( ) ``` -For more details see [api.lumapps.com](https://apiv1.lumapps.com/#operation/Comment/List) +For more details see [api.lumapps.com](https://api.lumapps.com/docs/lumapps-public-api/ccd9fdc5fc626-list-comments) ## Comment get @@ -22,7 +22,7 @@ comment = client.get_call( ) ``` -For more details see [api.lumapps.com](https://apiv1.lumapps.com/#operation/Comment/Get) +For more details see [api.lumapps.com](https://api.lumapps.com/docs/lumapps-public-api/2704d9935b7b8-retrieve-a-comment) ## Comment save @@ -58,4 +58,4 @@ comment = client.get_call( ) ``` -For more details see [the api documentation](https://apiv1.lumapps.com) +For more details see [the api documentation](https://api.lumapps.com) diff --git a/docs/guides/community.md b/docs/guides/community.md index 931f771e..652b024c 100644 --- a/docs/guides/community.md +++ b/docs/guides/community.md @@ -14,8 +14,6 @@ communities = client.get_call( ) ``` -For more details see [the api documentation](https://apiv1.lumapps.com/#operation/Community/List) - ## Community get ```python @@ -24,4 +22,4 @@ community = client.get_call( ) ``` -For more details see [the api documentation](https://apiv1.lumapps.com/#operation/Community/Get) +For more details see [the api documentation](https://api.lumapps.com/docs/lumapps-public-api/0cb3a41bb0afa-retrieve-a-community) diff --git a/docs/guides/community_posts.md b/docs/guides/community_posts.md index a2b9a5a6..ddc00ee1 100644 --- a/docs/guides/community_posts.md +++ b/docs/guides/community_posts.md @@ -14,7 +14,7 @@ posts = client.get_call( ) ``` -For more details see [the api documentation](https://apiv1.lumapps.com/#operation/Community%20Post/Search) +For more details see [the api documentation](https://api.lumapps.com/docs/lumapps-public-api/85ebc4227cf2c-search-for-posts) ## Post get @@ -25,11 +25,11 @@ post = client.get_call( ) ``` -For more details see [the api documentation](https://apiv1.lumapps.com/#operation/Community%20Post/get) +For more details see [the api documentation](https://api.lumapps.com/docs/lumapps-public-api/cfecfd13ab19d-retrieve-a-post) ## Post save -The variable `post` is a json object described [here](https://api.lumapps.com/docs/output/_schemas/post.html). +The variable `post` is a json object described [here](https://api.lumapps.com/docs/lumapps-public-api/2f1f03ecf288d-post). You can either construct a new one from scratch: ```python post = { @@ -63,4 +63,4 @@ post = api.get_call( ) ``` -For more details see [the api documentation](https://apiv1.lumapps.com/#operation/Community%20Post/save) +For more details see [the api documentation](https://api.lumapps.com/docs/lumapps-public-api/256b10f9a7a7d-save-a-commmunity) diff --git a/docs/guides/user_base.md b/docs/guides/user_base.md index 49261af9..91472458 100644 --- a/docs/guides/user_base.md +++ b/docs/guides/user_base.md @@ -10,7 +10,7 @@ To get all users at once you can use the `get_call` method provided by the BaseC users = client.get_call("user/list") ``` -You can also add additional parameters according to the [documentation](https://apiv1.lumapps.com/#operation/User/List) +You can also add additional parameters according to the [documentation](https://api.lumapps.com/docs/lumapps-public-api/d4e848bc139d6-list-users) For instance, if you want to list the users of your platform but filter only the ones that are enabled you will do diff --git a/docs/index.md b/docs/index.md index 9bab4728..12a8e6db 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,7 +9,7 @@

-LumApps SDK is a set of tools to manipulate the [LumApps API](https://apiv1.lumapps.com/) +LumApps SDK is a set of tools to manipulate the [LumApps API](https://api.lumapps.com/) This includes: diff --git a/lumapps/api/client.py b/lumapps/api/client.py index 2e2486ac..b27d5088 100644 --- a/lumapps/api/client.py +++ b/lumapps/api/client.py @@ -387,7 +387,7 @@ def iter_contents( ) -> Generator[Dict[str, Any], None, None]: """Iterate over the contents on the current lumapps site \n - https://apiv1.lumapps.com/#operation/Content/List + https://api.lumapps.com/docs/lumapps-public-api/81bb7b1f02f38-list-content Args: content_type_id: The id of a content type. @@ -610,7 +610,7 @@ def save_user_settings(self, settings: Dict[str, Any]) -> Dict[str, Any]: def iter_users(self, **kwargs: dict) -> Generator[Dict[str, Any], None, None]: """Iterate overs the platform users \n - https://apiv1.lumapps.com/#operation/User/List + https://api.lumapps.com/docs/lumapps-public-api/d4e848bc139d6-list-users Args: **kwargs: args to add to the request (see api documentation)