From 2220decb2b32e11bfccc5ef553fb806b7c8136ec Mon Sep 17 00:00:00 2001
From: Zhang Huangbin <Zhang Huangbin@localhost>
Date: Thu, 25 Oct 2018 22:58:12 +0200
Subject: [PATCH] Sync iRedAdmin-Pro API document.

---
 .../0-iredadmin-pro.restful.api-new.md        | 23 ++++++++-
 html/iredadmin-pro.restful.api-new.html       | 51 ++++++++++++++++++-
 2 files changed, 70 insertions(+), 4 deletions(-)

diff --git a/en_US/iredadmin/0-iredadmin-pro.restful.api-new.md b/en_US/iredadmin/0-iredadmin-pro.restful.api-new.md
index 23db4b3f..363e0dfc 100644
--- a/en_US/iredadmin/0-iredadmin-pro.restful.api-new.md
+++ b/en_US/iredadmin/0-iredadmin-pro.restful.api-new.md
@@ -4,7 +4,7 @@
 
 !!! attention
 
-    * This document is applicable to `iRedAdmin-Pro-SQL-2.9.1` and
+    * This document is applicable to `iRedAdmin-Pro-SQL-3.0` and
       `iRedAdmin-Pro-LDAP-3.2`. If you're running an old release, please
       upgrade iRedAdmin-Pro to the latest release, or check
       [document for old releases](./iredadmin-pro.releases.html).
@@ -409,7 +409,26 @@ Notes:
       it's implemented with [`mlmmj`](http://mlmmj.org) mailing list manager.
     * It's available for both SQL and LDAP backends.
 
-!!! api "`GET`{: .get } `/api/ml/<mail>`{: .url } `Get profile of an existing mailing list account`{: .comment }"
+!!! api "`GET`{: .get } `/api/mls/<domain>`{: .url } `Get profile of all mailing lists under given domain`{: .comment } `Parameters`{: .has_params}"
+
+    <div class="params">
+
+    Parameter | Sample Usage | Default Value | Comment
+    --- |--- |---|---
+    `email_only` | `email_only=yes` | `no` | Return a list of mailing list email addresses instead of detailed profile.
+
+    </div>
+
+!!! api "`GET`{: .get } `/api/ml/<mail>`{: .url } `Get profile of an existing mailing list account`{: .comment } `Parameters`{: .has_params}"
+
+    <div class="params">
+
+    Parameter | Sample Usage | Default Value | Comment
+    --- |--- |---|---
+    `with_subscribers` | `with_subscribers=yes` | `no` | Get subscribers of mailing list.
+
+    </div>
+
 !!! api "`POST`{: .post } `/api/ml/<mail>`{: .url } `Create a new mailing list`{: .comment } `Parameters`{: .has_params }"
 
     <div class="params">
diff --git a/html/iredadmin-pro.restful.api-new.html b/html/iredadmin-pro.restful.api-new.html
index 1cb69906..79161df5 100644
--- a/html/iredadmin-pro.restful.api-new.html
+++ b/html/iredadmin-pro.restful.api-new.html
@@ -53,7 +53,7 @@
 <div class="admonition attention">
 <p class="admonition-title">Attention</p>
 <ul>
-<li>This document is applicable to <code>iRedAdmin-Pro-SQL-2.9.1</code> and
+<li>This document is applicable to <code>iRedAdmin-Pro-SQL-3.0</code> and
   <code>iRedAdmin-Pro-LDAP-3.2</code>. If you're running an old release, please
   upgrade iRedAdmin-Pro to the latest release, or check
   <a href="./iredadmin-pro.releases.html">document for old releases</a>.</li>
@@ -1127,7 +1127,54 @@ to be a domain admin.</p>
 </ul>
 </div>
 <div class="admonition api">
-<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/ml/&lt;mail&gt;</code> <code class="comment">Get profile of an existing mailing list account</code></p>
+<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/mls/&lt;domain&gt;</code> <code class="comment">Get profile of all mailing lists under given domain</code> <code class="has_params">Parameters</code></p>
+<div class="params">
+
+<table>
+<thead>
+<tr>
+<th>Parameter</th>
+<th>Sample Usage</th>
+<th>Default Value</th>
+<th>Comment</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>email_only</code></td>
+<td><code>email_only=yes</code></td>
+<td><code>no</code></td>
+<td>Return a list of mailing list email addresses instead of detailed profile.</td>
+</tr>
+</tbody>
+</table>
+</div>
+
+</div>
+<div class="admonition api">
+<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/ml/&lt;mail&gt;</code> <code class="comment">Get profile of an existing mailing list account</code> <code class="has_params">Parameters</code></p>
+<div class="params">
+
+<table>
+<thead>
+<tr>
+<th>Parameter</th>
+<th>Sample Usage</th>
+<th>Default Value</th>
+<th>Comment</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>with_subscribers</code></td>
+<td><code>with_subscribers=yes</code></td>
+<td><code>no</code></td>
+<td>Get subscribers of mailing list.</td>
+</tr>
+</tbody>
+</table>
+</div>
+
 </div>
 <div class="admonition api">
 <p class="admonition-title"><code class="post">POST</code> <code class="url">/api/ml/&lt;mail&gt;</code> <code class="comment">Create a new mailing list</code> <code class="has_params">Parameters</code></p>