From 6caf2f9eedaed9b9e98934e7fef756ca85345f4e Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Sat, 26 Oct 2024 20:53:20 +0000 Subject: [PATCH] Update API documentation --- api.md | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/api.md b/api.md index 1680fb6..df46a6d 100644 --- a/api.md +++ b/api.md @@ -10,7 +10,7 @@ Documentation for various web services hosted under mono.exhq.dev Discord user information lookup service -## get__v1_user_{userId} +## Look up Discord user information > Code samples @@ -151,11 +151,9 @@ func main() { `GET /v1/user/{userId}` -*Look up Discord user information* - Retrieves information about a Discord user using their ID -

Parameters

+

Parameters

|Name|In|Type|Required|Description| |---|---|---|---|---| @@ -204,7 +202,7 @@ Retrieves information about a Discord user using their ID } ``` -

Responses

+

Responses

|Status|Meaning|Description|Schema| |---|---|---|---| @@ -218,7 +216,7 @@ This operation does not require authentication Backend review system for website -## get__getreviews +## Get reviews > Code samples @@ -359,8 +357,6 @@ func main() { `GET /getreviews` -*Get reviews* - Retrieves reviews from the backend review system > Example responses @@ -378,13 +374,13 @@ Retrieves reviews from the backend review system ] ``` -

Responses

+

Responses

|Status|Meaning|Description|Schema| |---|---|---|---| |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Successful response with reviews|Inline| -

Response Schema

+

Response Schema

Status Code **200** @@ -404,7 +400,7 @@ This operation does not require authentication Cached proxy for song.link API -## get__ +## Get cached song.link data > Code samples @@ -548,11 +544,9 @@ func main() { `GET /` -*Get cached song.link data* - Cached proxy for song.link API responses with CORS support -

Parameters

+ |Name|In|Type|Required|Description| |---|---|---|---|---| @@ -614,7 +608,7 @@ Cached proxy for song.link API responses with CORS support } ``` -

Responses

+ |Status|Meaning|Description|Schema| |---|---|---|---|