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

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

View file

@ -103,8 +103,8 @@ Parameter | Type | Meaning
`device-id` | int | The id of the device to get data for.
`reading-type` | string | The type of reading to obtain data for.
`start` | datetime | The starting datetime.
`end` | datetime | The ending datetime.
`start` | datetime | The starting datetime, or the special keyword "now".
`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.
`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
## changelog
> Gets the changelog as a fragment of HTML.