Fix type and name on Mail::send sender ID argument

[friendica.git] / doc / API-Mastodon.md

diff --git a/doc/API-Mastodon.md b/doc/API-Mastodon.md
index 7496dc243dfd32f29e542799e15d9a30e9257db0..5fcb4782c58da75b4e41ec1a2fe572336f7b5852 100644 (file)
--- a/doc/API-Mastodon.md
+++ b/doc/API-Mastodon.md
@@ -63,6 +63,10 @@ Extensions to the [Mastodon Status Entities](https://docs.joinmastodon.org/entit
 * `in_reply_to_status`: A fully populated Mastodon Status entity for the replied to status or null it is a post rather than a response
 * `friendica`: Friendica specific properties of a status including:
   * `title`: The Friendica title for a post, or empty if the status is a comment
+  * `delivery_data`: Information about the state of federating a message from the server
+    * `delivery_queue_count`: Total number of remote servers that the status needs to be federated to.
+    * `delivery_queue_done`: Total number of remote servers that have successfully been federated to so far.
+    * `delivery_queue_failed`: Total number of remote servers that have we failed to federate to so far.
   * `dislikes_count`: The number of dislikes that a status has accumulated according to the server.
 
 Example:
@@ -72,26 +76,26 @@ Example:
   "created_at": "2023-02-23T02:45:46.000Z",
   "in_reply_to_id": "356",
   "in_reply_to_status": {
-       "id": "356",
-       "created_at": "2023-02-23T02:45:35.000Z",
-       "in_reply_to_id": null,
-       "in_reply_to_status": null,
-       "in_reply_to_account_id": null,
-       ...
-       "content": "A post from testuser1",
-       ...
-       "account": {
-         "id": "6",
-         "username": "testuser1",
-         "acct": "testuser1",
-         "display_name": "testuser1",
-         ...
-       },
-       ...
-       "friendica": {
-         "title": "",
-         "dislikes_count": 0
-       }
+    "id": "356",
+    "created_at": "2023-02-23T02:45:35.000Z",
+    "in_reply_to_id": null,
+    "in_reply_to_status": null,
+    "in_reply_to_account_id": null,
+    ...
+    "content": "A post from testuser1",
+    ...
+    "account": {
+      "id": "6",
+      "username": "testuser1",
+      "acct": "testuser1",
+      "display_name": "testuser1",
+      ...
+    },
+    ...
+    "friendica": {
+      "title": "",
+      "dislikes_count": 0
+    }
   },
   "in_reply_to_account_id": "6",
   ...
@@ -102,16 +106,21 @@ Example:
   "content": "A reply from testuser2",
   ...
   "account": {
-       "id": "8",
-       "username": "testuser2",
-       "acct": "testuser2",
-       "display_name": "testuser2",
-       ...
+    "id": "8",
+    "username": "testuser2",
+    "acct": "testuser2",
+    "display_name": "testuser2",
+    ...
   },
   ...
   "friendica": {
-       "title": "",
-       "dislikes_count": 0
+    "title": "",
+    "delivery_data": {
+      "delivery_queue_count": 10,
+      "delivery_queue_done": 3, 
+      "delivery_queue_failed": 0
+    },
+    "dislikes_count": 0
   }
 }
 ```
@@ -235,11 +244,11 @@ Example:
     - Additional field `with_muted` Pleroma extension to return notifications from muted users, defaults to `false`
     - Additional field `exclude_replies` to only return post statuses not replies/comments, defaults to `false`
 - [`GET /api/v1/timelines/list/:id`](https://docs.joinmastodon.org/methods/timelines/)
-       - Additional field `with_muted` Pleroma extension to return notifications from muted users, defaults to `false`
-       - Additional field `exclude_replies` to only return post statuses not replies/comments, defaults to `false`
+    - Additional field `with_muted` Pleroma extension to return notifications from muted users, defaults to `false`
+    - Additional field `exclude_replies` to only return post statuses not replies/comments, defaults to `false`
 - [`GET /api/v1/timelines/public`](https://docs.joinmastodon.org/methods/timelines/)
-       - Additional field `with_muted` Pleroma extension to return notifications from muted users, defaults to `false`
-       - Additional field `exclude_replies` to only return post statuses not replies/comments, defaults to `false`
+    - Additional field `with_muted` Pleroma extension to return notifications from muted users, defaults to `false`
+    - Additional field `exclude_replies` to only return post statuses not replies/comments, defaults to `false`
 - [`GET /api/v1/timelines/tag/:hashtag`](https://docs.joinmastodon.org/methods/timelines/)
     - Additional field `with_muted` Pleroma extension to return notifications from muted users, defaults to `false`
     - Additional field `exclude_replies` to only return post statuses not replies/comments, defaults to `false`