Added first stub for swagger docs.

2018-11-04 21:13:00 +08:00
parent fc5e3a6728
commit b9d6c06c82
4 changed files with 83 additions and 0 deletions
--- a/docs/swagger/swagger.json
+++ b/docs/swagger/swagger.json
@@ -0,0 +1,16 @@
+{
+    "swagger": "2.0",
+    "info": {
+        "description": "A read/write API for the Matterbridge chat bridge.",
+        "title": "Matterbridge API",
+        "contact": {},
+        "license": {
+            "name": "Apache 2.0",
+            "url": "https://github.com/42wim/matterbridge/blob/master/LICENSE"
+        },
+        "version": "TODO"
+    },
+    "host": "TODO",
+    "basePath": "/api",
+    "paths": {}
+}
--- a/docs/swagger/swagger.yaml
+++ b/docs/swagger/swagger.yaml
@@ -0,0 +1,12 @@
+basePath: /api
+host: TODO
+info:
+  contact: {}
+  description: A read/write API for the Matterbridge chat bridge.
+  license:
+    name: Apache 2.0
+    url: https://github.com/42wim/matterbridge/blob/master/LICENSE
+  title: Matterbridge API
+  version: TODO
+paths: {}
+swagger: "2.0"