sbrl-github/Air-Quality-Web
1
0
Fork 0
mirror of https://github.com/ConnectedHumber/Air-Quality-Web synced 2024-11-22 06:23:01 +00:00
Code Issues Releases Wiki Activity

API Docs: Clarify that "now" as a special keyword is allowed

Browse source
This commit is contained in:
Starbeamrainbowlabs 2019-06-13 21:06:30 +01:00
parent ee080974f4
commit 34c0f11f71
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/05-API-Docs.md
View file

@ -103,8 +103,8 @@ Parameter | Type | Meaning
--------------------|-----------|--------------------- --------------------|-----------|---------------------
`device-id` | int | The id of the device to get data for. `device-id` | int | The id of the device to get data for.
`reading-type` | string | The type of reading to obtain data for. `reading-type` | string | The type of reading to obtain data for.
`start` | datetime | The starting datetime. `start` | datetime | The starting datetime, or the special keyword "now".
`end` | datetime | The ending datetime. `end` | datetime | The ending datetime, or the special keyword "now".
`average-seconds` | int | Optional. If specified, readings will be grouped into lumps of this many seconds and averaged. For example a value of 3600 (1 hour) will return 1 data point per hour, with the value of each point an average of all the readings for that hour. `average-seconds` | int | Optional. If specified, readings will be grouped into lumps of this many seconds and averaged. For example a value of 3600 (1 hour) will return 1 data point per hour, with the value of each point an average of all the readings for that hour.
`format` | string | Optional. Specifies the format that the response will be returned in. Valid values: `json`, `csv`. Default: `json`. `format` | string | Optional. Specifies the format that the response will be returned in. Valid values: `json`, `csv`. Default: `json`.
@ -112,9 +112,12 @@ Parameter | Type | Meaning
https://example.com/path/to/api.php?action=device-data&device-id=18&reading-type=PM25&start=2019-01-19T18:14:59.992Z&end=2019-01-20T18:14:59.992Z https://example.com/path/to/api.php?action=device-data&device-id=18&reading-type=PM25&start=2019-01-19T18:14:59.992Z&end=2019-01-20T18:14:59.992Z
https://example.com/path/to/api.php?action=device-data&device-id=18&reading-type=PM25&start=2019-01-19T18:14:59.992Z&end=2019-01-20T18:14:59.992Z&average-seconds=3600 https://example.com/path/to/api.php?action=device-data&device-id=18&reading-type=PM25&start=2019-01-19T18:14:59.992Z&end=2019-01-20T18:14:59.992Z&average-seconds=3600
https://example.com/path/to/api.php?action=device-data&device-id=18&reading-type=PM25&start=2019-01-19T18:14:59.992Z&end=now&average-seconds=3600&format=csv https://example.com/path/to/api.php?action=device-data&device-id=18&reading-type=PM25&start=2019-01-19T18:14:59.992Z&end=now&average-seconds=3600&format=csv
https://example.com/path/to/api.php?action=device-data&device-id=18&reading-type=PM25&start=2019-06-13T00:00:00&end=now&format=csv
``` ```
## changelog ## changelog
> Gets the changelog as a fragment of HTML. > Gets the changelog as a fragment of HTML.