From ef0f1b04ad43377ee26720beee8814b7249ee7fa Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Thu, 13 Jun 2019 20:57:49 +0100 Subject: [PATCH] Add links to sections in API docs --- Changelog.md | 3 +++ docs/05-API-Docs.md | 20 ++++++++++---------- package.json | 2 +- version | 2 +- 4 files changed, 15 insertions(+), 12 deletions(-) diff --git a/Changelog.md b/Changelog.md index a4e57e9..4939550 100644 --- a/Changelog.md +++ b/Changelog.md @@ -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 diff --git a/docs/05-API-Docs.md b/docs/05-API-Docs.md index 2c9b36f..982f955 100644 --- a/docs/05-API-Docs.md +++ b/docs/05-API-Docs.md @@ -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: diff --git a/package.json b/package.json index c818123..1926096 100644 --- a/package.json +++ b/package.json @@ -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", diff --git a/version b/version index 9097bf9..3123ff9 100644 --- a/version +++ b/version @@ -1 +1 @@ -v0.10 +v0.10.2