Skip to content

Commit e36fe16

Browse files
carmelagcarmelag
committed
Table headings bold now
1 parent 9f4ab08 commit e36fe16

File tree

1 file changed

+30
-29
lines changed

1 file changed

+30
-29
lines changed

‎README.md‎

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ __Sample response__
6363
```
6464

6565
__Query String Parameters__
66-
| Query string parameter | Description | Type |
67-
| ---------------------- | -------------------------------------------------------------------------------- | ------ |
68-
| source | The data-source where data will be retrieved from *(jhu/csbs)*. Default is *jhu* | String |
66+
| __Query string parameter__ | __Description__ | __Type__ |
67+
| -------------------------- | -------------------------------------------------------------------------------- | -------- |
68+
| source | The data-source where data will be retrieved from *(jhu/csbs)*. Default is *jhu* | String |
6969

7070

7171
### Locations Endpoint
@@ -78,9 +78,9 @@ GET /v2/locations/:id
7878
```
7979

8080
__Path Parameters__
81-
| Path parameter | Required/Optional | Description | Type |
82-
| -------------- | ----------------- | ------------------------------------------------------------------------- | ------- |
83-
| id | OPTIONAL | The unique location id for which you want to call the Locations Endpoint. | Integer |
81+
| __Path parameter__ | __Required/Optional__ | __Description__ | __Type__ |
82+
| ------------------ | --------------------- | ------------------------------------------------------------------------- | -------- |
83+
| id | OPTIONAL | The unique location id for which you want to call the Locations Endpoint. | Integer |
8484

8585

8686
#### Example Request
@@ -164,32 +164,32 @@ __Sample response__
164164
```
165165

166166
__Query String Parameters__
167-
| Query string parameter | Description | Type |
168-
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------- |
169-
| source | The data-source where data will be retrieved from. __Value__ can be: __jhu/csbs__. __Default__ is __jhu__ | String |
170-
| 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 |
171-
| timelines | To set the visibility of timelines (*daily tracking*).__Value__ can be: __0/1__. __Default__ is __0__ | Integer |
167+
| __Query string parameter__ | __Description__ | __Type__ |
168+
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------- |
169+
| source | The data-source where data will be retrieved from. __Value__ can be: __jhu/csbs__. __Default__ is __jhu__ | String |
170+
| 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 |
171+
| timelines | To set the visibility of timelines (*daily tracking*).__Value__ can be: __0/1__. __Default__ is __0__ | Integer |
172172

173173

174174
__Response definitions__
175-
| Response Item | Description | Type |
176-
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
177-
| {latest} | The total amount of confirmed cases, deaths and recoveries for all the locations | Object |
178-
| {latest}/confirmed | The up-to-date total number of confirmed cases for all the locations within the data-source | Integer |
179-
| {latest}/deaths | The up-to-date total amount of deaths for all the locations within the data-source | Integer |
180-
| {latest}/recovered | The up-to-date total amount of recovered for all the locations within the data-source | Integer |
181-
| {locations} | The collection of locations contained within the data-source | Object |
182-
| {location} | Information that identifies a location | Object |
183-
| {latest} | The amount of confirmed cases, deaths and recovered related to the specific location | Object |
184-
| {locations}/{location}/{latest}/confirmed | The up-to-date number of confirmed cases related to the specific location | Integer |
185-
| {locations}/{location}/{latest}/deaths | The up-to-date number of deaths related to the specific location | Integer |
186-
| {locations}/{location}/{latest}/deaths | The up-to-date number of recovered related to the specific location | Integer |
187-
| {locations}/{location}/id | The location id. This id number is assigned to the location by the data-source. | Integer |
188-
| {locations}/{location}/country | The Country name | String |
189-
| {locations}/{location}/country_code | The ISO ([alpha-2 country_code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)) Country code for the location. | String |
190-
| {locations}/{location}/province | The province where the location belongs to. (Used only for __csbs data-source__ of US locations. __Empty__ with __jhu data-source__. | String |
191-
| {locations}/{location}/{coordinates}/latitude | The location latitude | Float |
192-
| {locations}/{location}/{coordinates}/longitude | The location longitude | Float |
175+
| __Response Item__ | __Description__ | __Type__ |
176+
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -------- |
177+
| {latest} | The total amount of confirmed cases, deaths and recoveries for all the locations | Object |
178+
| {latest}/confirmed | The up-to-date total number of confirmed cases for all the locations within the data-source | Integer |
179+
| {latest}/deaths | The up-to-date total amount of deaths for all the locations within the data-source | Integer |
180+
| {latest}/recovered | The up-to-date total amount of recovered for all the locations within the data-source | Integer |
181+
| {locations} | The collection of locations contained within the data-source | Object |
182+
| {location} | Information that identifies a location | Object |
183+
| {latest} | The amount of confirmed cases, deaths and recovered related to the specific location | Object |
184+
| {locations}/{location}/{latest}/confirmed | The up-to-date number of confirmed cases related to the specific location | Integer |
185+
| {locations}/{location}/{latest}/deaths | The up-to-date number of deaths related to the specific location | Integer |
186+
| {locations}/{location}/{latest}/deaths | The up-to-date number of recovered related to the specific location | Integer |
187+
| {locations}/{location}/id | The location id. This id number is assigned to the location by the data-source. | Integer |
188+
| {locations}/{location}/country | The Country name | String |
189+
| {locations}/{location}/country_code | The ISO ([alpha-2 country_code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)) Country code for the location. | String |
190+
| {locations}/{location}/province | The province where the location belongs to. (Used only for __csbs data-source__ of US locations. __Empty__ with __jhu data-source__. | String |
191+
| {locations}/{location}/{coordinates}/latitude | The location latitude | Float |
192+
| {locations}/{location}/{coordinates}/longitude | The location longitude | Float |
193193

194194

195195
### Example Requests with parameters
@@ -300,6 +300,7 @@ curl https://coronavirus-tracker-api.herokuapp.com/v2/locations?timelines=1 | js
300300

301301
__NOTE:__ Timelines tracking starts from day 22nd January 2020 and ends to the last available day in the data-source.
302302

303+
303304
## Wrappers
304305

305306
These are the available API wrappers created by the community. They are not necessarily maintained by any of this project's authors or contributors.

0 commit comments

Comments
 (0)