dan/covid
1
0
Fork 0
mirror of https://github.com/danbulant/covid synced 2026-07-05 11:11:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Docs for country and global endpoints

Browse source
This commit is contained in:
Daniel Bulant 2020-03-11 12:50:09 +01:00
parent ef10c5f0b4
commit 0caa052ab3
2 changed files with 11 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/ENDPOINTS.md
View file

@ -2,12 +2,12 @@
## country ## country
`/country/:country` `/country/:country` -> `country` || `e_country_not_found`
Shows information about given country. Shows information about given country.
## global ## global
`/global` `/global` -> `country_global`
Shows global informations. Shows global informations.

9
docs/TYPES.md
View file

@ -1,4 +1,13 @@
# Types # Types
## Normal types
* `nothing_to_show` - This page has nothing to show you as of now * `nothing_to_show` - This page has nothing to show you as of now
* `done` - Operation succeeded, without any output * `done` - Operation succeeded, without any output
* `country` - Information about some country
* `country_global` - Global information, in format of `country`
## Error types
* `e_country_not_found` - Given country couldn't be found
* `e_internal` - Internal server error