From dd14e02741b9d6e1e12a5c542d8a3d9aa8480e35 Mon Sep 17 00:00:00 2001 From: Veloman Yunkan Date: Wed, 6 Mar 2024 19:29:44 +0400 Subject: [PATCH] Documented a couple of /search API's caveats --- docs/kiwix-serve.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/kiwix-serve.rst b/docs/kiwix-serve.rst index 45eb20a..24dbad8 100644 --- a/docs/kiwix-serve.rst +++ b/docs/kiwix-serve.rst @@ -617,12 +617,24 @@ A multi-ZIM search request must comply with the following constraints: a multi-ZIM search, however must respect the :ref:`multi-ZIM search constraints `. + .. note:: + + If any of the provided ``books.id`` values refers to a book missing + from the library then an error is returned instead of running the + search on the remaining (valid) entries. + ``books.name``: :term:`name of the ZIM file ` (not to be confused with ``books.filter.name`` which selects/filters based on the :term:`book name `). Can be repeated for a multi-ZIM search, however must respect the :ref:`multi-ZIM search constraints `. + .. note:: + + If any of the provided ``books.name`` values refers to a book missing + from the library then an error is returned instead of running the + search on the remaining (valid) entries. + ``books.filter.{criteria}``: allows to take full advantage of :ref:`library filtering ` functionality of the `/catalog/v2/entries`_ endpoint (``{criteria}`` must be replaced with an attribute/filtering