Api documentation on the new format #102

packages/unleash-api/notes/api.md

@@ -0,0 +1,79 @@
+# API
+
+## Fetch features:
+
+This endpoint is the one all clients should use to fetch all available feature-toggles 
+from the unleash-server. The response returns all active-toggles and the active 
+strategy configuration. A feature-toggle will have at-least one strategy. A 
+strategy will have a 'name' and 'parameters'.  
+
+GET: http://unleash.host.com/features
+
+```json
+{
+  "features": [
+    {
+      "name": "Feature.A",
+      "description": "lorem ipsum",
+      "enabled": false,
+      "strategies": [
+        {
+          "name": "default",
+          "parameters": {}
+        }
+      ],
+      "strategy": "default",
+      "parameters": {}
+    },
+    {
+      "name": "Feature.B",
+      "description": "lorem ipsum",
+      "enabled": true,
+      "strategies": [
+        {
+          "name": "ActiveForUserWithId",
+          "parameters": {
+            "userIdList": "123,221,998"
+          }
+        },
+        {
+          "name": "GradualRolloutRandom",
+          "parameters": {
+            "percentage": "10"
+          }
+        }
+      ],
+      "strategy": "ActiveForUserWithId",
+      "parameters": {
+        "userIdList": "123,221,998"
+      }
+    }
+  ]
+}
+```
+**Important:**
+
+_strategy_ and _paramters_ are depercated fields and will go away in the next version. They are kept for backward compability with older unleash-clients. 
+
+
+## Fetch a feature
+
+GET: http://unleash.host.com/features/[featureName]
+
+```json
+{
+  "name": "Feature.A",
+  "description": "lorem ipsum..",
+  "enabled": false,
+  "strategies": [
+    {
+      "name": "default",
+      "parameters": {}
+    }
+  ],
+  "strategy": "default",
+  "parameters": {}
+}
+```
+
+