From 8b24e610c23a77808a7549972b66da90198d603b Mon Sep 17 00:00:00 2001
From: Yun Chen <me@yunchen.tw>
Date: Mon, 2 Jul 2018 15:26:33 +0800
Subject: [PATCH] Create API.md

Former-commit-id: cdb80789d7f0a5d6e96a7d5c4ead69f8fe474d50 [formerly cdb80789d7f0a5d6e96a7d5c4ead69f8fe474d50 [formerly 5b1f59be055c090aa65a95166a62b8ef0954a9bf]]
Former-commit-id: 84051e05be7cd6bf00826e6d6732243f2169aad6
Former-commit-id: 2cd629776d132e4e343642b677f3855d837291da
---
 API.md | 117 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 117 insertions(+)
 create mode 100644 API.md

diff --git a/API.md b/API.md
new file mode 100644
index 00000000..e4604c3e
--- /dev/null
+++ b/API.md
@@ -0,0 +1,117 @@
+# Vortex API
+
+## Network
+
+### Create Network
+
+**POST /v1/networks**
+
+Example:
+
+```
+curl -X POST -H "Content-Type: application/json" \
+     -d '{"type":"ovs","name":"awesomeNetworks","nodeName":"vortex-dev","ovs":{"bridgeName":"awesomeBridge", "physicalPorts":[]}}' \
+     http://localhost:7890/v1/networks
+```
+
+Request Data:
+
+```json
+{
+  "type": "ovs",
+  "name": "awesomeNetworks",
+  "nodeName": "vortex-dev",
+  "ovs": {
+    "bridgeName": "awesomeBridge",
+    "physicalPorts":[]
+  }
+}
+```
+
+Response Data:
+
+```json
+{
+  "error": false,
+  "message": "Create success"
+}
+```
+
+### List Network
+
+**GET /v1/networks/**
+
+Example:
+
+```
+curl http://localhost:7890/v1/networks/
+```
+
+Response Data:
+
+```json
+[{
+  "id": "5b3475f94807c5199773910a",
+  "type": "ovs",
+  "name": "awesomeNetworks",
+  "nodeName": "vortex-dev",
+  "createdAt": "2018-06-28T05:45:29.828Z",
+  "ovs": {
+   "bridgeName": "awesomeBridge",
+   "physicalPorts": []
+  },
+  "fake": {
+   "bridgeName": "",
+   "iWantFail": false
+  }
+}]
+```
+
+### Get Network
+
+**GET /v1/networks/[id]**
+
+Example:
+
+```
+curl http://localhost:7890/v1/networks/5b3475f94807c5199773910a
+```
+
+Response Data:
+
+```json
+{
+  "id": "5b3475f94807c5199773910a",
+  "type": "ovs",
+  "name": "awesomeNetwork",
+  "nodeName": "vortex-dev",
+  "createdAt": "2018-06-28T05:45:29.828Z",
+  "ovs": {
+   "bridgeName": "awesomeBridge",
+   "physicalPorts": []
+  },
+  "fake": {
+   "bridgeName": "",
+   "iWantFail": false
+  }
+}
+```
+
+### Delete Network
+
+**DELETE /v1/networks/[id]**
+
+Example:
+
+```
+curl -X DELETE http://localhost:7890/v1/networks/5b3475f94807c5199773910a
+```
+
+Response Data:
+
+```json
+{
+  "error": false,
+  "message": "Delete success"
+}
+```