u

docs/api/routes/articleIndex.md

@@ -8,6 +8,20 @@ Returns every article reachable via the company's category tree.
 Designed for client-side search / autocomplete preload.
 Auth via company access.
 
+REQUIRES `windowSize`. Without it the response is always an empty list — the full
+index can be very large and is not useful to a caller that did not ask for a
+specific window. Pass the number of entries the client actually intends to preload.
+
+
+## Query parameters
+
+| Param | Required | Type | Description |
+|-------|----------|------|-------------|
+| `windowSize` | yes | integer | Number of articles to return (window size). Required; omitting it returns an
+empty `articles` array. `truncated` is true when more entries exist than were
+returned, signalling the client should request a larger window or narrow its
+query.
+ |
 
 ## Response `200`
 
@@ -27,7 +41,8 @@ Search index
         1
       ]
     }
-  ]
+  ],
+  "truncated": true
 }
 ```