From f7b4aa91abdaccc4a2b7bb254d06e69f04b2e0c3 Mon Sep 17 00:00:00 2001
From: Lee Salminen <leesalminen@gmail.com>
Date: Tue, 20 Dec 2022 07:49:35 -0600
Subject: [PATCH] API docs

---
 .../templates/nostrnip5/_api_docs.html        | 60 +++++++++++++------
 1 file changed, 41 insertions(+), 19 deletions(-)

diff --git a/lnbits/extensions/nostrnip5/templates/nostrnip5/_api_docs.html b/lnbits/extensions/nostrnip5/templates/nostrnip5/_api_docs.html
index 6e2a6355..3135641d 100644
--- a/lnbits/extensions/nostrnip5/templates/nostrnip5/_api_docs.html
+++ b/lnbits/extensions/nostrnip5/templates/nostrnip5/_api_docs.html
@@ -4,11 +4,11 @@
   label="API info"
   :content-inset-level="0.5"
 >
-  <q-expansion-item group="api" dense expand-separator label="List Invoices">
+  <q-expansion-item group="api" dense expand-separator label="List Domains">
     <q-card>
       <q-card-section>
         <code
-          ><span class="text-blue">GET</span> /invoices/api/v1/invoices</code
+          ><span class="text-blue">GET</span> /nostrnip5/api/v1/domains</code
         >
         <h5 class="text-caption q-mt-sm q-mb-none">Headers</h5>
         <code>{"X-Api-Key": &lt;invoice_key&gt;}</code><br />
@@ -16,22 +16,21 @@
         <h5 class="text-caption q-mt-sm q-mb-none">
           Returns 200 OK (application/json)
         </h5>
-        <code>[&lt;invoice_object&gt;, ...]</code>
+        <code>[&lt;domain_object&gt;, ...]</code>
         <h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5>
         <code
-          >curl -X GET {{ request.base_url }}invoices/api/v1/invoices -H
+          >curl -X GET {{ request.base_url }}nostrnip5/api/v1/domains -H
           "X-Api-Key: &lt;invoice_key&gt;"
         </code>
       </q-card-section>
     </q-card>
   </q-expansion-item>
 
-  <q-expansion-item group="api" dense expand-separator label="Fetch Invoice">
+  <q-expansion-item group="api" dense expand-separator label="List Addresses">
     <q-card>
       <q-card-section>
         <code
-          ><span class="text-blue">GET</span>
-          /invoices/api/v1/invoice/{invoice_id}</code
+          ><span class="text-blue">GET</span> /nostrnip5/api/v1/addresses</code
         >
         <h5 class="text-caption q-mt-sm q-mb-none">Headers</h5>
         <code>{"X-Api-Key": &lt;invoice_key&gt;}</code><br />
@@ -39,22 +38,45 @@
         <h5 class="text-caption q-mt-sm q-mb-none">
           Returns 200 OK (application/json)
         </h5>
-        <code>{invoice_object}</code>
+        <code>[&lt;address_object&gt;, ...]</code>
+        <h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5>
+        <code
+          >curl -X GET {{ request.base_url }}nostrnip5/api/v1/addresses -H
+          "X-Api-Key: &lt;invoice_key&gt;"
+        </code>
+      </q-card-section>
+    </q-card>
+  </q-expansion-item>
+
+  <q-expansion-item group="api" dense expand-separator label="Fetch Domain">
+    <q-card>
+      <q-card-section>
+        <code
+          ><span class="text-blue">GET</span>
+          /nostrnip5/api/v1/domain/{domain_id}</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 200 OK (application/json)
+        </h5>
+        <code>{domain_object}</code>
         <h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5>
         <code
           >curl -X GET {{ request.base_url
-          }}invoices/api/v1/invoice/{invoice_id} -H "X-Api-Key:
+          }}nostrnip5/api/v1/domain/{domain_id} -H "X-Api-Key:
           &lt;invoice_key&gt;"
         </code>
       </q-card-section>
     </q-card>
   </q-expansion-item>
 
-  <q-expansion-item group="api" dense expand-separator label="Create Invoice">
+  <q-expansion-item group="api" dense expand-separator label="Create Domain">
     <q-card>
       <q-card-section>
         <code
-          ><span class="text-blue">POST</span> /invoices/api/v1/invoice</code
+          ><span class="text-blue">POST</span> /nostrnip5/api/v1/domain</code
         >
         <h5 class="text-caption q-mt-sm q-mb-none">Headers</h5>
         <code>{"X-Api-Key": &lt;invoice_key&gt;}</code><br />
@@ -62,22 +84,22 @@
         <h5 class="text-caption q-mt-sm q-mb-none">
           Returns 200 OK (application/json)
         </h5>
-        <code>{invoice_object}</code>
+        <code>{domain_object}</code>
         <h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5>
         <code
-          >curl -X POST {{ request.base_url }}invoices/api/v1/invoice -H
+          >curl -X POST {{ request.base_url }}nostrnip5/api/v1/domain -H
           "X-Api-Key: &lt;invoice_key&gt;"
         </code>
       </q-card-section>
     </q-card>
   </q-expansion-item>
 
-  <q-expansion-item group="api" dense expand-separator label="Update Invoice">
+  <q-expansion-item group="api" dense expand-separator label="Create Address">
     <q-card>
       <q-card-section>
         <code
           ><span class="text-blue">POST</span>
-          /invoices/api/v1/invoice/{invoice_id}</code
+          /nostrnip5/api/v1/domain/{domain_id}/address</code
         >
         <h5 class="text-caption q-mt-sm q-mb-none">Headers</h5>
         <code>{"X-Api-Key": &lt;invoice_key&gt;}</code><br />
@@ -85,11 +107,11 @@
         <h5 class="text-caption q-mt-sm q-mb-none">
           Returns 200 OK (application/json)
         </h5>
-        <code>{invoice_object}</code>
+        <code>{address_object}</code>
         <h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5>
         <code
           >curl -X POST {{ request.base_url
-          }}invoices/api/v1/invoice/{invoice_id} -H "X-Api-Key:
+          }}nostrnip5/api/v1/domain/{domain_id}/address -H "X-Api-Key:
           &lt;invoice_key&gt;"
         </code>
       </q-card-section>
@@ -134,7 +156,7 @@
       <q-card-section>
         <code
           ><span class="text-blue">GET</span>
-          /invoices/api/v1/invoice/{invoice_id}/payments/{payment_hash}</code
+          /nostrnip5/api/v1/domain/{domain_id}/payments/{payment_hash}</code
         >
         <h5 class="text-caption q-mt-sm q-mb-none">Headers</h5>
         <h5 class="text-caption q-mt-sm q-mb-none">Body (application/json)</h5>
@@ -144,7 +166,7 @@
         <h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5>
         <code
           >curl -X GET {{ request.base_url
-          }}invoices/api/v1/invoice/{invoice_id}/payments/{payment_hash} -H
+          }}nostrnip5/api/v1/domain/{domain_id}/payments/{payment_hash} -H
           "X-Api-Key: &lt;invoice_key&gt;"
         </code>
       </q-card-section>