diff options
| author | HampusM <hampus@hampusmat.com> | 2021-08-04 16:11:10 +0200 |
|---|---|---|
| committer | HampusM <hampus@hampusmat.com> | 2021-08-04 16:11:10 +0200 |
| commit | eaf6ac44e7d38ff6cc71ca72bdaceed59b86c550 (patch) | |
| tree | d178c67e77fc3114e7858f623ca0ead2c92dde25 /documentation/API/v1/v1.md | |
| parent | 78c806159a2ab795e96d7c06350e4012485f255a (diff) | |
Added API documentation & updated the Typedoc theme dependency
Diffstat (limited to 'documentation/API/v1/v1.md')
| -rw-r--r-- | documentation/API/v1/v1.md | 22 |
1 files changed, 22 insertions, 0 deletions
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 |