From e34710b9888d5a3602971111c3a376bf8442fb84 Mon Sep 17 00:00:00 2001 From: Maxim Filippov Date: Mon, 4 Mar 2019 21:33:53 +0300 Subject: Format & update docs --- docs/Admin-API.md | 35 +++++------------------------------ 1 file changed, 5 insertions(+), 30 deletions(-) (limited to 'docs') diff --git a/docs/Admin-API.md b/docs/Admin-API.md index 407647645..7f60b768a 100644 --- a/docs/Admin-API.md +++ b/docs/Admin-API.md @@ -2,41 +2,16 @@ Authentication is required and the user must be an admin. -## `/api/pleroma/admin/users` +## `/api/pleroma/admin/users?query={query}&local={local}&page={page}&page_size={page_size}` ### List users - Method `GET` - Params: - - `page`: **integer** page number - - `page_size`: **integer** number of users per page (default is `50`) -- Response: - -```JSON -{ - "page_size": integer, - "count": integer, - "users": [ - { - "deactivated": bool, - "id": integer, - "nickname": string - }, - ... - ] -} -``` - -## `/api/pleroma/admin/users/search?query={query}&local={local}&page={page}&page_size={page_size}` - -### Search users by name or nickname - -- Method `GET` -- Params: - - `query`: **string** search term - - `local`: **bool** whether to return only local users - - `page`: **integer** page number - - `page_size`: **integer** number of users per page (default is `50`) + - `query`: **string** *optional* search term + - `local`: **bool** *optional* whether to return only local users + - `page`: **integer** *optional* page number + - `page_size`: **integer** *optional* number of users per page (default is `50`) - Response: ```JSON -- cgit v1.2.3 From 02359d686ca5f7feb1b83d77a35118bd55efdb52 Mon Sep 17 00:00:00 2001 From: Maxim Filippov Date: Mon, 4 Mar 2019 21:36:47 +0300 Subject: local -> only_local --- docs/Admin-API.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/Admin-API.md b/docs/Admin-API.md index 7f60b768a..24944440a 100644 --- a/docs/Admin-API.md +++ b/docs/Admin-API.md @@ -2,14 +2,14 @@ Authentication is required and the user must be an admin. -## `/api/pleroma/admin/users?query={query}&local={local}&page={page}&page_size={page_size}` +## `/api/pleroma/admin/users?query={query}&only_local={only_local}&page={page}&page_size={page_size}` ### List users - Method `GET` - Params: - `query`: **string** *optional* search term - - `local`: **bool** *optional* whether to return only local users + - `only_local`: **bool** *optional* whether to return only local users - `page`: **integer** *optional* page number - `page_size`: **integer** *optional* number of users per page (default is `50`) - Response: -- cgit v1.2.3 From 2d30fc279f2a3a5af68918c32c474a2fe8eaf664 Mon Sep 17 00:00:00 2001 From: Maxim Filippov Date: Tue, 5 Mar 2019 02:11:15 +0300 Subject: Typo --- docs/Admin-API.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/Admin-API.md b/docs/Admin-API.md index 24944440a..64e112f9b 100644 --- a/docs/Admin-API.md +++ b/docs/Admin-API.md @@ -9,7 +9,7 @@ Authentication is required and the user must be an admin. - Method `GET` - Params: - `query`: **string** *optional* search term - - `only_local`: **bool** *optional* whether to return only local users + - `local_only`: **bool** *optional* whether to return only local users - `page`: **integer** *optional* page number - `page_size`: **integer** *optional* number of users per page (default is `50`) - Response: -- cgit v1.2.3 From a283a1fcd026f33ecdd246fef6d035f95b2071a1 Mon Sep 17 00:00:00 2001 From: "Haelwenn (lanodan) Monnier" Date: Wed, 6 Mar 2019 02:25:13 +0100 Subject: Add default config for masto_fe Related to: https://git.pleroma.social/pleroma/mastofe/merge_requests/22 --- docs/config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/config.md b/docs/config.md index d1bf2a6f4..465bc1d2b 100644 --- a/docs/config.md +++ b/docs/config.md @@ -129,7 +129,7 @@ See: [logger’s documentation](https://hexdocs.pm/logger/Logger.html) and [ex_s ## :frontend_configurations -This can be used to configure a keyword list that keeps the configuration data for any kind of frontend. By default, settings for `pleroma_fe` are configured. +This can be used to configure a keyword list that keeps the configuration data for any kind of frontend. By default, settings for `pleroma_fe` and `masto_fe` are configured. Frontends can access these settings at `/api/pleroma/frontend_configurations` -- cgit v1.2.3 From 76160122f6d7bf52aee929328acb4d216e4c3504 Mon Sep 17 00:00:00 2001 From: Maxim Filippov Date: Wed, 6 Mar 2019 05:01:38 +0300 Subject: Keep heading short --- docs/Admin-API.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/Admin-API.md b/docs/Admin-API.md index 64e112f9b..2edb31f3c 100644 --- a/docs/Admin-API.md +++ b/docs/Admin-API.md @@ -2,12 +2,12 @@ Authentication is required and the user must be an admin. -## `/api/pleroma/admin/users?query={query}&only_local={only_local}&page={page}&page_size={page_size}` +## `/api/pleroma/admin/users` ### List users - Method `GET` -- Params: +- Query Params: - `query`: **string** *optional* search term - `local_only`: **bool** *optional* whether to return only local users - `page`: **integer** *optional* page number -- cgit v1.2.3 From 5021b7836fd0aabd2253416ec48dfcba60a1227c Mon Sep 17 00:00:00 2001 From: Ekaterina Vaartis Date: Thu, 7 Mar 2019 00:13:26 +0300 Subject: Fetch user's outbox posts on first federation with that user --- docs/config.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs') diff --git a/docs/config.md b/docs/config.md index 465bc1d2b..a09ea95f3 100644 --- a/docs/config.md +++ b/docs/config.md @@ -285,6 +285,10 @@ This config contains two queues: `federator_incoming` and `federator_outgoing`. ## :rich_media * `enabled`: if enabled the instance will parse metadata from attached links to generate link previews +## :fetch_initial_posts +* `enabled`: if enabled, when a new user is federated with, fetch some of their latest posts +* `pages`: the amount of pages to fetch + ## :hackney_pools Advanced. Tweaks Hackney (http client) connections pools. -- cgit v1.2.3 From 4826c06172c32e691404eac2da9825e23908e9bc Mon Sep 17 00:00:00 2001 From: Hakaba Hitoyo Date: Mon, 11 Mar 2019 01:40:34 +0000 Subject: Rename Mastalab -> Fedilab in Clients.md --- docs/Clients.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'docs') diff --git a/docs/Clients.md b/docs/Clients.md index c3d776488..ed3a2938f 100644 --- a/docs/Clients.md +++ b/docs/Clients.md @@ -30,6 +30,12 @@ Feel free to contact us to be added to this list! - Platforms: iOS - Features: No Streaming +### Fedilab +- Source Code: +- Contact: [@tom79@mastodon.social](https://mastodon.social/users/tom79) +- Platforms: Android +- Features: Streaming Ready + ### Nekonium - Homepage: [F-Droid Repository](https://repo.gdgd.jp.net/), [Google Play](https://play.google.com/store/apps/details?id=com.apps.nekonium), [Amazon](https://www.amazon.co.jp/dp/B076FXPRBC/) - Source: @@ -37,12 +43,6 @@ Feel free to contact us to be added to this list! - Platforms: Android - Features: Streaming Ready -### Mastalab -- Source Code: -- Contact: [@tom79@mastodon.social](https://mastodon.social/users/tom79) -- Platforms: Android -- Features: Streaming Ready - ### Roma - Homepage: - Source Code: ??? -- cgit v1.2.3 From 85632a38f995d8a8b208422fdc13c00860cfd1b6 Mon Sep 17 00:00:00 2001 From: rinpatch Date: Mon, 11 Mar 2019 08:33:57 +0300 Subject: Update homepages and provide source code links for Roma apps in Clients.md --- docs/Clients.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/Clients.md b/docs/Clients.md index ed3a2938f..da5806e98 100644 --- a/docs/Clients.md +++ b/docs/Clients.md @@ -4,8 +4,8 @@ Feel free to contact us to be added to this list! ## Desktop ### Roma for Desktop -- Homepage: -- Source Code: ??? +- Homepage: +- Source Code: - Platforms: Windows, Mac, (Linux?) - Features: Streaming Ready @@ -44,8 +44,8 @@ Feel free to contact us to be added to this list! - Features: Streaming Ready ### Roma -- Homepage: -- Source Code: ??? +- Homepage: +- Source Code: [Android](https://github.com/roma-apps/roma-android), [iOS](https://github.com/roma-apps/roma-ios) - Platforms: iOS, Android - Features: No Streaming -- cgit v1.2.3 From 6caa500cf12689351325e088e086b62967d30508 Mon Sep 17 00:00:00 2001 From: rinpatch Date: Mon, 11 Mar 2019 08:36:56 +0300 Subject: Change order of source code to align with platforms --- docs/Clients.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/Clients.md b/docs/Clients.md index da5806e98..dc3e83bcc 100644 --- a/docs/Clients.md +++ b/docs/Clients.md @@ -45,7 +45,7 @@ Feel free to contact us to be added to this list! ### Roma - Homepage: -- Source Code: [Android](https://github.com/roma-apps/roma-android), [iOS](https://github.com/roma-apps/roma-ios) +- Source Code: [iOS](https://github.com/roma-apps/roma-ios), [Android](https://github.com/roma-apps/roma-android) - Platforms: iOS, Android - Features: No Streaming -- cgit v1.2.3 From 4811eefa6e4cbdaa92fc2e003037506539e493b1 Mon Sep 17 00:00:00 2001 From: lain Date: Mon, 11 Mar 2019 13:48:27 +0100 Subject: MastoAPI StatusView: Add locality indicator. --- docs/Differences-in-MastodonAPI-Responses.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs') diff --git a/docs/Differences-in-MastodonAPI-Responses.md b/docs/Differences-in-MastodonAPI-Responses.md index 3026e1173..bb3cf33c8 100644 --- a/docs/Differences-in-MastodonAPI-Responses.md +++ b/docs/Differences-in-MastodonAPI-Responses.md @@ -13,3 +13,9 @@ Some apps operate under the assumption that no more than 4 attachments can be re ## Timelines Adding the parameter `with_muted=true` to the timeline queries will also return activities by muted (not by blocked!) users. + +## Statuses + +Has these additional fields under the 'pleroma' object: + +- `local`: true if the post was made on the local instance. -- cgit v1.2.3 From 66774b5567c10005b2be810433d7f3d401e12520 Mon Sep 17 00:00:00 2001 From: lambda Date: Mon, 11 Mar 2019 13:21:03 +0000 Subject: Update Differences-in-MastodonAPI-Responses.md --- docs/Differences-in-MastodonAPI-Responses.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/Differences-in-MastodonAPI-Responses.md b/docs/Differences-in-MastodonAPI-Responses.md index bb3cf33c8..667664f4e 100644 --- a/docs/Differences-in-MastodonAPI-Responses.md +++ b/docs/Differences-in-MastodonAPI-Responses.md @@ -16,6 +16,6 @@ Adding the parameter `with_muted=true` to the timeline queries will also return ## Statuses -Has these additional fields under the 'pleroma' object: +Has these additional fields under the `pleroma` object: - `local`: true if the post was made on the local instance. -- cgit v1.2.3 From 3474066f6dc98003583dcd8537028b515be0e126 Mon Sep 17 00:00:00 2001 From: lain Date: Mon, 11 Mar 2019 15:18:32 +0100 Subject: MastoAPI Accounts: Add fetching by nickname. This is to make it easier for the frontends to handle domain.com/users/nickname urls. --- docs/Differences-in-MastodonAPI-Responses.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs') diff --git a/docs/Differences-in-MastodonAPI-Responses.md b/docs/Differences-in-MastodonAPI-Responses.md index 667664f4e..7b11fe90f 100644 --- a/docs/Differences-in-MastodonAPI-Responses.md +++ b/docs/Differences-in-MastodonAPI-Responses.md @@ -19,3 +19,7 @@ Adding the parameter `with_muted=true` to the timeline queries will also return Has these additional fields under the `pleroma` object: - `local`: true if the post was made on the local instance. + +## Accounts + +- `/api/v1/accounts/:id`: The `id` parameter can also be the `nickname` of the user. This only works in this endpoint, not the deeper nested ones for following etc. -- cgit v1.2.3