Test and docs for ?_facet_size=max, refs #1337

simonw · May 27, 2021 · 4545120 · 4545120
1 parent 7e983fe
commit 4545120
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/docs/json_api.rst b/docs/json_api.rst
@@ -381,7 +381,7 @@ Special table arguments
     Facet by column. Can be applied multiple times, see :ref:`facets`. Only works on the default JSON output, not on any of the custom shapes.
 
 ``?_facet_size=100``
-    Increase the number of facet results returned for each facet.
+    Increase the number of facet results returned for each facet. Use ``?_facet_size=max`` for the maximum available size, determined by :ref:`setting_max_returned_rows`.
 
 ``?_trace=1``
     Turns on tracing for this page: SQL queries executed during the request will

diff --git a/tests/test_facets.py b/tests/test_facets.py
@@ -399,3 +399,9 @@ async def test_facet_size():
     )
     data4 = response4.json()
     assert len(data4["facet_results"]["city"]["results"]) == 20
+    # Test _facet_size=max
+    response5 = await ds.client.get(
+        "/test_facet_size/neighbourhoods.json?_facet_size=max&_facet=city"
+    )
+    data5 = response5.json()
+    assert len(data5["facet_results"]["city"]["results"]) == 20