quick explanation howto use the locate endpoint

2019-12-28 18:29:26 +01:00 · 2019-12-28 18:29:26 +01:00 · 3988fff5e6
commit 3988fff5e6
parent 1a8cf4ed5c
1 changed files with 14 additions and 0 deletions
--- a/src/c3nav/routing/api.py
+++ b/src/c3nav/routing/api.py
@ -23,6 +23,20 @@ class RoutingViewSet(ViewSet):
    /route/ Get routes.
    /options/ Get or set route options.
    /locate/ Wifi locate.
+
+    How to use the /locate/ endpoint:
+    POST visible wifi stations as JSON data like this:
+    {
+        "stations": [
+            {
+                "bssid": "11:22:33:44:55:66",
+                "ssid": "36C3",
+                "level": -55,
+                "frequency": 5500
+            },
+            ...
+        ]
+    }
    """
    @action(detail=False, methods=['get', 'post'])
    def route(self, request, *args, **kwargs):