update on docs for update min

topfreegames · Aug 11, 2017 · 387e8d1 · 387e8d1
1 parent bed3e1c
commit 387e8d1
Showing 1 changed file with 81 additions and 52 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -568,60 +568,75 @@ All API responses include a `X-Maestro-Version` header with the current Maestro
 
     ```
     {
-      "name": "room-name",
-      "game": "game-name",
-      "image": "somens/someimage:v123",
-      "ports": [
-        {
-          "containerPort": 5050,
-          "protocol": "UDP",
-          "name": "port1"
-        },
-        {
-          "containerPort": 8888,
-          "protocol": "TCP",
-          "name": "port2"
-        }
-      ],
-      "limits": {
-        "memory": "128Mi",
-        "cpu": "1"
-      },
-      "shutdownTimeout": 180,
-      "autoscaling": {
-        "min": 100,
-        "up": {
-          "delta": 10,
-          "trigger": {
-            "usage": 70,
-            "time": 600
-          },
-          "cooldown": 300
-        },
-        "down": {
-          "delta": 2,
-          "trigger": {
-            "usage": 50,
-            "time": 900
-          },
-          "cooldown": 300
-        }
-      },
-      "env": [
-        {
-          "name": "EXAMPLE_ENV_VAR",
-          "value": "examplevalue"
-        },
+      "image": "new-image",
+    }
+    ```
+
+  * Success Response
+    * Code: `200`
+    * Content:
+
+      ```
         {
-          "name": "ANOTHER_ENV_VAR",
-          "value": "anothervalue"
+          "success": true
         }
-      ],
-      "cmd": [
-        "./room-binary",
-        "-serverType",
-        "6a8e136b-2dc1-417e-bbe8-0f0a2d2df431"
-      ]
+      ```
+
+  * Error Response
+
+    It will return an error if scheduler to update is not found on DB
+
+    * Code: `404`
+    * Content:
+
+    ```
+      {
+        "code":        [string]<error-code>,
+        "error":       [string]<error-message>,
+        "description": [string]<error-description>,
+        "success":     [bool]false
+      }
+    ```
+
+    It will return an error if image was not sent on body 
+
+    * Code: `422`
+    * Content:
+
+    ```
+      {
+        "code":        [string]<error-code>,
+        "error":       [string]<error-message>,
+        "description": [string]<error-description>,
+        "success":     [bool]false
+      }
+    ```
+
+    It will return an error if some other error occurred.
+
+    * Code: `500`
+    * Content:
+
+    ```
+      {
+        "code":        [string]<error-code>,
+        "error":       [string]<error-message>,
+        "description": [string]<error-description>,
+        "success":     [bool]false
+      }
+    ```
+
+  ### Update Min
+
+  `PUT /scheduler/:schedulerName/min`
+
+  This route updates a scheduler's minimum number of GRUs. If scheduler already has this min, nothing is done.
+
+  * Request
+
+    ```
+    {
+      "min": [int],
     }
     ```
 
@@ -651,6 +666,20 @@ All API responses include a `X-Maestro-Version` header with the current Maestro
       }
     ```
 
+    It will return an error if min was not sent on body 
+
+    * Code: `422`
+    * Content:
+
+    ```
+      {
+        "code":        [string]<error-code>,
+        "error":       [string]<error-message>,
+        "description": [string]<error-description>,
+        "success":     [bool]false
+      }
+    ```
+
     It will return an error if some other error occurred.
 
     * Code: `500`