deploy: 9381e086a1

docs/apis/apis/index.html

@@ -401,6 +401,13 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
+        <li class="md-nav__item">
+  <a href="#openapi-swagger-spec" class="md-nav__link">
+    OpenAPI (Swagger) spec
+  </a>
+  
+</li>
+      
         <li class="md-nav__item">
   <a href="#response-structure" class="md-nav__link">
     Response structure
@@ -581,6 +588,13 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
+        <li class="md-nav__item">
+  <a href="#openapi-swagger-spec" class="md-nav__link">
+    OpenAPI (Swagger) spec
+  </a>
+  
+</li>
+      
         <li class="md-nav__item">
   <a href="#response-structure" class="md-nav__link">
     Response structure
@@ -640,12 +654,11 @@
 <h1 id="apis">APIs<a class="headerlink" href="#apis" title="Permanent link">&para;</a></h1>
 <p>All features that are available on the listmonk dashboard are also available as REST-like HTTP APIs that can be interacted with directly. Request and response bodies are JSON. This allows easy scripting of listmonk and integration with other systems, for instance, synchronisation with external subscriber databases.</p>
 <p>API requests require BasicAuth authentication with the admin credentials.</p>
-<div class="admonition warning">
-<p class="admonition-title">Work in progress</p>
-</div>
 <blockquote>
-<p>The API section is a work in progress. There are a large number of API calls that are yet to be documented.</p>
+<p>The API section is a work in progress. There may be API calls that are yet to be documented. Please consider contributing to docs.</p>
 </blockquote>
+<h2 id="openapi-swagger-spec">OpenAPI (Swagger) spec<a class="headerlink" href="#openapi-swagger-spec" title="Permanent link">&para;</a></h2>
+<p>The auto-generated OpenAPI (Swagger) specification site for the APIs are available at <a href="https://listmonk.app/docs/swagger/"><strong>listmonk.app/docs/swagger</strong></a></p>
 <h2 id="response-structure">Response structure<a class="headerlink" href="#response-structure" title="Permanent link">&para;</a></h2>
 <h3 id="successful-request">Successful request<a class="headerlink" href="#successful-request" title="Permanent link">&para;</a></h3>
 <div class="highlight"><pre><span></span><code><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>