Merge pull request #790 from lnbits/addswagger

Adds link to swagger docs in all extensions
2025-04-08 03:48:30 +02:00 · 2022-07-27 19:40:22 +01:00 · 2022-07-27 19:40:22 +01:00 · f973de2f22
commit f973de2f22
parent c3d3f843c1 64ea5db608
25 changed files with 44 additions and 1 deletions
--- a/lnbits/extensions/bleskomat/templates/bleskomat/_api_docs.html
+++ b/lnbits/extensions/bleskomat/templates/bleskomat/_api_docs.html
@ -62,4 +62,5 @@
      </p>
    </q-card-section>
  </q-card>
+  <q-btn flat label="Swagger API" type="a" href="../docs#/Bleskomat"></q-btn>
 </q-expansion-item>
--- a/lnbits/extensions/copilot/templates/copilot/_api_docs.html
+++ b/lnbits/extensions/copilot/templates/copilot/_api_docs.html
@ -14,6 +14,7 @@
    label="API info"
    :content-inset-level="0.5"
  >
+    <q-btn flat label="Swagger API" type="a" href="../docs#/copilot"></q-btn>
    <q-expansion-item group="api" dense expand-separator label="Create copilot">
      <q-card>
        <q-card-section>
--- a/lnbits/extensions/discordbot/templates/discordbot/_api_docs.html
+++ b/lnbits/extensions/discordbot/templates/discordbot/_api_docs.html
@ -34,6 +34,7 @@
  label="API info"
  :content-inset-level="0.5"
 >
+  <q-btn flat label="Swagger API" type="a" href="../docs#/discordbot"></q-btn>
  <q-expansion-item group="api" dense expand-separator label="GET users">
    <q-card>
      <q-card-section>
--- a/lnbits/extensions/events/templates/events/_api_docs.html
+++ b/lnbits/extensions/events/templates/events/_api_docs.html
@ -20,4 +20,5 @@
      </p>
    </q-card-section>
  </q-card>
+  <q-btn flat label="Swagger API" type="a" href="../docs#/events"></q-btn>
 </q-expansion-item>
--- a/lnbits/extensions/jukebox/templates/jukebox/_api_docs.html
+++ b/lnbits/extensions/jukebox/templates/jukebox/_api_docs.html
@ -24,6 +24,8 @@
  label="API info"
  :content-inset-level="0.5"
 >
+  <q-btn flat label="Swagger API" type="a" href="../docs#/jukebox"></q-btn>
+
  <q-expansion-item group="api" dense expand-separator label="List jukeboxes">
    <q-card>
      <q-card-section>
--- a/lnbits/extensions/livestream/templates/livestream/_api_docs.html
+++ b/lnbits/extensions/livestream/templates/livestream/_api_docs.html
@ -17,6 +17,8 @@
  label="API info"
  :content-inset-level="0.5"
 >
+  <q-btn flat label="Swagger API" type="a" href="../docs#/livestream"></q-btn>
+
  <q-expansion-item
    group="api"
    dense
--- a/lnbits/extensions/lnaddress/templates/lnaddress/_api_docs.html
+++ b/lnbits/extensions/lnaddress/templates/lnaddress/_api_docs.html
@ -31,6 +31,7 @@
  label="API info"
  :content-inset-level="0.5"
 >
+  <q-btn flat label="Swagger API" type="a" href="../docs#/lnaddress"></q-btn>
  <q-expansion-item group="api" dense expand-separator label="GET domains">
    <q-card>
      <q-card-section>
--- a/lnbits/extensions/lndhub/templates/lndhub/_instructions.html
+++ b/lnbits/extensions/lndhub/templates/lndhub/_instructions.html
@ -31,5 +31,6 @@
        </li>
      </ul>
    </q-card-section>
+    <q-btn flat label="Swagger API" type="a" href="../docs#/lndhub"></q-btn>
  </q-card>
 </q-expansion-item>
--- a/lnbits/extensions/lnticket/templates/lnticket/_api_docs.html
+++ b/lnbits/extensions/lnticket/templates/lnticket/_api_docs.html
@ -19,4 +19,5 @@
      </p>
    </q-card-section>
  </q-card>
+  <q-btn flat label="Swagger API" type="a" href="../docs#/lnticket"></q-btn>
 </q-expansion-item>
--- a/lnbits/extensions/lnurldevice/templates/lnurldevice/_api_docs.html
+++ b/lnbits/extensions/lnurldevice/templates/lnurldevice/_api_docs.html
@ -17,6 +17,12 @@
    label="API info"
    :content-inset-level="0.5"
  >
+    <q-btn
+      flat
+      label="Swagger API"
+      type="a"
+      href="../docs#/lnurldevice"
+    ></q-btn>
    <q-expansion-item
      group="api"
      dense
--- a/lnbits/extensions/lnurlp/templates/lnurlp/_api_docs.html
+++ b/lnbits/extensions/lnurlp/templates/lnurlp/_api_docs.html
@ -4,6 +4,7 @@
  label="API info"
  :content-inset-level="0.5"
 >
+  <q-btn flat label="Swagger API" type="a" href="../docs#/lnurlp"></q-btn>
  <q-expansion-item group="api" dense expand-separator label="List pay links">
    <q-card>
      <q-card-section>
@ -51,6 +52,7 @@
    expand-separator
    label="Create a pay link"
  >
+    <q-btn flat label="Swagger API" type="a" href="../docs#/lnurlp"></q-btn>
    <q-card>
      <q-card-section>
        <code><span class="text-green">POST</span> /lnurlp/api/v1/links</code>
--- a/lnbits/extensions/lnurlpayout/config.json.example
+++ b/lnbits/extensions/lnurlpayout/config.json.example
@ -2,5 +2,5 @@
  "name": "LNURLPayout",
  "short_description": "Autodump wallet funds to LNURLpay",
  "icon": "exit_to_app",
-  "contributors": ["arcbtc"]
+  "contributors": ["arcbtc","talvasconcelos"]
 }
--- a/lnbits/extensions/lnurlpayout/templates/lnurlpayout/_api_docs.html
+++ b/lnbits/extensions/lnurlpayout/templates/lnurlpayout/_api_docs.html
@ -4,6 +4,12 @@
  label="API info"
  :content-inset-level="0.5"
 >
+<q-btn
+      flat
+      label="Swagger API"
+      type="a"
+      href="../docs#/lnurlpayout"
+    ></q-btn>
  <q-expansion-item group="api" dense expand-separator label="List lnurlpayout">
    <q-card>
      <q-card-section>
@ -32,6 +38,7 @@
    expand-separator
    label="Create a lnurlpayout"
  >
+    
    <q-card>
      <q-card-section>
        <code
--- a/lnbits/extensions/offlineshop/templates/offlineshop/_api_docs.html
+++ b/lnbits/extensions/offlineshop/templates/offlineshop/_api_docs.html
@ -47,6 +47,7 @@
  label="API info"
  :content-inset-level="0.5"
 >
+  <q-btn flat label="Swagger API" type="a" href="../docs#/offlineshop"></q-btn>
  <q-expansion-item
    group="api"
    dense
--- a/lnbits/extensions/paywall/templates/paywall/_api_docs.html
+++ b/lnbits/extensions/paywall/templates/paywall/_api_docs.html
@ -4,6 +4,7 @@
  label="API info"
  :content-inset-level="0.5"
 >
+  <q-btn flat label="Swagger API" type="a" href="../docs#/paywall"></q-btn>
  <q-expansion-item group="api" dense expand-separator label="List paywalls">
    <q-card>
      <q-card-section>
--- a/lnbits/extensions/satsdice/templates/satsdice/_api_docs.html
+++ b/lnbits/extensions/satsdice/templates/satsdice/_api_docs.html
@ -4,6 +4,7 @@
  label="API info"
  :content-inset-level="0.5"
 >
+  <q-btn flat label="Swagger API" type="a" href="../docs#/satsdice"></q-btn>
  <q-expansion-item group="api" dense expand-separator label="List satsdices">
    <q-card>
      <q-card-section>
--- a/lnbits/extensions/satspay/templates/satspay/_api_docs.html
+++ b/lnbits/extensions/satspay/templates/satspay/_api_docs.html
@ -15,6 +15,7 @@
    label="API info"
    :content-inset-level="0.5"
  >
+    <q-btn flat label="Swagger API" type="a" href="../docs#/satspay"></q-btn>
    <q-expansion-item group="api" dense expand-separator label="Create charge">
      <q-card>
        <q-card-section>
--- a/lnbits/extensions/splitpayments/templates/splitpayments/_api_docs.html
+++ b/lnbits/extensions/splitpayments/templates/splitpayments/_api_docs.html
@ -28,6 +28,12 @@
  label="API info"
  :content-inset-level="0.5"
 >
+  <q-btn
+    flat
+    label="Swagger API"
+    type="a"
+    href="../docs#/splitpayments"
+  ></q-btn>
  <q-expansion-item
    group="api"
    dense
--- a/lnbits/extensions/streamalerts/templates/streamalerts/_api_docs.html
+++ b/lnbits/extensions/streamalerts/templates/streamalerts/_api_docs.html
@ -15,4 +15,5 @@
      >
    </p>
  </q-card-section>
+  <q-btn flat label="Swagger API" type="a" href="../docs#/streamalerts"></q-btn>
 </q-card>
--- a/lnbits/extensions/subdomains/templates/subdomains/_api_docs.html
+++ b/lnbits/extensions/subdomains/templates/subdomains/_api_docs.html
@ -22,5 +22,6 @@
        >
      </p>
    </q-card-section>
+    <q-btn flat label="Swagger API" type="a" href="../docs#/subdomains"></q-btn>
  </q-card>
 </q-expansion-item>
--- a/lnbits/extensions/tipjar/templates/tipjar/_api_docs.html
+++ b/lnbits/extensions/tipjar/templates/tipjar/_api_docs.html
@ -12,4 +12,5 @@
      >
    </p>
  </q-card-section>
+  <q-btn flat label="Swagger API" type="a" href="../docs#/tipjar"></q-btn>
 </q-card>
--- a/lnbits/extensions/tpos/templates/tpos/_api_docs.html
+++ b/lnbits/extensions/tpos/templates/tpos/_api_docs.html
@ -4,6 +4,7 @@
  label="API info"
  :content-inset-level="0.5"
 >
+  <q-btn flat label="Swagger API" type="a" href="../docs#/tpos"></q-btn>
  <q-expansion-item group="api" dense expand-separator label="List TPoS">
    <q-card>
      <q-card-section>
--- a/lnbits/extensions/usermanager/templates/usermanager/_api_docs.html
+++ b/lnbits/extensions/usermanager/templates/usermanager/_api_docs.html
@ -28,6 +28,7 @@
  label="API info"
  :content-inset-level="0.5"
 >
+  <q-btn flat label="Swagger API" type="a" href="../docs#/usermanager"></q-btn>
  <q-expansion-item group="api" dense expand-separator label="GET users">
    <q-card>
      <q-card-section>
--- a/lnbits/extensions/watchonly/templates/watchonly/_api_docs.html
+++ b/lnbits/extensions/watchonly/templates/watchonly/_api_docs.html
@ -20,6 +20,7 @@
    label="API info"
    :content-inset-level="0.5"
  >
+    <q-btn flat label="Swagger API" type="a" href="../docs#/watchonly"></q-btn>
    <q-expansion-item group="api" dense expand-separator label="List wallets">
      <q-card>
        <q-card-section>
--- a/lnbits/extensions/withdraw/templates/withdraw/_api_docs.html
+++ b/lnbits/extensions/withdraw/templates/withdraw/_api_docs.html
@ -4,6 +4,7 @@
  label="API info"
  :content-inset-level="0.5"
 >
+  <q-btn flat label="Swagger API" type="a" href="../docs#/withdraw"></q-btn>
  <q-expansion-item
    group="api"
    dense