From eaf6ac44e7d38ff6cc71ca72bdaceed59b86c550 Mon Sep 17 00:00:00 2001
From: HampusM <hampus@hampusmat.com>
Date: Wed, 4 Aug 2021 16:11:10 +0200
Subject: Added API documentation & updated the Typedoc theme dependency

---
 documentation/API/v1/v1.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 documentation/API/v1/v1.md

(limited to 'documentation/API/v1/v1.md')

diff --git a/documentation/API/v1/v1.md b/documentation/API/v1/v1.md
new file mode 100644
index 0000000..327d7f2
--- /dev/null
+++ b/documentation/API/v1/v1.md
@@ -0,0 +1,22 @@
+## About
+The first edition of the Githermit API.
+
+All of following endpoints should be prefixed with `/api/v1`.
+
+<br>
+
+## /info
+**Method:** GET
+
+**Description:**<br>
+Retrieves information about the Githermit instance.
+
+**Parameters:**<br>
+None
+
+**Response:**<br>
+
+| Code    | Description          | Schema                                |
+|---------|----------------------|---------------------------------------|
+| 200     | Instance information | [Info](/docs/modules/api.html#Info)   |
+| 400-599 | An error             | [Error](/docs/modules/api.html#Error) |
\ No newline at end of file
-- 
cgit v1.2.3-18-g5258