diff --git a/lnbits/extensions/withdraw/templates/withdraw/_api_docs.html b/lnbits/extensions/withdraw/templates/withdraw/_api_docs.html index 0f926b84..f08ea22f 100644 --- a/lnbits/extensions/withdraw/templates/withdraw/_api_docs.html +++ b/lnbits/extensions/withdraw/templates/withdraw/_api_docs.html @@ -4,78 +4,156 @@ label="API info" :content-inset-level="0.5" > - + - GET /withdraw/api/v1/links + GET /withdraw/api/v1/links
Headers
{"X-Api-Key": <invoice_key>}
Body (application/json)
-
Returns 201 CREATED (application/json)
+
+ Returns 201 CREATED (application/json) +
{"lnurl": <string>}
Curl example
- curl -X GET {{ request.url_root }}withdraw/api/v1/links -H "X-Api-Key: {{ g.user.wallets[0].inkey }}" + curl -X GET {{ request.url_root }}withdraw/api/v1/links -H + "X-Api-Key: {{ g.user.wallets[0].inkey }}" +
- + - GET /withdraw/api/v1/links/<LNURL_id> + GET + /withdraw/api/v1/links/<LNURL_id>
Headers
{"X-Api-Key": <invoice_key>}
Body (application/json)
-
Returns 201 CREATED (application/json)
+
+ Returns 201 CREATED (application/json) +
{"lnurl": <string>}
Curl example
- curl -X GET {{ request.url_root }}withdraw/api/v1/links/<LNURL_id> -H "X-Api-Key: {{ g.user.wallets[0].inkey }}" + curl -X GET {{ request.url_root + }}withdraw/api/v1/links/<LNURL_id> -H "X-Api-Key: {{ + g.user.wallets[0].inkey }}" +
- + - POST /withdraw/api/v1/links + POST + /withdraw/api/v1/links
Headers
{"X-Api-Key": <admin_key>}
Body (application/json)
- {"title": <string>, "min_withdrawable": <integer>, "max_withdrawable": <integer>, "uses": <integer>, "wait_time": <integer>, "is_unique": <boolean>} -
Returns 201 CREATED (application/json)
+ {"title": <string>, "min_withdrawable": <integer>, + "max_withdrawable": <integer>, "uses": <integer>, + "wait_time": <integer>, "is_unique": <boolean>} +
+ Returns 201 CREATED (application/json) +
{"lnurl": <string>}
Curl example
- curl -X POST {{ request.url_root }}withdraw/api/v1/links -d '{"title": <string>, "min_withdrawable": <integer>, "max_withdrawable": <integer>, "uses": <integer>, "wait_time": <integer>, "is_unique": <boolean>}' -H "Content-type: application/json" -H "X-Api-Key: {{ g.user.wallets[0].adminkey }}" - + curl -X POST {{ request.url_root }}withdraw/api/v1/links -d + '{"title": <string>, "min_withdrawable": <integer>, + "max_withdrawable": <integer>, "uses": <integer>, + "wait_time": <integer>, "is_unique": <boolean>}' -H + "Content-type: application/json" -H "X-Api-Key: {{ + g.user.wallets[0].adminkey }}" +
- + - PUT /withdraw/api/v1/links/<withdraw_id> + PUT + /withdraw/api/v1/links/<withdraw_id>
Headers
{"X-Api-Key": <admin_key>}
Body (application/json)
- {"title": <string>, "min_withdrawable": <integer>, "max_withdrawable": <integer>, "uses": <integer>, "wait_time": <integer>, "is_unique": <boolean>} -
Returns 201 CREATED (application/json)
+ {"title": <string>, "min_withdrawable": <integer>, + "max_withdrawable": <integer>, "uses": <integer>, + "wait_time": <integer>, "is_unique": <boolean>} +
+ Returns 201 CREATED (application/json) +
{"lnurl": <string>}
Curl example
- curl -X PUT {{ request.url_root }}withdraw/api/v1/links/<withdraw_id> -d '{"title": <string>, "min_withdrawable": <integer>, "max_withdrawable": <integer>, "uses": <integer>, "wait_time": <integer>, "is_unique": <boolean>}' -H "Content-type: application/json" -H "X-Api-Key: {{ g.user.wallets[0].adminkey }}" - + curl -X PUT {{ request.url_root + }}withdraw/api/v1/links/<withdraw_id> -d '{"title": + <string>, "min_withdrawable": <integer>, + "max_withdrawable": <integer>, "uses": <integer>, + "wait_time": <integer>, "is_unique": <boolean>}' -H + "Content-type: application/json" -H "X-Api-Key: {{ + g.user.wallets[0].adminkey }}" +
- + - DELETE /withdraw/api/v1/links/<withdraw_id> + DELETE + /withdraw/api/v1/links/<withdraw_id>
Headers
{"X-Api-Key": <admin_key>}
Returns 201 NO_CONTENT
{"lnurl": <string>}
Curl example
- curl -X DELETE {{ request.url_root }}withdraw/api/v1/links/<withdraw_id> -H "X-Api-Key: {{ g.user.wallets[0].adminkey }}" - - + curl -X DELETE {{ request.url_root + }}withdraw/api/v1/links/<withdraw_id> -H "X-Api-Key: {{ + g.user.wallets[0].adminkey }}" +