From 80cb097c1350897cb8992c3bc1f9bc60587bf9ff Mon Sep 17 00:00:00 2001 From: Hypolite Petovan Date: Sat, 21 Dec 2019 09:51:11 -0500 Subject: [PATCH] Update Mastodon API documentation - Change endpoint label style to monospace - Explicit expected IDs for follow_requests endpoints - Add official documentation link for api/v1/instance/peers - Add unimplemented endpoint api/v1/instance/activity --- doc/API-Mastodon.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/doc/API-Mastodon.md b/doc/API-Mastodon.md index c9eeb60df..e34ec4cc9 100644 --- a/doc/API-Mastodon.md +++ b/doc/API-Mastodon.md @@ -15,19 +15,21 @@ These endpoints use the [Mastodon API entities](https://docs.joinmastodon.org/en ## Implemented endpoints -- [GET /api/v1/follow_requests](https://docs.joinmastodon.org/methods/accounts/follow_requests#pending-follows) -- [POST /api/v1/follow_requests/:id/authorize](https://docs.joinmastodon.org/methods/accounts/follow_requests#accept-follow) - - Returns a [Relationship](https://docs.joinmastodon.org/entities/relationship) object. -- [POST /api/v1/follow_requests/:id/reject](https://docs.joinmastodon.org/methods/accounts/follow_requests#reject-follow) - - Returns a [Relationship](https://docs.joinmastodon.org/entities/relationship) object. -- POST /api/v1/follow_requests/:id/ignore +- [`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. - - -- [GET /api/v1/instance](https://docs.joinmastodon.org/methods/instance#fetch-instance) -- GET /api/v1/instance/peers - undocumented, but implemented by Mastodon and Pleroma +- [`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)