From 8ea2e57eea24fbb2e5d72b6bcf375dec594d4bb8 Mon Sep 17 00:00:00 2001
From: James Brooks <jbrooksuk@me.com>
Date: Thu, 21 Jun 2018 19:49:33 +0100
Subject: [PATCH] Start work on new API format

---
 docs/api-documentation.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/docs/api-documentation.md b/docs/api-documentation.md
index 856a3332..bad9ff0d 100644
--- a/docs/api-documentation.md
+++ b/docs/api-documentation.md
@@ -1 +1,40 @@
 # API Documentation for Cachet
+
+## `GET /api/v1/ping`
+
+Ping the Cachet instance.
+
+## `GET /api/v1/version`
+
+Get the version of Cachet installed.
+
+## `GET /api/v1/status`
+
+Get the overall system status.
+
+## `GET /api/v1/components`
+
+Get all components.
+
+## `GET /api/v1/components/:id`
+
+Get a single component.
+
+### Params
+
+- `id` the ID of the component
+
+## `POST /api/v1/components`
+
+Create a new component.
+
+### Params
+
+- `name` the name of the component
+- `description` may be left empty
+- `status`
+- `link`
+- `order`
+- `group_id`
+- `enabled`
+- `meta`