Adding initial API docs

2014-12-31 15:58:37 +00:00
parent 7d8bf7fb3a
commit 5bb8b78074
6 changed files with 245 additions and 3 deletions
@@ -0,0 +1,44 @@
+# API Metrics
+
+**_Work In Progress_**
+
+## `/metrics`
+
+Interact with metrics
+
+Example URL: `http://status.cachethq.io/api/metrics`
+
+* `GET`: returns a list of the current metrics
+  - success: 200:
+  
+    ~~~json
+    To be confirmed
+    ~~~
+
+* `POST`: Create an metric
+  - payload
+
+    ~~~json
+    To be confirmed
+    ~~~
+
+
+
+## `/metrics/:id`
+
+Show a single metric
+
+Example URL: `http://status.cachethq.io/api/metrics/1`
+
+* `GET`: Return a single metric
+  - success: 200:
+
+    ~~~json
+    To be confirmed
+    ~~~
+
+## `/metrics/points`
+
+To be confirmed
+
+