From 8b55fe8420888052b2edad4e522fd12bc77de9a0 Mon Sep 17 00:00:00 2001
From: Lukas Metzger <loewexy@users.noreply.github.com>
Date: Sun, 29 Apr 2018 16:58:30 +0200
Subject: [PATCH] Created API Upgrade (markdown)

---
 API-Upgrade.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 API-Upgrade.md

diff --git a/API-Upgrade.md b/API-Upgrade.md
new file mode 100644
index 0000000..74e2822
--- /dev/null
+++ b/API-Upgrade.md
@@ -0,0 +1,38 @@
+# Setup
+
+This API is only used for the upgrading the server.
+
+## Check if update is available
+`GET /update`
+
+### Response
+| code | result |
+| --- | --- |
+| 200 | Everything was successful|
+
+```json
+{
+  "updateRequired": true,
+  "currentVersion": 4,
+  "targetVersion": 6
+}
+```
+
+The version numbers represent the internal db version used. They are only present if `updateRequired` is `true`.
+
+## Update server
+`POST /update`
+
+### Response
+| code | result |
+| --- | --- |
+| 204 | Everything was successful |
+| 500 | An error occured while upgrading |
+
+If an error occurred a message is returned.
+
+```json
+{
+  "error": "Error message!"
+}
+```
\ No newline at end of file