From 06f968bceb3a7c7e46e02037cad75b869f524909 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Gro=C3=9F?= Date: Mon, 17 Apr 2023 18:18:49 +0200 Subject: [PATCH] Docs: Fix link paths --- Docs/API/README.md | 4 ++-- Docs/api/README.md | 25 +++++++++++++++++++++++++ Docs/{API => api}/characters.md | 0 3 files changed, 27 insertions(+), 2 deletions(-) create mode 100644 Docs/api/README.md rename Docs/{API => api}/characters.md (100%) diff --git a/Docs/API/README.md b/Docs/API/README.md index de769a8..2a8bc4d 100644 --- a/Docs/API/README.md +++ b/Docs/API/README.md @@ -15,8 +15,8 @@ The endpoints provided by this API are: - /most-recent-drop - Returns the most recent drop (Requires API Key) ## For characters: -- [`/characters`](api/characters.md#get-characters) -- [`/characters/:character_id`](api/characters.md#get-characterscharacter_id) +- [`/characters`](characters.md#get-characters) +- [`/characters/:character_id`](characters.md#get-characterscharacter_id) ## For groups: _TODO_ diff --git a/Docs/api/README.md b/Docs/api/README.md new file mode 100644 index 0000000..2a8bc4d --- /dev/null +++ b/Docs/api/README.md @@ -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_ \ No newline at end of file diff --git a/Docs/API/characters.md b/Docs/api/characters.md similarity index 100% rename from Docs/API/characters.md rename to Docs/api/characters.md