Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
fa34e56
Description on top of documentation added
carmelag Mar 22, 2020
990e1d0
Some changes to the intro part
carmelag Mar 22, 2020
7ed908e
Description for API Endpoints modified
carmelag Mar 22, 2020
fcd4750
Latest and location endpoints work
carmelag Mar 23, 2020
621cca4
path parameter added for location
carmelag Mar 23, 2020
055ad84
Small fix
carmelag Mar 23, 2020
98ae697
Table was fixed
carmelag Mar 23, 2020
7574abe
Minor fixes
carmelag Mar 23, 2020
a2d4a3c
Table for params fixed
carmelag Mar 23, 2020
ed286ed
add sources endpoint and improve datasource middleware
Mar 23, 2020
596f382
changes documented in README
Mar 23, 2020
06c39eb
improve date-parsing in cbs location service
Mar 23, 2020
cc28b51
improve logging
Mar 23, 2020
594b56f
fix tests with CBS switching from - to / with dates
Mar 23, 2020
56c5be6
Merge pull request #149 from ExpDev07/sources-endpoint
ExpDev07 Mar 23, 2020
7797aa8
Samples per parameters added
carmelag Mar 23, 2020
5ab9cdc
Making the URL a real link
carmelag Mar 23, 2020
213ef1f
code inline removed from URL
carmelag Mar 23, 2020
86f3c7c
curl command added
carmelag Mar 23, 2020
9f4ab08
some other small fixes
carmelag Mar 23, 2020
e36fe16
Table headings bold now
carmelag Mar 23, 2020
8bd9cb5
Conflics solved and sources endpoint added
carmelag Mar 23, 2020
936df66
Minor fixes applied
carmelag Mar 23, 2020
067b5d3
Multiline in table cell fixed
carmelag Mar 23, 2020
b279cce
Recovered response item replacing deaths
carmelag Mar 23, 2020
a2473c1
Multiline in table cell fixed for response definitions table
carmelag Mar 23, 2020
ca7be61
Merge pull request #150 from carmelag/api-docs-changes
ExpDev07 Mar 23, 2020
30eba71
docs: update README.md [skip ci]
allcontributors[bot] Mar 23, 2020
a513796
docs: update .all-contributorsrc [skip ci]
allcontributors[bot] Mar 23, 2020
d594345
Merge pull request #151 from ExpDev07/all-contributors/add-carmelag
ExpDev07 Mar 23, 2020
c8d15b6
Update README.md
ExpDev07 Mar 23, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update README.md
  • Loading branch information
ExpDev07 authored Mar 23, 2020
commit c8d15b6e1d90be0cfb687e18dcf914d4977d90cb
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,11 @@ Getting latest amount of total confirmed cases, deaths, and recovered.
GET /v2/latest
```

__Query String Parameters__
| __Query string parameter__ | __Description__ | __Type__ |
| -------------------------- | -------------------------------------------------------------------------------- | -------- |
| source | The data-source where data will be retrieved from *(jhu/csbs)*. Default is *jhu* | String |

__Sample response__
```json
{
Expand All @@ -80,12 +85,6 @@ __Sample response__
}
```

__Query String Parameters__
| __Query string parameter__ | __Description__ | __Type__ |
| -------------------------- | -------------------------------------------------------------------------------- | -------- |
| source | The data-source where data will be retrieved from *(jhu/csbs)*. Default is *jhu* | String |


### Locations Endpoint

Getting latest amount of confirmed cases, deaths, and recovered per location.
Expand All @@ -100,11 +99,16 @@ __Path Parameters__
| ------------------ | --------------------- | ------------------------------------------------------------------------- | -------- |
| id | OPTIONAL | The unique location id for which you want to call the Locations Endpoint. | Integer |

__Query String Parameters__
| __Query string parameter__ | __Description__ | __Type__ |
| -------------------------- | -------------------------------------------------------------------------------- | -------- |
| source | The data-source where data will be retrieved from *(jhu/csbs)*. Default is *jhu* | String |

#### Example Request
```http
GET /v2/locations/39
```

__Sample response__
```json
{
Expand Down Expand Up @@ -136,6 +140,13 @@ __Sample response__
GET /v2/locations
```

__Query String Parameters__
| __Query string parameter__ | __Description__ | __Type__ |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------- |
| source | The data-source where data will be retrieved from.<br>__Value__ can be: *jhu/csbs*. __Default__ is *jhu* | String |
| country_code | The ISO ([alpha-2 country_code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)) to the Country/Province for which you're calling the Endpoint | String |
| timelines | To set the visibility of timelines (*daily tracking*).<br>__Value__ can be: *0/1*. __Default__ is *0* (timelines are not visible) | Integer |

__Sample response__
```json
{
Expand Down Expand Up @@ -181,14 +192,6 @@ __Sample response__
}
```

__Query String Parameters__
| __Query string parameter__ | __Description__ | __Type__ |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------- |
| source | The data-source where data will be retrieved from.<br>__Value__ can be: *jhu/csbs*. __Default__ is *jhu* | String |
| country_code | The ISO ([alpha-2 country_code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)) to the Country/Province for which you're calling the Endpoint | String |
| timelines | To set the visibility of timelines (*daily tracking*).<br>__Value__ can be: *0/1*. __Default__ is *0* (timelines are not visible) | Integer |


__Response definitions__
| __Response Item__ | __Description__ | __Type__ |
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------- |
Expand Down