jakob/friendica
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update Mastodon API documentation

Browse source 
- 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
This commit is contained in:
Hypolite Petovan 2019-12-21 09:51:11 -05:00
parent f1c1afe6b5
commit 80cb097c13
1 changed files with 12 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
doc/API-Mastodon.md
View file

@ -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)