From 0caa052ab38aa89075d2dddccccece196c931207 Mon Sep 17 00:00:00 2001 From: Daniel Bulant Date: Wed, 11 Mar 2020 12:50:09 +0100 Subject: [PATCH] Docs for country and global endpoints --- docs/ENDPOINTS.md | 4 ++-- docs/TYPES.md | 9 +++++++++ 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/ENDPOINTS.md b/docs/ENDPOINTS.md index 2dc1c50..1ef233e 100644 --- a/docs/ENDPOINTS.md +++ b/docs/ENDPOINTS.md @@ -2,12 +2,12 @@ ## country -`/country/:country` +`/country/:country` -> `country` || `e_country_not_found` Shows information about given country. ## global -`/global` +`/global` -> `country_global` Shows global informations. diff --git a/docs/TYPES.md b/docs/TYPES.md index e9b06b2..23d379f 100644 --- a/docs/TYPES.md +++ b/docs/TYPES.md @@ -1,4 +1,13 @@ # Types +## Normal types + * `nothing_to_show` - This page has nothing to show you as of now * `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