Mercurial > lbo > hg > geohub

changeset 51:a75d164f028a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Further clarify documentation about notes
author Lewin Bormann <lbo@spheniscida.de>
date Thu, 03 Dec 2020 22:00:25 +0100
parents 272fd1c35319
children ac13f3a4299a
files README.md
diffstat 1 files changed, 4 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Thu Dec 03 21:59:20 2020 +0100
+++ b/README.md	Thu Dec 03 22:00:25 2020 +0100
@@ -42,8 +42,8 @@
   * `speed`: Speed in km/h (usually). If you decide to always use m/s, you are
   free to do so. **Optional**.
   * `elevation`: Elevation in meters. **Optional**.
-  * A body -- encoded in whatever content-type -- is attached as `note` to the
-  point and returned as property of GeoJSON points later.
+  * A body -- if present and encoded in whatever content-type -- is attached as `note` to the
+  point and returned as property `note` of GeoJSON points later.
   * Usually returns code **200** except for server errors (500) or malformed inputs (400).
 * `GET` `/geo/assets/...`
   * Static file serving. The `assets` directory should be deployed in the
@@ -80,7 +80,8 @@
           "time": "2020-12-03T15:42:40.010325Z",
           "altitude": 40,
           "speed": 22,
-          "id": 1205
+          "id": 1205,
+          "note": "A happy little note",
         },
         "geometry": {
           "type": "Point",