From 5a3524da8377d6706a171d31a9cd7d9aa0757bca Mon Sep 17 00:00:00 2001
From: rolznz <33993199+rolznz@users.noreply.github.com>
Date: Wed, 26 Oct 2022 18:05:31 +0700
Subject: [PATCH] Fix usermanager API docs (#1073)
- update incorrect response status codes
- update invalid activate extension example
---
.../templates/usermanager/_api_docs.html | 25 +++++++++++++------
1 file changed, 17 insertions(+), 8 deletions(-)
diff --git a/lnbits/extensions/usermanager/templates/usermanager/_api_docs.html b/lnbits/extensions/usermanager/templates/usermanager/_api_docs.html
index 886589e66..de477834b 100644
--- a/lnbits/extensions/usermanager/templates/usermanager/_api_docs.html
+++ b/lnbits/extensions/usermanager/templates/usermanager/_api_docs.html
@@ -38,7 +38,7 @@
>
Body (application/json)
- Returns 201 CREATED (application/json)
+ Returns 200 OK (application/json)
JSON list of users
Curl example
@@ -57,10 +57,15 @@
/usermanager/api/v1/users/<user_id>
Body (application/json)
+
- Returns 201 CREATED (application/json)
+ Returns 200 OK (application/json)
- JSON list of users
+ {"id": <string>, "name": <string>, "admin":
+ <string>, "email": <string>, "password": <string>}
+
Curl example
curl -X GET {{ request.base_url
@@ -81,7 +86,7 @@
{"X-Api-Key": <string>}
Body (application/json)
- Returns 201 CREATED (application/json)
+ Returns 200 OK (application/json)
JSON wallet data
Curl example
@@ -104,7 +109,7 @@
{"X-Api-Key": <string>}
Body (application/json)
- Returns 201 CREATED (application/json)
+ Returns 200 OK (application/json)
JSON a wallets transactions
Curl example
@@ -254,11 +259,15 @@
{"X-Api-Key": <string>}
Curl example
curl -X POST {{ request.base_url }}usermanager/api/v1/extensions -d
- '{"userid": <string>, "extension": <string>, "active":
- <integer>}' -H "X-Api-Key: {{ user.wallets[0].inkey }}" -H
+ >curl -X POST {{ request.base_url }}usermanager/api/v1/extensions?extension=withdraw&userid=user_id&active=true -H "X-Api-Key: {{ user.wallets[0].inkey }}" -H
"Content-type: application/json"
+
+ Returns 200 OK (application/json)
+
+ {"extension": "updated"}