mirror of
https://github.com/danbulant/covid
synced 2026-07-06 11:40:56 +00:00
Prepare for documentation of endpoints
This commit is contained in:
parent
bf735b76fa
commit
d3976a5e55
2 changed files with 5 additions and 0 deletions
1
docs/ENDPOINTS.md
Normal file
1
docs/ENDPOINTS.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Endpoints
|
||||||
|
|
@ -13,3 +13,7 @@ Every response is in JSON and contains at least these fields:
|
||||||
* `code` - HTTP status code
|
* `code` - HTTP status code
|
||||||
* `type` - Type of response, see [types](TYPES.md)
|
* `type` - Type of response, see [types](TYPES.md)
|
||||||
* `data` - Might be missing, depends of `type`.
|
* `data` - Might be missing, depends of `type`.
|
||||||
|
|
||||||
|
## Endpoints
|
||||||
|
|
||||||
|
For list of endpoints, see [ENDPOINTS.md](ENDPOINTS.md)
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue