From ed092c425614caf582bbf2ef330b82ca6267b0a2 Mon Sep 17 00:00:00 2001
From: Zhang Huangbin <Zhang Huangbin@localhost>
Date: Wed, 25 Jan 2017 22:59:52 +0800
Subject: [PATCH] Update iRedAdmin-Pro RESTful API doc.

---
 .../iredadmin/2-iredadmin-pro.restful.api.md  | 13 ++++++++
 html/iredadmin-pro.restful.api.html           | 30 +++++++++++++++++++
 2 files changed, 43 insertions(+)

diff --git a/en_US/iredadmin/2-iredadmin-pro.restful.api.md b/en_US/iredadmin/2-iredadmin-pro.restful.api.md
index 3674f025..33140e4b 100644
--- a/en_US/iredadmin/2-iredadmin-pro.restful.api.md
+++ b/en_US/iredadmin/2-iredadmin-pro.restful.api.md
@@ -68,6 +68,19 @@ Notes:
 
 <button type="button" class="toggle_all">Expand/Collapse All API Parameters</button>
 
+### Login {: .toggle }
+
+!!! api "`POST`{: .post } `/api/login`{: .url } `Login with an admin username (full email address) and password`{: .comment } `Parameters`{: .has_params }"
+
+    <div class="params params_domain">
+
+    Parameter | Summary | Sample Usage
+    --- |--- |---
+    `username` | Admin username. Must be a full email address. | `username=admin@mydomain.com`
+    `password` | (Plain) admin password. | `password=AsTr0ng@`
+
+    </div>
+
 ### Domain {: .toggle }
 
 !!! api "`GET`{: .get } `/api/domain/<domain>`{: .url } `Get profile of an existing domain`{: .comment }"
diff --git a/html/iredadmin-pro.restful.api.html b/html/iredadmin-pro.restful.api.html
index f45e31a0..5958fcab 100644
--- a/html/iredadmin-pro.restful.api.html
+++ b/html/iredadmin-pro.restful.api.html
@@ -25,6 +25,7 @@
 <li><a href="#enable-restful-api">Enable RESTful API</a></li>
 <li><a href="#sample-code-to-interact-with-iredadmin-pro-restful-api">Sample code to interact with iRedAdmin-Pro RESTful API</a></li>
 <li><a href="#apis">APIs</a><ul>
+<li><a href="#login">Login</a></li>
 <li><a href="#domain">Domain</a></li>
 <li><a href="#domain-admin">Domain Admin</a></li>
 <li><a href="#mail-user">Mail User</a></li>
@@ -103,6 +104,35 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
 <li>replace <code>&lt;number&gt;</code> in URL by an integer number. e.g. <code>30</code>, <code>200</code></li>
 </ul>
 <p><button type="button" class="toggle_all">Expand/Collapse All API Parameters</button></p>
+<h3 class="toggle" id="login">Login</h3>
+<div class="admonition api">
+<p class="admonition-title"><code class="post">POST</code> <code class="url">/api/login</code> <code class="comment">Login with an admin username (full email address) and password</code> <code class="has_params">Parameters</code></p>
+<div class="params params_domain">
+
+<table>
+<thead>
+<tr>
+<th>Parameter</th>
+<th>Summary</th>
+<th>Sample Usage</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>username</code></td>
+<td>Admin username. Must be a full email address.</td>
+<td><code>username=admin@mydomain.com</code></td>
+</tr>
+<tr>
+<td><code>password</code></td>
+<td>(Plain) admin password.</td>
+<td><code>password=AsTr0ng@</code></td>
+</tr>
+</tbody>
+</table>
+</div>
+
+</div>
 <h3 class="toggle" id="domain">Domain</h3>
 <div class="admonition api">
 <p class="admonition-title"><code class="get">GET</code> <code class="url">/api/domain/&lt;domain&gt;</code> <code class="comment">Get profile of an existing domain</code></p>