summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/future.md27
1 files changed, 22 insertions, 5 deletions
diff --git a/doc/api/future.md b/doc/api/future.md
index 4cf0d40..7530704 100644
--- a/doc/api/future.md
+++ b/doc/api/future.md
@@ -22,15 +22,32 @@ accessed directly with its link-local address.
# HTTP Server
-- `GET /device/type` `text/plain`
-- `GET /device/type/uuid` `text/plain`
-- `GET /device/hardware/version` `text/plain`
-- `GET /device/firmware/version` `text/plain`
-- `GET /device/mac-address/eui-48` `text/plain`
+- `GET /` `application/json` (returns device info, see below)
- `GET /settings` `application/json`
- `PUT /settings` `application/json`
+# Device Info
+
+```
+{
+ "hostname": "mydevice",
+ "type": {
+ "text": "iot-contact",
+ "uuid": "eeb58c52-8e25-489c-9a1a-c4662fc9318a"
+ },
+ "version": {
+ "hardware": "v1.2.3",
+ "firmware": "v4.5.6"
+ },
+ "address": {
+ "mac": {
+ "eui-48": "00:00:5e:00:53:01"
+ }
+ }
+}
+```
+
# Settings
```