Pleroma-API.md: Import from /wikis/Pleroma-only-api-endpoints

This commit is contained in:
Haelwenn (lanodan) Monnier 2018-12-18 13:58:07 +01:00
parent b6ae412fcd
commit 08b6294f47
No known key found for this signature in database
GPG Key ID: D5B7A8E43C997DEE
2 changed files with 27 additions and 1 deletions

26
Pleroma-API.md Normal file
View File

@ -0,0 +1,26 @@
# Authentication
Requests that require it can be authenticated with [an OAuth token](https://tools.ietf.org/html/rfc6749), the `_pleroma_key` cookie, or [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization).
# Request parameters
Request parameters can be passed via [query strings](https://en.wikipedia.org/wiki/Query_string) or as [form data](https://www.w3.org/TR/html401/interact/forms.html). Files must be uploaded as `multipart/form-data`.
# Endpoints
## `/api/pleroma/emoji`
### Lists the custom emoji on that server.
* Method: `GET`
* Authentication: not required
* Params: none
* Response: JSON
* Example response: `{"kalsarikannit_f":"/finmoji/128px/kalsarikannit_f-128.png","perkele":"/finmoji/128px/perkele-128.png","blobdab":"/emoji/blobdab.png","happiness":"/finmoji/128px/happiness-128.png"}`
## `/api/pleroma/follow_import`
### Imports your follows, for example from a Mastodon CSV file.
* Method: `POST`
* Authentication: required
* Params:
* `list`: STRING or FILE containing a whitespace-separated list of accounts to follow
* Response: HTTP 200 on success, 500 on error
* Note: Users that can't be followed are silently skipped.

View File

@ -21,7 +21,7 @@ defmodule Pleroma.Mixfile do
homepage_url: "https://pleroma.social/", homepage_url: "https://pleroma.social/",
docs: [ docs: [
logo: "priv/static/static/logo.png", logo: "priv/static/static/logo.png",
extras: ["README.md", "config/config.md"], extras: ["README.md", "config/config.md", "Pleroma-API.md"],
main: "readme" main: "readme"
] ]
] ]