From a3c182a81421b15e944646c2eaff829ee54897bf Mon Sep 17 00:00:00 2001
From: J-onasJones <me@jonasjones.dev>
Date: Mon, 18 Sep 2023 20:41:32 +0200
Subject: [PATCH] add: api references

---
 src/routes/Api/References/+page.md         |  3 ++-
 src/routes/Api/References/help/+page.md    | 16 ++++++++++++++++
 src/routes/Api/References/ping/+page.md    | 15 +++++++++++++++
 src/routes/Api/References/version/+page.md | 16 ++++++++++++++++
 4 files changed, 49 insertions(+), 1 deletion(-)
 create mode 100644 src/routes/Api/References/help/+page.md
 create mode 100644 src/routes/Api/References/ping/+page.md
 create mode 100644 src/routes/Api/References/version/+page.md

diff --git a/src/routes/Api/References/+page.md b/src/routes/Api/References/+page.md
index 1d45f05..92cdf0a 100644
--- a/src/routes/Api/References/+page.md
+++ b/src/routes/Api/References/+page.md
@@ -1,4 +1,5 @@
 # References
 ---
 
-Find the publically available API calls in the sublinks.
\ No newline at end of file
+The following are the cureently publically available API calls:
+
diff --git a/src/routes/Api/References/help/+page.md b/src/routes/Api/References/help/+page.md
new file mode 100644
index 0000000..692356f
--- /dev/null
+++ b/src/routes/Api/References/help/+page.md
@@ -0,0 +1,16 @@
+# Help
+---
+Get the link to the documentation.
+
+### Call
+
+```js
+/v1/help
+```
+
+### Response
+*text/plain*
+```
+Please refer to the wiki at https://wiki.jonasjones.dev/Api/
+
+```
diff --git a/src/routes/Api/References/ping/+page.md b/src/routes/Api/References/ping/+page.md
new file mode 100644
index 0000000..a643289
--- /dev/null
+++ b/src/routes/Api/References/ping/+page.md
@@ -0,0 +1,15 @@
+# Ping
+---
+Test the API connection.
+
+### Call
+
+```js
+/v1/ping
+```
+
+### Response
+*text/plain*
+```
+pong
+```
diff --git a/src/routes/Api/References/version/+page.md b/src/routes/Api/References/version/+page.md
new file mode 100644
index 0000000..781bae4
--- /dev/null
+++ b/src/routes/Api/References/version/+page.md
@@ -0,0 +1,16 @@
+# Version
+---
+Get the API version
+
+### Call
+
+```js
+/v1/version
+```
+
+### Response
+*application/json*
+```json
+["0.0.1+alpha-build01"]
+
+```