mirror of
https://github.com/JonasunderscoreJones/wiki.jonasjones.dev.git
synced 2025-10-22 13:59:19 +02:00
add: api references
This commit is contained in:
parent
c6872f3be6
commit
a3c182a814
4 changed files with 49 additions and 1 deletions
|
@ -1,4 +1,5 @@
|
|||
# References
|
||||
---
|
||||
|
||||
Find the publically available API calls in the sublinks.
|
||||
The following are the cureently publically available API calls:
|
||||
|
||||
|
|
16
src/routes/Api/References/help/+page.md
Normal file
16
src/routes/Api/References/help/+page.md
Normal 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/
|
||||
|
||||
```
|
15
src/routes/Api/References/ping/+page.md
Normal file
15
src/routes/Api/References/ping/+page.md
Normal file
|
@ -0,0 +1,15 @@
|
|||
# Ping
|
||||
---
|
||||
Test the API connection.
|
||||
|
||||
### Call
|
||||
|
||||
```js
|
||||
/v1/ping
|
||||
```
|
||||
|
||||
### Response
|
||||
*text/plain*
|
||||
```
|
||||
pong
|
||||
```
|
16
src/routes/Api/References/version/+page.md
Normal file
16
src/routes/Api/References/version/+page.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
# Version
|
||||
---
|
||||
Get the API version
|
||||
|
||||
### Call
|
||||
|
||||
```js
|
||||
/v1/version
|
||||
```
|
||||
|
||||
### Response
|
||||
*application/json*
|
||||
```json
|
||||
["0.0.1+alpha-build01"]
|
||||
|
||||
```
|
Loading…
Add table
Add a link
Reference in a new issue