correct api instructions and add readme

lnbits/extensions/scrub/templates/scrub/_api_docs.html

@@ -4,7 +4,7 @@
   label="API info"
   :content-inset-level="0.5"
 >
-  <q-expansion-item group="api" dense expand-separator label="List pay links">
+  <q-expansion-item group="api" dense expand-separator label="List scrubs">
     <q-card>
       <q-card-section>
         <code><span class="text-blue">GET</span> /scrub/api/v1/links</code>
@@ -17,40 +17,38 @@
         <code>[&lt;pay_link_object&gt;, ...]</code>
         <h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5>
         <code
-          >curl -X GET {{ request.base_url }}api/v1/links -H "X-Api-Key: {{
+          >curl -X GET {{ request.base_url }}scrub/api/v1/links?all_wallets=true
-          user.wallets[0].inkey }}"
+          -H "X-Api-Key: {{ user.wallets[0].inkey }}"
         </code>
       </q-card-section>
     </q-card>
   </q-expansion-item>
-  <q-expansion-item group="api" dense expand-separator label="Get a pay link">
+  <q-expansion-item group="api" dense expand-separator label="Get a scrub">
     <q-card>
       <q-card-section>
         <code
           ><span class="text-blue">GET</span>
-          /scrub/api/v1/links/&lt;pay_id&gt;</code
+          /scrub/api/v1/links/&lt;scrub_id&gt;</code
         >
         <h5 class="text-caption q-mt-sm q-mb-none">Headers</h5>
         <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">
-          Returns 201 CREATED (application/json)
+          Returns 200 OK (application/json)
         </h5>
-        <code>{"lnurl": &lt;string&gt;}</code>
+        <code
+          >{"id": &lt;string&gt;, "wallet": &lt;string&gt;, "description":
+          &lt;string&gt;, "payoraddress": &lt;string&gt;}</code
+        >
         <h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5>
         <code
-          >curl -X GET {{ request.base_url }}api/v1/links/&lt;pay_id&gt; -H
+          >curl -X GET {{ request.base_url }}scrub/api/v1/links/&lt;pay_id&gt;
-          "X-Api-Key: {{ user.wallets[0].inkey }}"
+          -H "X-Api-Key: {{ user.wallets[0].inkey }}"
         </code>
       </q-card-section>
     </q-card>
   </q-expansion-item>
-  <q-expansion-item
+  <q-expansion-item group="api" dense expand-separator label="Create a scrub">
-    group="api"
-    dense
-    expand-separator
-    label="Create a pay link"
-  >
     <q-card>
       <q-card-section>
         <code><span class="text-green">POST</span> /scrub/api/v1/links</code>
@@ -58,31 +56,27 @@
         <code>{"X-Api-Key": &lt;admin_key&gt;}</code><br />
         <h5 class="text-caption q-mt-sm q-mb-none">Body (application/json)</h5>
         <code
-          >{"description": &lt;string&gt; "amount": &lt;integer&gt; "max":
+          >{"wallet": &lt;string&gt;, "description": &lt;string&gt;,
-          &lt;integer&gt; "min": &lt;integer&gt; "comment_chars":
+          "payoraddress": &lt;string&gt;}</code
-          &lt;integer&gt;}</code
         >
         <h5 class="text-caption q-mt-sm q-mb-none">
           Returns 201 CREATED (application/json)
         </h5>
-        <code>{"lnurl": &lt;string&gt;}</code>
+        <code
+          >{"id": &lt;string&gt;, "wallet": &lt;string&gt;, "description":
+          &lt;string&gt;, "payoraddress": &lt;string&gt;}</code
+        >
         <h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5>
         <code
-          >curl -X POST {{ request.base_url }}api/v1/links -d '{"description":
+          >curl -X POST {{ request.base_url }}scrub/api/v1/links -d '{"wallet":
-          &lt;string&gt;, "amount": &lt;integer&gt;, "max": &lt;integer&gt;,
+          &lt;string&gt;, "description": &lt;string&gt;, "payoraddress":
-          "min": &lt;integer&gt;, "comment_chars": &lt;integer&gt;}' -H
+          &lt;string&gt;}' -H "Content-type: application/json" -H "X-Api-Key: {{
-          "Content-type: application/json" -H "X-Api-Key: {{
           user.wallets[0].adminkey }}"
         </code>
       </q-card-section>
     </q-card>
   </q-expansion-item>
-  <q-expansion-item
+  <q-expansion-item group="api" dense expand-separator label="Update a scrub">
-    group="api"
-    dense
-    expand-separator
-    label="Update a pay link"
-  >
     <q-card>
       <q-card-section>
         <code
@@ -92,17 +86,23 @@
         <h5 class="text-caption q-mt-sm q-mb-none">Headers</h5>
         <code>{"X-Api-Key": &lt;admin_key&gt;}</code><br />
         <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
+          >{"wallet": &lt;string&gt;, "description": &lt;string&gt;,
+          "payoraddress": &lt;string&gt;}</code
+        >
         <h5 class="text-caption q-mt-sm q-mb-none">
           Returns 200 OK (application/json)
         </h5>
-        <code>{"lnurl": &lt;string&gt;}</code>
+        <code
+          >{"id": &lt;string&gt;, "wallet": &lt;string&gt;, "description":
+          &lt;string&gt;, "payoraddress": &lt;string&gt;}</code
+        >
         <h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5>
         <code
-          >curl -X PUT {{ request.base_url }}api/v1/links/&lt;pay_id&gt; -d
+          >curl -X PUT {{ request.base_url }}scrub/api/v1/links/&lt;pay_id&gt;
-          '{"description": &lt;string&gt;, "amount": &lt;integer&gt;}' -H
+          -d '{"wallet": &lt;string&gt;, "description": &lt;string&gt;,
-          "Content-type: application/json" -H "X-Api-Key: {{
+          "payoraddress": &lt;string&gt;}' -H "Content-type: application/json"
-          user.wallets[0].adminkey }}"
+          -H "X-Api-Key: {{ user.wallets[0].adminkey }}"
         </code>
       </q-card-section>
     </q-card>
@@ -111,7 +111,7 @@
     group="api"
     dense
     expand-separator
-    label="Delete a pay link"
+    label="Delete a scrub"
     class="q-pb-md"
   >
     <q-card>
@@ -126,8 +126,9 @@
         <code></code>
         <h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5>
         <code
-          >curl -X DELETE {{ request.base_url }}api/v1/links/&lt;pay_id&gt; -H
+          >curl -X DELETE {{ request.base_url
-          "X-Api-Key: {{ user.wallets[0].adminkey }}"
+          }}scrub/api/v1/links/&lt;pay_id&gt; -H "X-Api-Key: {{
+          user.wallets[0].adminkey }}"
         </code>
       </q-card-section>
     </q-card>