[WIP] WNT API documentation #87
Conversation
PFigs
added
apis/wnt
![hound[bot]](https://avatars.githubusercontent.com/in/3598?s=60&v=4){kind=small}
| . | ||
| } | ||
|
|
||
| mes |
There was a problem hiding this comment.
Don’t use literal URLs without angle brackets
| Other clients are notified about the users related changes (except | ||
| password changes) via real time situation connection. | ||
|
|
||
| ### Metadata service |
There was a problem hiding this comment.
Remove 1 space before this heading’s content
|
|
||
| This document is compliant with WNT backend version 2.0. | ||
|
|
||
| ## Backend interface components |
There was a problem hiding this comment.
Remove 1 space before this heading’s content
| - [Pixels to WGS84](#pixels-to-wgs84) | ||
| - [WGS84 to ECEF conversion](#wgs84-to-ecef-conversion) | ||
| - [ECEF to WGS84 conversion](#ecef-to-wgs84-conversion) | ||
| - [References](#references) |
There was a problem hiding this comment.
Incorrect list-item indent: add 2 spaces
| - [WGS84 to pixels](#wgs84-to-pixels) | ||
| - [Pixels to WGS84](#pixels-to-wgs84) | ||
| - [WGS84 to ECEF conversion](#wgs84-to-ecef-conversion) | ||
| - [ECEF to WGS84 conversion](#ecef-to-wgs84-conversion) |
There was a problem hiding this comment.
Incorrect list-item indent: add 2 spaces
| - [Time series service data](#time-series-service-data) | ||
| - [Example CURL command to query data](#example-curl-command-to-query-data) | ||
| - [Example column names decoding](#example-column-names-decoding) | ||
| - [Basic data flow and real time situation data](#basic-data-flow-and-real-time-situation-data) |
There was a problem hiding this comment.
Incorrect list-item indent: add 2 spaces
| - [Real time situation service authentication](#real-time-situation-service-authentication) | ||
| - [Time series service data](#time-series-service-data) | ||
| - [Example CURL command to query data](#example-curl-command-to-query-data) | ||
| - [Example column names decoding](#example-column-names-decoding) |
There was a problem hiding this comment.
Incorrect list-item indent: add 2 spaces
| - [Get components information](#get-components-information) | ||
| - [Real time situation service authentication](#real-time-situation-service-authentication) | ||
| - [Time series service data](#time-series-service-data) | ||
| - [Example CURL command to query data](#example-curl-command-to-query-data) |
There was a problem hiding this comment.
Incorrect list-item indent: add 2 spaces
| - [Get scratchpad status](#get-scratchpad-status) | ||
| - [Get components information](#get-components-information) | ||
| - [Real time situation service authentication](#real-time-situation-service-authentication) | ||
| - [Time series service data](#time-series-service-data) |
There was a problem hiding this comment.
Incorrect list-item indent: add 2 spaces
| - [Send data message](#send-data-message) | ||
| - [Get scratchpad status](#get-scratchpad-status) | ||
| - [Get components information](#get-components-information) | ||
| - [Real time situation service authentication](#real-time-situation-service-authentication) |
There was a problem hiding this comment.
Incorrect list-item indent: add 2 spaces
| +-----------------------------------+-----------------------------------+ | ||
| | Version | Description | | ||
| +===================================+===================================+ | ||
| | 1.6 | Initial version | | ||
| +-----------------------------------+-----------------------------------+ | ||
| | 1.7 | Updated for WNT 1.7 | | ||
| | | | | ||
| | | - Removed warning from *Get | | ||
| | | areas* chapter and updated | | ||
| | | the response, as the issue | | ||
| | | was fixed. | | ||
| | | | | ||
| | | - Removed note about *Set node | | ||
| | | metadata* method only to | | ||
| | | accept single entry, as it is | | ||
| | | not true anymore. | | ||
| +-----------------------------------+-----------------------------------+ | ||
| | 2.0 | Updated for WNT 2.0 | | ||
| | | | | ||
| | | - Added *protocol version* | | ||
| | | table. | | ||
| | | | | ||
| | | - Updated *protocol version* | | ||
| | | to 3. | | ||
| | | | | ||
| | | - Added note about | | ||
| | | *analytics\_packet* | | ||
| | | measurement change. | | ||
| | | | | ||
| | | - Added *Get components | | ||
| | | information* and *Get | | ||
| | | scratchpad status* methods. | | ||
| | | | | ||
| | | - Added floor plan image size | | ||
| | | to *Create* and *Update floor | | ||
| | | plan* messages. | | ||
| | | | | ||
| | | - Changed *Create* and *Update | | ||
| | | floor plan* messages to | | ||
| | | return all floor plan fields. | | ||
| | | | | ||
| | | - Added coordinate conversion | | ||
| | | related data to *Create* and | | ||
| | | *Update floor plan* messages. | | ||
| | | | | ||
| | | - Changed *network* *id* to | | ||
| | | number in *Create*, *Update | | ||
| | | and Delete network*. | | ||
| | | | | ||
| | | - Removed *pixel\_location\_x* | | ||
| | | and *pixel\_location\_y* from | | ||
| | | *Set node metadata* message. | | ||
| | | | | ||
| | | - Added *remote\_api\_response* | | ||
| | | to Influx measurements. | | ||
| | | | | ||
| | | - Split *analytics\_packet* | | ||
| | | Influx measurement's | | ||
| | | *travel\_time\_ms* column to | | ||
| | | *travel\_time\_ms\_qos0* and | | ||
| | | *travel\_time\_ms\_qos1*. | | ||
| +-----------------------------------+-----------------------------------+ |
There was a problem hiding this comment.
This part should be always visible as it is easy reference for what has changed in the API
| - [Update building](#update-building) | ||
| - [Delete building](#delete-building) | ||
| - [Get building's floor plans](#get-buildings-floor-plans) | ||
| - [Create floor plan](#create-floor-plan) |
There was a problem hiding this comment.
Should be in same level as the other floor plan messages
| - [Basic data flow and real time situation data](#basic-data-flow-and-real-time-situation-data) | ||
| - [Basic data flow to get continuous data](#basic-data-flow-to-get-continuous-data) | ||
| - [Real time situation data](#real-time-situation-data) | ||
| - [Coordinate conversions](#coordinate-conversions) |
There was a problem hiding this comment.
There should be "Introduction" chapter right after the main one
| | Load scratchpad \* | 1075 | Administrator | | ||
| | Get components information | 1081 | All | | ||
|
|
||
| \* Message will be documented later (add link instead) |
There was a problem hiding this comment.
"(add link instead)" should not be in the document
| mapping between WGS84 and pixel coordinates. For more information please | ||
| see chapter 9. |
There was a problem hiding this comment.
Reference not working as chapters do not have numbers.
| mapping between WGS84 and pixel coordinates. For more information please | ||
| see chapter 9. |
There was a problem hiding this comment.
Reference not working as chapters do not have numbers.
| mapping between WGS84 and pixel coordinates. For more information please | ||
| see chapter 9. |
There was a problem hiding this comment.
Reference not working as chapters do not have numbers.
| ### Get floor plan image data | ||
|
|
||
| The method can be used to fetch floor plan image or thumbnail data. The | ||
| image binary data is encoded using Base64 (RFC 3548) encoding. |
There was a problem hiding this comment.
Would it be possible to have a link to the RFC?
| | Path | Data | | ||
| |---------------------------------- | ----------------| | ||
| | Message -\> rtsituation\_metadata | cluster\_no | | ||
| | | | | ||
| | | cluster\_size | | ||
| | | | | ||
| | | node\_count | |
There was a problem hiding this comment.
This does not look good in the rendered version
| same credentials used to login to authentication service can be used | ||
| also to access the database. | ||
|
|
||
| The "wirepas*"* database contains several *measurements* (Influx |
There was a problem hiding this comment.
There should not be star after wirepas word
There are still quite a few things to fix: