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/Differences-in-MastodonAPI-Responses.md') 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/Differences-in-MastodonAPI-Responses.md') 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/Differences-in-MastodonAPI-Responses.md') 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 From d7a34b604b15f9e7f73cda834f513d6f62643005 Mon Sep 17 00:00:00 2001 From: rinpatch Date: Fri, 15 Mar 2019 11:58:12 +0300 Subject: Extend MastoAPI to provide attachment mimetypes --- docs/Differences-in-MastodonAPI-Responses.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/Differences-in-MastodonAPI-Responses.md') diff --git a/docs/Differences-in-MastodonAPI-Responses.md b/docs/Differences-in-MastodonAPI-Responses.md index 7b11fe90f..621de6603 100644 --- a/docs/Differences-in-MastodonAPI-Responses.md +++ b/docs/Differences-in-MastodonAPI-Responses.md @@ -20,6 +20,12 @@ Has these additional fields under the `pleroma` object: - `local`: true if the post was made on the local instance. +## Attachments + +Has these additional fields under the `pleroma` object: + +- `mime_type`: mime type of the attachment. + ## 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 From 9971bf5be19d922aedad6f9931c7774e099220fa Mon Sep 17 00:00:00 2001 From: eugenijm Date: Mon, 18 Mar 2019 03:54:50 +0300 Subject: Added documentation for Pleroma-specific is_seen in Mastodon API --- docs/Differences-in-MastodonAPI-Responses.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/Differences-in-MastodonAPI-Responses.md') diff --git a/docs/Differences-in-MastodonAPI-Responses.md b/docs/Differences-in-MastodonAPI-Responses.md index 621de6603..5e89cde5e 100644 --- a/docs/Differences-in-MastodonAPI-Responses.md +++ b/docs/Differences-in-MastodonAPI-Responses.md @@ -29,3 +29,9 @@ Has these additional fields under the `pleroma` object: ## 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. + +## Notifications + +Has these additional fields under the `pleroma` object: + +- `is_seen`: true if the notification was read by the user -- cgit v1.2.3 From 325c106cb597ea75886f142287b345ac57cb2b25 Mon Sep 17 00:00:00 2001 From: Mark Felder Date: Mon, 18 Mar 2019 19:48:56 +0000 Subject: Document additional pleroma changes to /api/v1/accounts/:id --- docs/Differences-in-MastodonAPI-Responses.md | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'docs/Differences-in-MastodonAPI-Responses.md') diff --git a/docs/Differences-in-MastodonAPI-Responses.md b/docs/Differences-in-MastodonAPI-Responses.md index 5e89cde5e..14b67ca7d 100644 --- a/docs/Differences-in-MastodonAPI-Responses.md +++ b/docs/Differences-in-MastodonAPI-Responses.md @@ -30,6 +30,14 @@ Has these additional fields under the `pleroma` object: - `/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. +Has these additional fields under the `pleroma` object: + +- `tags`: Lists an array of tags for the user +- `relationship{}`: Includes fields as documented for Mastodon API https://docs.joinmastodon.org/api/entities/#relationship +- `is_moderator`: boolean, true if user is a moderator +- `is_admin`: boolean, true if user is an admin +- `confirmation_pending`: boolean, true if a new user account is waiting on email confirmation to be activated + ## Notifications Has these additional fields under the `pleroma` object: -- cgit v1.2.3 From ae8fa5d0aab3561bf66506766e2beb03a251e499 Mon Sep 17 00:00:00 2001 From: William Pitcock Date: Thu, 21 Mar 2019 23:27:42 +0000 Subject: docs: document `conversation_id` extension --- docs/Differences-in-MastodonAPI-Responses.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/Differences-in-MastodonAPI-Responses.md') diff --git a/docs/Differences-in-MastodonAPI-Responses.md b/docs/Differences-in-MastodonAPI-Responses.md index 14b67ca7d..d993d1383 100644 --- a/docs/Differences-in-MastodonAPI-Responses.md +++ b/docs/Differences-in-MastodonAPI-Responses.md @@ -19,6 +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. +- `conversation_id`: the ID of the conversation the status is associated with (if any) ## Attachments -- cgit v1.2.3 From dfae0050af385786c5799ee886de315f69d36a78 Mon Sep 17 00:00:00 2001 From: rinpatch Date: Thu, 28 Mar 2019 19:46:30 +0300 Subject: Move out of Gitlab Wiki I understand that this change is quite unreadable and hard to review, sorry for forgetting to do atomic commits. This patch does not change too much content wise, it just * Gets everything from gitlab wiki * Removes some specific gitlab hacks * Formats all documentation file names to be in snake case so they look the same way as our code does --- docs/Differences-in-MastodonAPI-Responses.md | 46 ---------------------------- 1 file changed, 46 deletions(-) delete mode 100644 docs/Differences-in-MastodonAPI-Responses.md (limited to 'docs/Differences-in-MastodonAPI-Responses.md') diff --git a/docs/Differences-in-MastodonAPI-Responses.md b/docs/Differences-in-MastodonAPI-Responses.md deleted file mode 100644 index d993d1383..000000000 --- a/docs/Differences-in-MastodonAPI-Responses.md +++ /dev/null @@ -1,46 +0,0 @@ -# Differences in Mastodon API responses from vanilla Mastodon - -A Pleroma instance can be identified by " (compatible; Pleroma )" present in `version` field in response from `/api/v1/instance` - -## Flake IDs - -Pleroma uses 128-bit ids as opposed to Mastodon's 64 bits. However just like Mastodon's ids they are sortable strings - -## Attachment cap - -Some apps operate under the assumption that no more than 4 attachments can be returned or uploaded. Pleroma however does not enforce any limits on attachment count neither when returning the status object nor when posting. - -## 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. -- `conversation_id`: the ID of the conversation the status is associated with (if any) - -## Attachments - -Has these additional fields under the `pleroma` object: - -- `mime_type`: mime type of the attachment. - -## 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. - -Has these additional fields under the `pleroma` object: - -- `tags`: Lists an array of tags for the user -- `relationship{}`: Includes fields as documented for Mastodon API https://docs.joinmastodon.org/api/entities/#relationship -- `is_moderator`: boolean, true if user is a moderator -- `is_admin`: boolean, true if user is an admin -- `confirmation_pending`: boolean, true if a new user account is waiting on email confirmation to be activated - -## Notifications - -Has these additional fields under the `pleroma` object: - -- `is_seen`: true if the notification was read by the user -- cgit v1.2.3