From 9f7c9103ae6ca7c3127b44a966300a8ea62b3454 Mon Sep 17 00:00:00 2001 From: HampusM Date: Wed, 4 Aug 2021 16:18:44 +0200 Subject: Renamed the documentation folder to docs_src --- docs_src/API/v1/v1.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs_src/API/v1/v1.md (limited to 'docs_src/API/v1/v1.md') diff --git a/docs_src/API/v1/v1.md b/docs_src/API/v1/v1.md new file mode 100644 index 0000000..327d7f2 --- /dev/null +++ b/docs_src/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`. + +
+ +## /info +**Method:** GET + +**Description:**
+Retrieves information about the Githermit instance. + +**Parameters:**
+None + +**Response:**
+ +| 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