diff --git a/lnbits/extensions/scrub/templates/scrub/_api_docs.html b/lnbits/extensions/scrub/templates/scrub/_api_docs.html index 894e45c4..ae3f44d8 100644 --- a/lnbits/extensions/scrub/templates/scrub/_api_docs.html +++ b/lnbits/extensions/scrub/templates/scrub/_api_docs.html @@ -4,7 +4,7 @@ label="API info" :content-inset-level="0.5" > - + GET /scrub/api/v1/links @@ -17,40 +17,38 @@ [<pay_link_object>, ...]
Curl example
curl -X GET {{ request.base_url }}api/v1/links -H "X-Api-Key: {{ - user.wallets[0].inkey }}" + >curl -X GET {{ request.base_url }}scrub/api/v1/links?all_wallets=true + -H "X-Api-Key: {{ user.wallets[0].inkey }}"
- + GET - /scrub/api/v1/links/<pay_id>
Headers
{"X-Api-Key": <invoice_key>}
Body (application/json)
- Returns 201 CREATED (application/json) + Returns 200 OK (application/json)
- {"lnurl": <string>} + {"id": <string>, "wallet": <string>, "description": + <string>, "payoraddress": <string>}
Curl example
curl -X GET {{ request.base_url }}api/v1/links/<pay_id> -H - "X-Api-Key: {{ user.wallets[0].inkey }}" + >curl -X GET {{ request.base_url }}scrub/api/v1/links/<pay_id> + -H "X-Api-Key: {{ user.wallets[0].inkey }}"
- + POST /scrub/api/v1/links @@ -58,31 +56,27 @@ {"X-Api-Key": <admin_key>}
Body (application/json)
{"description": <string> "amount": <integer> "max": - <integer> "min": <integer> "comment_chars": - <integer>}{"wallet": <string>, "description": <string>, + "payoraddress": <string>}
Returns 201 CREATED (application/json)
- {"lnurl": <string>} + {"id": <string>, "wallet": <string>, "description": + <string>, "payoraddress": <string>}
Curl example
curl -X POST {{ request.base_url }}api/v1/links -d '{"description": - <string>, "amount": <integer>, "max": <integer>, - "min": <integer>, "comment_chars": <integer>}' -H - "Content-type: application/json" -H "X-Api-Key: {{ + >curl -X POST {{ request.base_url }}scrub/api/v1/links -d '{"wallet": + <string>, "description": <string>, "payoraddress": + <string>}' -H "Content-type: application/json" -H "X-Api-Key: {{ user.wallets[0].adminkey }}"
- + Headers {"X-Api-Key": <admin_key>}
Body (application/json)
- {"description": <string>, "amount": <integer>} + {"wallet": <string>, "description": <string>, + "payoraddress": <string>}
Returns 200 OK (application/json)
- {"lnurl": <string>} + {"id": <string>, "wallet": <string>, "description": + <string>, "payoraddress": <string>}
Curl example
curl -X PUT {{ request.base_url }}api/v1/links/<pay_id> -d - '{"description": <string>, "amount": <integer>}' -H - "Content-type: application/json" -H "X-Api-Key: {{ - user.wallets[0].adminkey }}" + >curl -X PUT {{ request.base_url }}scrub/api/v1/links/<pay_id> + -d '{"wallet": <string>, "description": <string>, + "payoraddress": <string>}' -H "Content-type: application/json" + -H "X-Api-Key: {{ user.wallets[0].adminkey }}"
@@ -111,7 +111,7 @@ group="api" dense expand-separator - label="Delete a pay link" + label="Delete a scrub" class="q-pb-md" > @@ -126,8 +126,9 @@
Curl example
curl -X DELETE {{ request.base_url }}api/v1/links/<pay_id> -H - "X-Api-Key: {{ user.wallets[0].adminkey }}" + >curl -X DELETE {{ request.base_url + }}scrub/api/v1/links/<pay_id> -H "X-Api-Key: {{ + user.wallets[0].adminkey }}"