forked from exhq/hosted
Update API documentation
parent
8724784d26
commit
6caf2f9eed
1 changed files with 9 additions and 15 deletions
24
api.md
24
api.md
|
@ -10,7 +10,7 @@ Documentation for various web services hosted under mono.exhq.dev
|
||||||
|
|
||||||
Discord user information lookup service
|
Discord user information lookup service
|
||||||
|
|
||||||
## get__v1_user_{userId}
|
## Look up Discord user information
|
||||||
|
|
||||||
> Code samples
|
> Code samples
|
||||||
|
|
||||||
|
@ -151,11 +151,9 @@ func main() {
|
||||||
|
|
||||||
`GET /v1/user/{userId}`
|
`GET /v1/user/{userId}`
|
||||||
|
|
||||||
*Look up Discord user information*
|
|
||||||
|
|
||||||
Retrieves information about a Discord user using their ID
|
Retrieves information about a Discord user using their ID
|
||||||
|
|
||||||
<h3 id="get__v1_user_{userid}-parameters">Parameters</h3>
|
<h3 id="look-up-discord-user-information-parameters">Parameters</h3>
|
||||||
|
|
||||||
|Name|In|Type|Required|Description|
|
|Name|In|Type|Required|Description|
|
||||||
|---|---|---|---|---|
|
|---|---|---|---|---|
|
||||||
|
@ -204,7 +202,7 @@ Retrieves information about a Discord user using their ID
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
<h3 id="get__v1_user_{userid}-responses">Responses</h3>
|
<h3 id="look-up-discord-user-information-responses">Responses</h3>
|
||||||
|
|
||||||
|Status|Meaning|Description|Schema|
|
|Status|Meaning|Description|Schema|
|
||||||
|---|---|---|---|
|
|---|---|---|---|
|
||||||
|
@ -218,7 +216,7 @@ This operation does not require authentication
|
||||||
|
|
||||||
Backend review system for website
|
Backend review system for website
|
||||||
|
|
||||||
## get__getreviews
|
## Get reviews
|
||||||
|
|
||||||
> Code samples
|
> Code samples
|
||||||
|
|
||||||
|
@ -359,8 +357,6 @@ func main() {
|
||||||
|
|
||||||
`GET /getreviews`
|
`GET /getreviews`
|
||||||
|
|
||||||
*Get reviews*
|
|
||||||
|
|
||||||
Retrieves reviews from the backend review system
|
Retrieves reviews from the backend review system
|
||||||
|
|
||||||
> Example responses
|
> Example responses
|
||||||
|
@ -378,13 +374,13 @@ Retrieves reviews from the backend review system
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
<h3 id="get__getreviews-responses">Responses</h3>
|
<h3 id="get-reviews-responses">Responses</h3>
|
||||||
|
|
||||||
|Status|Meaning|Description|Schema|
|
|Status|Meaning|Description|Schema|
|
||||||
|---|---|---|---|
|
|---|---|---|---|
|
||||||
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Successful response with reviews|Inline|
|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Successful response with reviews|Inline|
|
||||||
|
|
||||||
<h3 id="get__getreviews-responseschema">Response Schema</h3>
|
<h3 id="get-reviews-responseschema">Response Schema</h3>
|
||||||
|
|
||||||
Status Code **200**
|
Status Code **200**
|
||||||
|
|
||||||
|
@ -404,7 +400,7 @@ This operation does not require authentication
|
||||||
|
|
||||||
Cached proxy for song.link API
|
Cached proxy for song.link API
|
||||||
|
|
||||||
## get__
|
## Get cached song.link data
|
||||||
|
|
||||||
> Code samples
|
> Code samples
|
||||||
|
|
||||||
|
@ -548,11 +544,9 @@ func main() {
|
||||||
|
|
||||||
`GET /`
|
`GET /`
|
||||||
|
|
||||||
*Get cached song.link data*
|
|
||||||
|
|
||||||
Cached proxy for song.link API responses with CORS support
|
Cached proxy for song.link API responses with CORS support
|
||||||
|
|
||||||
<h3 id="get__-parameters">Parameters</h3>
|
<h3 id="get-cached-song.link-data-parameters">Parameters</h3>
|
||||||
|
|
||||||
|Name|In|Type|Required|Description|
|
|Name|In|Type|Required|Description|
|
||||||
|---|---|---|---|---|
|
|---|---|---|---|---|
|
||||||
|
@ -614,7 +608,7 @@ Cached proxy for song.link API responses with CORS support
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
<h3 id="get__-responses">Responses</h3>
|
<h3 id="get-cached-song.link-data-responses">Responses</h3>
|
||||||
|
|
||||||
|Status|Meaning|Description|Schema|
|
|Status|Meaning|Description|Schema|
|
||||||
|---|---|---|---|
|
|---|---|---|---|
|
||||||
|
|
Loading…
Reference in a new issue