vrr/kiwix-tools
2
0
Fork 0
mirror of https://github.com/kiwix/kiwix-tools.git synced 2026-04-28 11:40:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Documented a couple of /search API's caveats

Browse source
This commit is contained in:
Veloman Yunkan 2024-03-06 19:29:44 +04:00
parent 8ea12b2ce5
commit dd14e02741
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/kiwix-serve.rst
View file

@ -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 <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 <ZIM name>` (not to be confused
with ``books.filter.name`` which selects/filters based on the :term:`book
name <Book name>`). Can be repeated for a multi-ZIM search, however must
respect the :ref:`multi-ZIM search constraints
<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 <library-filtering>` functionality of the `/catalog/v2/entries`_
endpoint (``{criteria}`` must be replaced with an attribute/filtering