summaryrefslogtreecommitdiff
path: root/docs/API
diff options
context:
space:
mode:
authorAlex Gleason <alex@alexgleason.me>2020-08-07 16:35:15 -0500
committerAlex Gleason <alex@alexgleason.me>2020-08-07 16:35:15 -0500
commit1a5a7ba6e8a936d3138ca530d3466111e542aef6 (patch)
treec056138ee21661af45d2363ce01282aafffb3fc0 /docs/API
parentbd1e2e3a58ebd702306e7a6e2df985ac07e5f7d8 (diff)
parent47698fc322da58894dd41c1bfd5ca0376200dc5e (diff)
downloadpleroma-1a5a7ba6e8a936d3138ca530d3466111e542aef6.tar.gz
pleroma-1a5a7ba6e8a936d3138ca530d3466111e542aef6.zip
Merge remote-tracking branch 'upstream/develop' into aliases
Diffstat (limited to 'docs/API')
-rw-r--r--docs/API/admin_api.md24
-rw-r--r--docs/API/differences_in_mastoapi_responses.md1
-rw-r--r--docs/API/pleroma_api.md2
3 files changed, 25 insertions, 2 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md
index baf895d90..4b143e4ee 100644
--- a/docs/API/admin_api.md
+++ b/docs/API/admin_api.md
@@ -19,6 +19,7 @@ Configuration options:
- `local`: only local users
- `external`: only external users
- `active`: only active users
+ - `need_approval`: only unapproved users
- `deactivated`: only deactivated users
- `is_admin`: users with admin role
- `is_moderator`: users with moderator role
@@ -46,7 +47,10 @@ Configuration options:
"local": bool,
"tags": array,
"avatar": string,
- "display_name": string
+ "display_name": string,
+ "confirmation_pending": bool,
+ "approval_pending": bool,
+ "registration_reason": string,
},
...
]
@@ -242,6 +246,24 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
}
```
+## `PATCH /api/pleroma/admin/users/approve`
+
+### Approve user
+
+- Params:
+ - `nicknames`: nicknames array
+- Response:
+
+```json
+{
+ users: [
+ {
+ // user object
+ }
+ ]
+}
+```
+
## `GET /api/pleroma/admin/users/:nickname_or_id`
### Retrive the details of a user
diff --git a/docs/API/differences_in_mastoapi_responses.md b/docs/API/differences_in_mastoapi_responses.md
index c4a9c6dad..38865dc68 100644
--- a/docs/API/differences_in_mastoapi_responses.md
+++ b/docs/API/differences_in_mastoapi_responses.md
@@ -236,6 +236,7 @@ Has theses additional parameters (which are the same as in Pleroma-API):
- `pleroma.metadata.features`: A list of supported features
- `pleroma.metadata.federation`: The federation restrictions of this instance
- `pleroma.metadata.fields_limits`: A list of values detailing the length and count limitation for various instance-configurable fields.
+- `pleroma.metadata.post_formats`: A list of the allowed post format types
- `vapid_public_key`: The public key needed for push messages
## Markers
diff --git a/docs/API/pleroma_api.md b/docs/API/pleroma_api.md
index 8a937fdfd..c1aa4d204 100644
--- a/docs/API/pleroma_api.md
+++ b/docs/API/pleroma_api.md
@@ -50,7 +50,7 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi
* Authentication: not required
* Params: none
* Response: Provider specific JSON, the only guaranteed parameter is `type`
-* Example response: `{"type": "kocaptcha", "token": "whatever", "url": "https://captcha.kotobank.ch/endpoint"}`
+* Example response: `{"type": "kocaptcha", "token": "whatever", "url": "https://captcha.kotobank.ch/endpoint", "seconds_valid": 300}`
## `/api/pleroma/delete_account`
### Delete an account