Skip to content

Commit

Permalink
chore(sdk): update references to LumApps API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
beroussel committed Nov 26, 2024
1 parent 036ce76 commit d8a0f4f
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 17 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
</p>


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:

Expand Down Expand Up @@ -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={
Expand Down
2 changes: 1 addition & 1 deletion docs/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions docs/guides/comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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)
4 changes: 1 addition & 3 deletions docs/guides/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
8 changes: 4 additions & 4 deletions docs/guides/community_posts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 = {
Expand Down Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/guides/user_base.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
</p>


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:

Expand Down
4 changes: 2 additions & 2 deletions lumapps/api/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit d8a0f4f

Please sign in to comment.