Add links to sections in API docs

pull/35/head
Starbeamrainbowlabs 4 years ago
parent bb119ee574
commit ef0f1b04ad
Signed by: sbrl
GPG Key ID: 1BE5172E637709C2
  1. 3
      Changelog.md
  2. 20
      docs/05-API-Docs.md
  3. 2
      package.json
  4. 2
      version

@ -1,5 +1,8 @@
# Changelog
# v0.10.2
- [API Docs] Add links to action sections
# v0.10.1
- Remove heatmap blob radius UI setting
- Add welcome tour, which shows the first time the page is loaded

@ -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:
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.
Action | Meaning
----------------------------------------|----------------------------
[`version`](#version) | Gets the version of _Air Quality Web_ that's currently running.
[`fetch-data`](#fetch-data) | Fetches air quality data from the system for a specific data type at a specific date and time.
[`list-devices`](#list-devices) | Fetches a list of devices currently in the system.
[`device-info`](#device-info) | Gets (lots of) information about a single device.
[`list-reading-types`](#list-reading-types) | Lists the different types of readings that can be specified.
[`device-data-bounds`](#device-data-bounds) | Gets the start and end DateTime bounds for the data recorded for a specific device.
[`device-data`](#device-data) | Gets data by device given a start and end time.
[`changelog`](#changelog) | Gets the changelog as a fragment of HTML.
These are explained in detail below:

@ -1,6 +1,6 @@
{
"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.",
"private": true,
"main": "index.mjs",

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

Loading…
Cancel
Save