sbrl-github
/
Air-Quality-Web
mirror of https://github.com/ConnectedHumber/Air-Quality-Web
1
0
Fork 0
Code Issues Releases Wiki Activity

HTTP API: Add quick reference for actions to the top

pull/35/head
Starbeamrainbowlabs 2019-06-03 23:25:24 +01:00
parent 78fbd03d64
commit ea3a69373a
Signed by: sbrl
GPG Key ID: 1BE5172E637709C2
2 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Changelog.md
View File

@ -1,5 +1,8 @@
# Changelog
# v0.9.2 - 3rd June 2019
- [API] Updated the [API documentation](https://aq.connectedhumber.org/__nightdocs/05-API-Docs.html) with a quick reference of the available actions at the top.
# v0.9.1 - 16th May 2019
- [API] Changed the default action. It now displays a helpful message by default instead of routing directly to `fetch-data`.

13
docs/05-API-Docs.md
View File

@ -3,6 +3,19 @@ The server-side API is accessed through `api.php`, and supports a number of GET
The most important of these is the `action` parameter, Which determines what the API will do. The following values are supported:
Action | Meaning
------------------------|----------------------------
`version` | Gets the version of _Air Quality Web_ that's currently running.
`fetch-data` | Fetches air quality data from the system for a specific data type at a specific date and time.
`list-devices` | Fetches a list of devices currently in the system.
`device-info` | Gets (lots of) information about a single device.
`list-reading-types` | Lists the different types of readings that can be specified.
`device-data-bounds` | Gets the start and end DateTime bounds for the data recorded for a specific device.
`device-data` | Gets data by device given a start and end time.
`changelog` | Gets the changelog as a fragment of HTML.
These are explained in detail below:
## version
> Returns the version of the application.