Add API Reference for Watcher

This patch set adds API Reference along with some fixes to documentation. It partially fixes bug #1757423. Change-Id: I107b4fd5daf40aad63fc13864debbbbc82a9826c
2018-04-03 19:55:57 +03:00
parent bbd0ae5b16
commit 533c0a4114
57 changed files with 3033 additions and 30 deletions
--- a/api-ref/source/samples/strategy-show-response.json
+++ b/api-ref/source/samples/strategy-show-response.json
@@ -0,0 +1,33 @@
+{
+    "goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810",
+    "name": "dummy",
+    "links": [
+        {
+            "rel": "self",
+            "href": "http://controller:9322/v1/strategies/e311727b-b9b3-43ef-a5f7-8bd7ea80df25"
+        },
+        {
+            "rel": "bookmark",
+            "href": "http://controller:9322/strategies/e311727b-b9b3-43ef-a5f7-8bd7ea80df25"
+        }
+    ],
+    "parameters_spec": {
+        "properties": {
+            "para2": {
+                "default": "hello",
+                "type": "string",
+                "description": "string parameter example"
+            },
+            "para1": {
+                "maximum": 10.2,
+                "type": "number",
+                "minimum": 1.0,
+                "description": "number parameter example",
+                "default": 3.2
+            }
+        }
+    },
+    "uuid": "e311727b-b9b3-43ef-a5f7-8bd7ea80df25",
+    "goal_name": "dummy",
+    "display_name": "Dummy strategy"
+}