Swagger HTTP API doc (#880)

esl · Aug 25, 2016 · 43fa80a · 43fa80a
1 parent 0a9bb37
commit 43fa80a
Show file tree

Hide file tree

Showing 39 changed files with 8,003 additions and 0 deletions.
diff --git a/doc/README.md b/doc/README.md
@@ -19,6 +19,7 @@
     * [Logging & monitoring](operation-and-maintenance/Logging-&-monitoring.md)
     * [Cluster configuration and node management](operation-and-maintenance/Cluster-configuration-and-node-management.md)
     * [Reloading configuration on a running system](operation-and-maintenance/Reloading-configuration-on-a-running-system.md)
+    * [HTTP Administration API](http-administration-api-documentation.md)
 * For developers
     * [Testing MongooseIM](developers-guide/Testing-MongooseIM.md)
     * [Hooks and handlers](developers-guide/Hooks-and-handlers.md)

diff --git a/doc/http-administration-api-documentation.md b/doc/http-administration-api-documentation.md
@@ -0,0 +1,8 @@
+# MongooseIM's HTTP Administration API
+
+Find the beautiful Swagger documentation below or
+under [this link](http://mongooseim.readthedocs.io/en/swagger-http-api-doc/swagger/index.html)
+
+<iframe src="http://mongooseim.readthedocs.io/en/swagger-http-api-doc/swagger/index.html"
+height="800" width="800" style="margin-left: -45px;"></iframe>
+
diff --git a/doc/http-api/README.md b/doc/http-api/README.md
@@ -0,0 +1,6 @@
+How to render the `swagger.{yml,json}`
+====
+
+Go to: http://editor.swagger.io/
+
+Then: file > Import File