add: api references

This commit is contained in:
J-onasJones 2023-09-18 20:41:32 +02:00
parent c6872f3be6
commit a3c182a814
4 changed files with 49 additions and 1 deletions

View file

@ -1,4 +1,5 @@
# References
---
Find the publically available API calls in the sublinks.
The following are the cureently publically available API calls:

View file

@ -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/
```

View file

@ -0,0 +1,15 @@
# Ping
---
Test the API connection.
### Call
```js
/v1/ping
```
### Response
*text/plain*
```
pong
```

View file

@ -0,0 +1,16 @@
# Version
---
Get the API version
### Call
```js
/v1/version
```
### Response
*application/json*
```json
["0.0.1+alpha-build01"]
```