From b810aac117563a941b50180f19bca2d96a329a0a Mon Sep 17 00:00:00 2001
From: Alex S <alex.strizhakov@gmail.com>
Date: Sun, 7 Apr 2019 19:48:52 +0700
Subject: added docs to docs/api/admin_api.md

code style and little renamings
---
 docs/api/admin_api.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 56 insertions(+), 3 deletions(-)

(limited to 'docs/api/admin_api.md')

diff --git a/docs/api/admin_api.md b/docs/api/admin_api.md
index 86cacebb1..638b235b8 100644
--- a/docs/api/admin_api.md
+++ b/docs/api/admin_api.md
@@ -200,12 +200,65 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
 
 ## `/api/pleroma/admin/invite_token`
 
-### Get a account registeration invite token
+### Get an account registration invite token
 
 - Methods: `GET`
-- Params: none
+- Params:
+  - *optional* `invite` => [
+    - *optional* `max_use` (integer)
+    - *optional* `expire_at` (date string e.g. "2019-04-07")
+  ]
 - Response: invite token (base64 string)
 
+## `/api/pleroma/admin/invites`
+
+### Get a list of generated invites
+
+- Methods: `GET`
+- Params: none
+- Response:
+
+```JSON
+{
+
+  "invites": [
+    {
+      "id": integer,
+      "token": string,
+      "used": boolean,
+      "expire_at": date,
+      "uses": integer,
+      "max_use": integer,
+      "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
+    },
+    ...
+  ]
+}
+```
+
+## `/api/pleroma/admin/revoke_invite`
+
+### Revoke invite by token
+
+- Methods: `POST`
+- Params:
+  - `token`
+- Response:
+
+```JSON
+{
+  "id": integer,
+  "token": string,
+  "used": boolean,
+  "expire_at": date,
+  "uses": integer,
+  "max_use": integer,
+  "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
+
+}
+```
+
+
 ## `/api/pleroma/admin/email_invite`
 
 ### Sends registration invite via email
@@ -213,7 +266,7 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
 - Methods: `POST`
 - Params:
   - `email`
-  - `name`, optionnal
+  - `name`, optional
 
 ## `/api/pleroma/admin/password_reset`
 
-- 
cgit v1.2.3


From 012bb5dcc9bfbf6f3ea210ec4e865f3adcea9dfd Mon Sep 17 00:00:00 2001
From: Alex S <alex.strizhakov@gmail.com>
Date: Mon, 8 Apr 2019 16:01:28 +0700
Subject: renaming expire_at -> expires_at

keyword style change
---
 docs/api/admin_api.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'docs/api/admin_api.md')

diff --git a/docs/api/admin_api.md b/docs/api/admin_api.md
index 638b235b8..8befa8ea0 100644
--- a/docs/api/admin_api.md
+++ b/docs/api/admin_api.md
@@ -206,7 +206,7 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
 - Params:
   - *optional* `invite` => [
     - *optional* `max_use` (integer)
-    - *optional* `expire_at` (date string e.g. "2019-04-07")
+    - *optional* `expires_at` (date string e.g. "2019-04-07")
   ]
 - Response: invite token (base64 string)
 
@@ -226,7 +226,7 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
       "id": integer,
       "token": string,
       "used": boolean,
-      "expire_at": date,
+      "expires_at": date,
       "uses": integer,
       "max_use": integer,
       "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
@@ -250,7 +250,7 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
   "id": integer,
   "token": string,
   "used": boolean,
-  "expire_at": date,
+  "expires_at": date,
   "uses": integer,
   "max_use": integer,
   "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
-- 
cgit v1.2.3