Merge pull request #7988 from friendica/MrPetovan-notice

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

diff --git a/doc/API-Mastodon.md b/doc/API-Mastodon.md
index a711e367fb8db0480bed4fdeeb0a3ad78f24206f..e34ec4cc95a061c6f92cf0990e6818e061eab803 100644 (file)
--- a/doc/API-Mastodon.md
+++ b/doc/API-Mastodon.md
@@ -11,16 +11,25 @@ Authentication is the same as described in [Using the APIs](help/api#Authenticat
 
 ## Entities
 
-These endpoints use the [Mastodon API entities](https://docs.joinmastodon.org/api/entities/).
+These endpoints use the [Mastodon API entities](https://docs.joinmastodon.org/entities/).
 
 ## Implemented endpoints
 
-- [GET /api/v1/follow_requests](https://docs.joinmastodon.org/api/rest/follow-requests/#get-api-v1-follow-requests)
-- [GET /api/v1/instance](https://docs.joinmastodon.org/api/rest/instances)
-- GET /api/v1/instance/peers - undocumented, but implemented by Mastodon and Pleroma
+- [`GET /api/v1/follow_requests`](https://docs.joinmastodon.org/methods/accounts/follow_requests#pending-follows)
+    - Returned IDs are specific to follow requests
+- [`POST /api/v1/follow_requests/:id/authorize`](https://docs.joinmastodon.org/methods/accounts/follow_requests#accept-follow)
+    - `:id` is a follow request ID, not a regular account id
+- [`POST /api/v1/follow_requests/:id/reject`](https://docs.joinmastodon.org/methods/accounts/follow_requests#reject-follow)
+    - `:id` is a follow request ID, not a regular account id
+- `POST /api/v1/follow_requests/:id/ignore`
+    - Friendica-specific, hides the follow request from the list and prevents the remote contact from retrying.
+    - `:id` is a follow request ID, not a regular account id
+    - Returns a [Relationship](https://docs.joinmastodon.org/entities/relationship) object.
 
-## Non-implemented endpoints
 
-- [POST /api/v1/follow_requests/:id/authorize](https://docs.joinmastodon.org/api/rest/follow-requests/#post-api-v1-follow-requests-id-authorize)
-- [POST /api/v1/follow_requests/:id/reject](https://docs.joinmastodon.org/api/rest/follow-requests/#post-api-v1-follow-requests-id-reject)
+- [`GET /api/v1/instance`](https://docs.joinmastodon.org/methods/instance#fetch-instance)
+- [`GET /api/v1/instance/peers`](https://docs.joinmastodon.org/methods/instance#list-of-connected-domains)
+
+## Non-implemented endpoints
 
+- [`GET /api/v1/instance/activity`](https://docs.joinmastodon.org/methods/instance#weekly-activity)