Docs: Fix link paths
This commit is contained in:
25
Docs/api/README.md
Normal file
25
Docs/api/README.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# API Documentation
|
||||
|
||||
## Introduction
|
||||
|
||||
This API provides CRU (Create, Read, Update) operations for various models.
|
||||
|
||||
The API requires an API key for some operations.
|
||||
|
||||
The endpoints provided by this API are:
|
||||
|
||||
## Generic:
|
||||
- / - List all routes (JSON Response)
|
||||
- /ping - Returns pong
|
||||
- /stats - Simple stats about the bot (Record counts and uptime)
|
||||
- /most-recent-drop - Returns the most recent drop (Requires API Key)
|
||||
|
||||
## For characters:
|
||||
- [`/characters`](characters.md#get-characters)
|
||||
- [`/characters/:character_id`](characters.md#get-characterscharacter_id)
|
||||
|
||||
## For groups:
|
||||
_TODO_
|
||||
|
||||
## For Badges:
|
||||
_TODO_
|
||||
Reference in New Issue
Block a user