summaryrefslogtreecommitdiff
path: root/docs/Pleroma-API.md
diff options
context:
space:
mode:
authorEgor Kislitsyn <egor@kislitsyn.com>2019-01-31 15:07:49 +0700
committerEgor Kislitsyn <egor@kislitsyn.com>2019-01-31 15:07:49 +0700
commitd3677d2b4d4d53619777509e0169bb0764213d39 (patch)
treec93f81bd476ba1feee727dd16d72593968aa3648 /docs/Pleroma-API.md
parentab31adf15bbec1597a9b7cf065898fb3f712eef3 (diff)
parent95d6118090fbd36fca4fd62133b270eaf27ae4df (diff)
downloadpleroma-d3677d2b4d4d53619777509e0169bb0764213d39.tar.gz
pleroma-d3677d2b4d4d53619777509e0169bb0764213d39.zip
Merge remote-tracking branch 'MAIN/develop' into feature/jobs
Diffstat (limited to 'docs/Pleroma-API.md')
-rw-r--r--docs/Pleroma-API.md7
1 files changed, 2 insertions, 5 deletions
diff --git a/docs/Pleroma-API.md b/docs/Pleroma-API.md
index da58babf9..3ebea565c 100644
--- a/docs/Pleroma-API.md
+++ b/docs/Pleroma-API.md
@@ -1,13 +1,9 @@
-# Authentication
+# Pleroma API
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`
@@ -15,6 +11,7 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi
* 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"}`
+* Note: Same data as Mastodon API’s `/api/v1/custom_emojis` but in a different format
## `/api/pleroma/follow_import`
### Imports your follows, for example from a Mastodon CSV file.