diff options
author | Eugen <eugen@zeonfederated.com> | 2017-03-15 22:55:22 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-03-15 22:55:22 +0100 |
commit | e245115f47082ffba27205f508301d14e792c369 (patch) | |
tree | 21a77b788dace45b734da6e64f1b0705016192f0 /docs | |
parent | 620f70e42c16c324459ca2da52c68f1def8683de (diff) | |
parent | c1124228e857b0e85f5bf927d2c41c7fadfdf955 (diff) |
Merge branch 'master' into mastodon-site-api
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Contributing-to-Mastodon/Sponsors.md | 27 | ||||
-rw-r--r-- | docs/Using-Mastodon/Apps.md | 12 | ||||
-rw-r--r-- | docs/Using-Mastodon/List-of-Mastodon-instances.md | 3 | ||||
-rw-r--r-- | docs/Using-the-API/API.md | 30 | ||||
-rw-r--r-- | docs/Using-the-API/Push-notifications.md | 2 |
5 files changed, 56 insertions, 18 deletions
diff --git a/docs/Contributing-to-Mastodon/Sponsors.md b/docs/Contributing-to-Mastodon/Sponsors.md index 3fee6e1e0..475791684 100644 --- a/docs/Contributing-to-Mastodon/Sponsors.md +++ b/docs/Contributing-to-Mastodon/Sponsors.md @@ -6,23 +6,16 @@ These people make the development of Mastodon possible through [Patreon](https:/ **Extra special Patrons** - [World'sTallestLadder](https://mastodon.social/users/carcinoGeneticist) -- [glocal](https://mastodon.social/users/glocal) - [Jimmy Tidey](https://mastodon.social/users/jimmytidey) - [Kurtis Rainbolt-Greene](https://mastodon.social/users/krainboltgreene) - [Kit Redgrave](https://socially.constructed.space/users/KitRedgrave) -- [Zeiphner](https://mastodon.social/users/Zeipher) +- [Zeipher](https://mastodon.social/users/Zeipher) - [Effy Elden](https://toot.zone/users/effy) - [Zoë Quinn](https://mastodon.social/users/zoequinn) **Thank you to the following people** -- [Sophia Park](https://mastodon.social/users/sophia) -- [WelshPixie](https://mastodon.social/users/WelshPixie) -- [John Parker](https://mastodon.social/users/Middaparka) -- [Christina Hendricks](https://mastodon.social/users/clhendricksbc) -- [Jelle](http://jelv.nl) - [Harris Bomberguy](https://mastodon.social/users/Hbomberguy) -- [Martin Tithonium](https://mastodon.social/users/tithonium) - [Edward Saperia](https://nwspk.com) - [Yoz Grahame](http://yoz.com/) - [Jenn Kaplan](https://gay.crime.team/users/jkap) @@ -33,5 +26,21 @@ These people make the development of Mastodon possible through [Patreon](https:/ - [Niels Roesen Abildgaard](http://hypesystem.dk/) - [Zatnosk](https://github.com/Zatnosk) - [Spex Bluefox](https://mastodon.social/users/Spex) -- [Sam Waldie](https://mastodon.social/users/denjin) - [J. C. Holder](http://jcholder.com/) +- [glocal](https://mastodon.social/users/glocal) +- [jk](https://mastodon.social/users/jk) +- [C418](https://mastodon.social/users/C418) +- [halcy](https://icosahedron.website/users/halcy) +- [Extropic](https://gnusocial.no/extropic) +- [Pat Monaghan](http://iwrite.software/) +- TBD +- TBD +- TBD +- TBD +- TBD +- TBD +- TBD +- TBD +- TBD +- TBD +- TBD diff --git a/docs/Using-Mastodon/Apps.md b/docs/Using-Mastodon/Apps.md index e350e5f95..62d48c5ec 100644 --- a/docs/Using-Mastodon/Apps.md +++ b/docs/Using-Mastodon/Apps.md @@ -5,11 +5,13 @@ Some people have started working on apps for the Mastodon API. Here is a list of |App|Platform|Link|Developer(s)| |---|--------|----|------------| -|Matodor|iOS/Android|<https://github.com/jeroensmeets/mastodon-app>|[@jeroensmeets@mastodon.social](https://mastodon.social/users/jeroensmeets)| |Tusky|Android|<https://github.com/Vavassor/Tusky>|[@Vavassor@mastodon.social](https://mastodon.social/users/Vavassor)| -|Albatross|iOS||[@goldie_ice@mastodon.social](https://mastodon.social/users/goldie_ice)| -|tootstream|command-line|<https://github.com/magicalraccoon/tootstream>|[@Raccoon@mastodon.social](https://mastodon.social/users/Raccoon)| -|mastodroid|Android|<https://github.com/alin-rautoiu/mastodroid>|| -|Tooter|Chrome extension|<https://github.com/ineffyble/tooter>|[@effy@mastodon.social](https://mastodon.social/users/effy)| +|mastodroid|Android|<https://github.com/alin-rautoiu/mastodroid>|[@charlag@mastodon.social](https://mastodon.social/users/charlag)| |TootyFruity|Android|<https://play.google.com/store/apps/details?id=ch.kevinegli.tootyfruity221258>|[@eggplant@mastodon.social](https://mastodon.social/users/eggplant)| +|Matodor|iOS/Android|<https://github.com/jeroensmeets/mastodon-app>|[@jeroensmeets@mastodon.social](https://mastodon.social/users/jeroensmeets)| +|Amarok|iOS|<https://itunes.apple.com/us/app/amarok-for-mastodon/id1214116200?ls=1&mt=8>|[@eurasierboy@mastodon.social](https://mastodon.social/users/eurasierboy)| +|Albatross|iOS||[@goldie_ice@mastodon.social](https://mastodon.social/users/goldie_ice)| +|Tooter|Chrome|<https://github.com/ineffyble/tooter>|[@effy@mastodon.social](https://mastodon.social/users/effy)| +|tootstream|CLI|<https://github.com/magicalraccoon/tootstream>|[@Raccoon@mastodon.social](https://mastodon.social/users/Raccoon)| + If you have a project like this, let me know so I can add it to the list! diff --git a/docs/Using-Mastodon/List-of-Mastodon-instances.md b/docs/Using-Mastodon/List-of-Mastodon-instances.md index ed3c74294..ef3c835de 100644 --- a/docs/Using-Mastodon/List-of-Mastodon-instances.md +++ b/docs/Using-Mastodon/List-of-Mastodon-instances.md @@ -11,8 +11,9 @@ List of Known Mastodon instances | [epiktistes.com](https://epiktistes.com) |N/A|Yes| | [on.vu](https://on.vu) | Appears defunct|No| | [gay.crime.team](https://gay.crime.team) |N/A|Yes(?)| -| [gnusocial.me](https://gnusocial.me) |Yes, it's a mastodon instance now|Yes| | [icosahedron.website](https://icosahedron.website/) |Icosahedron-themed (well, visually), open registration.|Yes| | [memetastic.space](https://memetastic.space) |Memes|Yes| +| [social.diskseven.com](https://social.diskseven.com) |Single user|No| +| [social.gestaltzerfall.net](https://social.gestaltzerfall.net) |Single user|No| Let me know if you start running one so I can add it to the list! (Alternatively, add it yourself as a pull request). diff --git a/docs/Using-the-API/API.md b/docs/Using-the-API/API.md index 8dcf2a842..2c323d559 100644 --- a/docs/Using-the-API/API.md +++ b/docs/Using-the-API/API.md @@ -76,6 +76,10 @@ Query parameters: - `max_id` (optional): Skip statuses younger than ID (e.g. navigate backwards in time) - `since_id` (optional): Skip statuses older than ID (e.g. check for updates) +Query parameters for public and tag timelines only: + +- `local` (optional): Only return statuses originating from this instance + ### Notifications **GET /api/v1/notifications** @@ -116,7 +120,14 @@ Returns authenticated user's account. **GET /api/v1/accounts/:id/statuses** -Returns statuses by user. Same options as timeline are permitted. +Returns statuses by user. + +Query parameters: + +- `max_id` (optional): Skip statuses younger than ID (e.g. navigate backwards in time) +- `since_id` (optional): Skip statuses older than ID (e.g. check for updates) +- `only_media` (optional): Only return statuses that have media attachments +- `exclude_replies` (optional): Skip statuses that reply to other statuses **GET /api/v1/accounts/:id/following** @@ -128,7 +139,7 @@ Returns users the given user is followed by. **GET /api/v1/accounts/relationships** -Returns relationships (`following`, `followed_by`, `blocking`) of the current user to a list of given accounts. +Returns relationships (`following`, `followed_by`, `blocking`, `muting`, `requested`) of the current user to a list of given accounts. Query parameters: @@ -147,6 +158,14 @@ Query parameters: Returns accounts blocked by authenticated user. +**GET /api/v1/mutes** + +Returns accounts muted by authenticated user. + +**GET /api/v1/follow_requests** + +Returns accounts that want to follow the authenticated user but are waiting for approval. + **GET /api/v1/favourites** Returns statuses favourited by authenticated user. @@ -215,6 +234,13 @@ Returns the updated relationship to the user. Returns an object containing the `title`, character limit (`max_chars`), and an object of `links` for the site. Does not require authentication. +# Muting and unmuting users + +**POST /api/v1/accounts/:id/mute** +**POST /api/v1/accounts/:id/unmute** + +Returns the updated relationship to the user. + ### OAuth apps **POST /api/v1/apps** diff --git a/docs/Using-the-API/Push-notifications.md b/docs/Using-the-API/Push-notifications.md index d98c8833a..fc373e723 100644 --- a/docs/Using-the-API/Push-notifications.md +++ b/docs/Using-the-API/Push-notifications.md @@ -1,4 +1,4 @@ Push notifications ================== -**Note: This push notification design turned out to not be fully operational on the side of Firebase. A different approach is in consideration** +See <https://github.com/Gargron/tusky-api> for an example of how to create push notifications for a mobile app. It involves using the Mastodon streaming API on behalf of the app's users, as a sort of proxy. |