From f9fd071315982e1f5b850f0efd62efc287ccf2e9 Mon Sep 17 00:00:00 2001 From: Vlad Stan Date: Mon, 11 Jul 2022 15:16:29 +0300 Subject: [PATCH] feat: update API doc to use swagger --- .../satspay/templates/satspay/_api_docs.html | 172 +----------------- 1 file changed, 5 insertions(+), 167 deletions(-) diff --git a/lnbits/extensions/satspay/templates/satspay/_api_docs.html b/lnbits/extensions/satspay/templates/satspay/_api_docs.html index 336ab899..ed658735 100644 --- a/lnbits/extensions/satspay/templates/satspay/_api_docs.html +++ b/lnbits/extensions/satspay/templates/satspay/_api_docs.html @@ -8,172 +8,10 @@ Created by, Ben Arc

+
+
+ Swagger REST API Documentation - - - - - - POST /satspay/api/v1/charge -
Headers
- {"X-Api-Key": <admin_key>}
-
- Body (application/json) -
-
- Returns 200 OK (application/json) -
- [<charge_object>, ...] -
Curl example
- curl -X POST {{ request.base_url }}satspay/api/v1/charge -d - '{"onchainwallet": <string, watchonly_wallet_id>, - "description": <string>, "webhook":<string>, "time": - <integer>, "amount": <integer>, "lnbitswallet": - <string, lnbits_wallet_id>}' -H "Content-type: - application/json" -H "X-Api-Key: {{user.wallets[0].adminkey }}" - - - - - - - - PUT - /satspay/api/v1/charge/<charge_id> -
Headers
- {"X-Api-Key": <admin_key>}
-
- Body (application/json) -
-
- Returns 200 OK (application/json) -
- [<charge_object>, ...] -
Curl example
- curl -X POST {{ request.base_url - }}satspay/api/v1/charge/<charge_id> -d '{"onchainwallet": - <string, watchonly_wallet_id>, "description": <string>, - "webhook":<string>, "time": <integer>, "amount": - <integer>, "lnbitswallet": <string, lnbits_wallet_id>}' - -H "Content-type: application/json" -H "X-Api-Key: - {{user.wallets[0].adminkey }}" - - - - - - - - - GET - /satspay/api/v1/charge/<charge_id> -
Headers
- {"X-Api-Key": <invoice_key>}
-
- Body (application/json) -
-
- Returns 200 OK (application/json) -
- [<charge_object>, ...] -
Curl example
- curl -X GET {{ request.base_url - }}satspay/api/v1/charge/<charge_id> -H "X-Api-Key: {{ - user.wallets[0].inkey }}" - - - - - - - - GET /satspay/api/v1/charges -
Headers
- {"X-Api-Key": <invoice_key>}
-
- Body (application/json) -
-
- Returns 200 OK (application/json) -
- [<charge_object>, ...] -
Curl example
- curl -X GET {{ request.base_url }}satspay/api/v1/charges -H - "X-Api-Key: {{ user.wallets[0].inkey }}" - - - - - - - - DELETE - /satspay/api/v1/charge/<charge_id> -
Headers
- {"X-Api-Key": <admin_key>}
-
Returns 204 NO CONTENT
- -
Curl example
- curl -X DELETE {{ request.base_url - }}satspay/api/v1/charge/<charge_id> -H "X-Api-Key: {{ - user.wallets[0].adminkey }}" - - - - - - - - GET - /satspay/api/v1/charges/balance/<charge_id> -
- Body (application/json) -
-
- Returns 200 OK (application/json) -
- [<charge_object>, ...] -
Curl example
- curl -X GET {{ request.base_url - }}satspay/api/v1/charges/balance/<charge_id> -H "X-Api-Key: {{ - user.wallets[0].inkey }}" - - - - -