aiolabs/lnbits
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

Adding satspay docs, making same as btcpay

Browse source
This commit is contained in:
benarc 2021-02-23 19:35:17 +00:00
parent d95159d73b
commit 5c894ff707
3 changed files with 22 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

21
lnbits/extensions/satspay/templates/satspay/_api_docs.html
View file

@ -60,19 +60,34 @@
group="api" group="api"
dense dense
expand-separator expand-separator
label="Create a pay link" label="Create a charge link"
> >
<q-card> <q-card>
<q-card-section> <q-card-section>
<code><span class="text-green">POST</span> /pay/api/v1/links</code> <code><span class="text-green">POST</span> /pay/api/v1/links</code>
<h5 class="text-caption q-mt-sm q-mb-none">Headers</h5> <h5 class="text-caption q-mt-sm q-mb-none">Headers</h5>
<code>{"X-Api-Key": &lt;admin_key&gt;}</code><br /> <code>{"X-Api-Key": &lt;invoice_key&gt;}</code><br />
<h5 class="text-caption q-mt-sm q-mb-none">Body (application/json)</h5> <h5 class="text-caption q-mt-sm q-mb-none">Body (application/json)</h5>
<code>{"description": &lt;string&gt; "amount": &lt;integer&gt;}</code> <code>{"description": &lt;string&gt; "amount": &lt;integer&gt;}</code>
<h5 class="text-caption q-mt-sm q-mb-none"> <h5 class="text-caption q-mt-sm q-mb-none">
Returns 201 CREATED (application/json) Returns 201 CREATED (application/json)
</h5> </h5>
<code>{"lnurl": &lt;string&gt;}</code> <code> {
"deliveryId": &lt;string&gt;,
"description": &lt;string&gt;,
"webhookId": &lt;string&gt;,
"originalDeliveryId": &lt;string&gt;,
"isRedelivery": &lt;boolean&gt;,
"type": &lt;string&gt;,
"timestamp": &lt;int&gt;,
"paytime": &lt;int&gt;,
"storeId": &lt;string&gt;,
"invoiceId": &lt;string&gt;,
"manuallyMarked": &lt;boolean&gt;,
"overPaid": &lt;boolean&gt;,
"afterExpiration": &lt;boolean&gt;,
"partiallyPaid": &lt;boolean&gt;
}<br/><small>"type" can be InvoiceReceivedPayment, InvoicePaidInFull, InvoiceExpired, InvoiceConfirmed, and InvoiceInvalid</small> </code>
<h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5> <h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5>
<code <code
>curl -X POST {{ request.url_root }}pay/api/v1/links -d >curl -X POST {{ request.url_root }}pay/api/v1/links -d

4
lnbits/extensions/satspay/templates/satspay/index.html
View file

@ -149,9 +149,9 @@
<q-input <q-input
filled filled
dense dense
v-model.trim="formDialogCharge.data.title" v-model.trim="formDialogCharge.data.description"
type="text" type="text"
label="Title" label="Description"
></q-input> ></q-input>
<q-input <q-input

3
lnbits/extensions/watchonly/templates/watchonly/_api_docs.html
View file

@ -60,7 +60,7 @@
group="api" group="api"
dense dense
expand-separator expand-separator
label="Create a pay link" label="Create a charge link"
> >
<q-card> <q-card>
<q-card-section> <q-card-section>
@ -71,6 +71,7 @@
<code>{"description": &lt;string&gt; "amount": &lt;integer&gt;}</code> <code>{"description": &lt;string&gt; "amount": &lt;integer&gt;}</code>
<h5 class="text-caption q-mt-sm q-mb-none"> <h5 class="text-caption q-mt-sm q-mb-none">
Returns 201 CREATED (application/json) Returns 201 CREATED (application/json)
</h5> </h5>
<code>{"lnurl": &lt;string&gt;}</code> <code>{"lnurl": &lt;string&gt;}</code>
<h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5> <h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5>