Merge pull request #178 from linkernetworks/sufuf3/update-api.md

Update API.md - Add route part & ToC
linkernetworks · Jul 26, 2018 · 3ac0b90 · 3ac0b90
2 parents 75f7916 + 43e3c74
commit 3ac0b90
Showing 1 changed file with 64 additions and 0 deletions.
diff --git a/API.md b/API.md
@@ -1,5 +1,45 @@
 # Vortex API
 
+## Table of Contents
+* [Network](#network)
+   + [Create Network](#create-network)
+   + [List Network](#list-network)
+   + [Get Network](#get-network)
+   + [Get Network Status](#get-network-status)
+   + [Delete Network](#delete-network)
+* [Storage](#storage)
+   + [Create Storage](#create-storage)
+   + [List Storage](#list-storage)
+   + [Remove Storage](#remove-storage)
+* [Volume](#volume)
+   + [Create Volume](#create-volume)
+   + [List Volume](#list-volume)
+   + [Remove Volume](#remove-volume)
+* [Pod](#pod)
+   + [Create Pod](#create-pod)
+   + [List Pods](#list-pods)
+   + [Get Pod](#get-pod)
+   + [Delete Pod](#delete-pod)
+* [Resouce Monitoring](#resouce-monitoring)
+   + [List Nodes](#list-nodes)
+   + [Get Node](#get-node)
+   + [List NICs of certain node](#list-nics-of-certain-node)
+   + [List Pod](#list-pod)
+   + [Get Pod](#get-pod-1)
+   + [List Containers](#list-containers)
+   + [Get Container](#get-container)
+   + [List Services](#list-services)
+   + [Get Service](#get-service)
+   + [List Controllers](#list-controllers)
+   + [Get Controller](#get-controller)
+* [Service](#service)
+   + [Create Service](#create-service)
+   + [List Services](#list-services-1)
+   + [Get Service](#get-service-1)
+   + [Delete Service](#delete-service)
+
+
+
 ## Network
 
 ### Create Network
@@ -20,6 +60,12 @@ Example:
       100,
       200
    ],
+   "routes":[
+      {
+         "dstCIDR":"224.0.0.0/4",
+         "gateway":"0.0.0.0"
+      }
+   ],
    "bridgeName":"ovsbr0",
    "nodes":[
       {
@@ -47,6 +93,12 @@ Request Data:
       100,
       200
    ],
+   "routes":[
+      {
+         "dstCIDR":"224.0.0.0/4",
+         "gateway":"0.0.0.0"
+      }
+   ],
    "bridgeName":"ovsbr0",
    "nodes":[
       {
@@ -94,6 +146,12 @@ Response Data:
             100,
             200
         ],
+        "routes":[
+           {
+              "dstCIDR":"224.0.0.0/4",
+              "gateway":"0.0.0.0"
+           }
+        ],
         "bridgeName": "",
         "nodes": [
             {
@@ -146,6 +204,12 @@ Response Data:
         100,
         200
     ],
+    "routes":[
+       {
+          "dstCIDR":"224.0.0.0/4",
+          "gateway":"0.0.0.0"
+       }
+    ],
     "bridgeName": "ovsbr0",
     "nodes": [
         {