more documentation.

2025-08-22 01:01:04 +00:00 · 2020-11-18 00:00:55 +01:00
parent 42a02991e7
commit 758d53d816
3 changed files with 93 additions and 7 deletions
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -66,7 +66,7 @@ Result list object returned by the endpoint:
        "page": 1,
        "page_count": 1,
        "results": [
-            ...
+            
        ]
    }

@@ -83,11 +83,13 @@ Result object:

    {
        "id": 1,
-        "highlights": ...,
+        "highlights": [
+            
+        ],
        "score": 6.34234,
        "rank": 23,
        "document": {
-            ...
+            
        }

 *   ``id``: the primary key of the found document