sbrl-github/Air-Quality-Web
1
0
Fork 0
mirror of https://github.com/ConnectedHumber/Air-Quality-Web synced 2024-12-21 10:25:00 +00:00
Code Issues Releases Wiki Activity

Add links to sections in API docs

Browse source
This commit is contained in:
Starbeamrainbowlabs 2019-06-13 20:57:49 +01:00
parent bb119ee574
commit ef0f1b04ad
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
4 changed files with 15 additions and 12 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 # Changelog
# v0.10.2
- [API Docs] Add links to action sections
# v0.10.1 # v0.10.1
- Remove heatmap blob radius UI setting - Remove heatmap blob radius UI setting
- Add welcome tour, which shows the first time the page is loaded - Add welcome tour, which shows the first time the page is loaded

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

@ -3,16 +3,16 @@ 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: The most important of these is the `action` parameter, Which determines what the API will do. The following values are supported:
Action | Meaning Action | Meaning
------------------------|---------------------------- ----------------------------------------|----------------------------
`version` | Gets the version of _Air Quality Web_ that's currently running. [`version`](#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. [`fetch-data`](#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. [`list-devices`](#list-devices) | Fetches a list of devices currently in the system.
`device-info` | Gets (lots of) information about a single device. [`device-info`](#device-info) | Gets (lots of) information about a single device.
`list-reading-types` | Lists the different types of readings that can be specified. [`list-reading-types`](#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-bounds`](#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. [`device-data`](#device-data) | Gets data by device given a start and end time.
`changelog` | Gets the changelog as a fragment of HTML. [`changelog`](#changelog) | Gets the changelog as a fragment of HTML.
These are explained in detail below: These are explained in detail below:

2
package.json
View file

@ -1,6 +1,6 @@
{ {
"name": "air-quality-mapper", "name": "air-quality-mapper",
"version": "0.10.0", "version": "0.10.2",
"description": "The web interface and JSON api for the ConnectedHumber Air Quality Monitoring Project.", "description": "The web interface and JSON api for the ConnectedHumber Air Quality Monitoring Project.",
"private": true, "private": true,
"main": "index.mjs", "main": "index.mjs",

2
version
View file

@ -1 +1 @@
v0.10 v0.10.2