From 7179244c478214077659c240c98acad61b889fc3 Mon Sep 17 00:00:00 2001 From: Veloman Yunkan Date: Wed, 14 Dec 2022 16:41:13 +0400 Subject: [PATCH] Documented the /raw endpoint --- docs/kiwix-serve.rst | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/docs/kiwix-serve.rst b/docs/kiwix-serve.rst index 3162ad2..3fc5503 100644 --- a/docs/kiwix-serve.rst +++ b/docs/kiwix-serve.rst @@ -377,10 +377,24 @@ specified ZIM file. ``content``: :term:`name ` of the ZIM file. -``/raw`` --------- +``/raw/ZIMNAME/content/PATH/IN/ZIMFILE`` +---------------------------------------- -Blablabla +Returns the entry with path ``PATH/IN/ZIMFILE`` from the ZIM file with +:term:`name ` ``ZIMNAME``. Currently, this endpoint almost duplicates +(with some subtle technical differences) the newer endpoint +`/content/ZIMNAME/PATH/IN/ZIMFILE`_. The important difference is that the +``/raw`` endpoint guarantees that no server-side processing will be applied to +the returned content, whereas content obtained via the ``/content`` endpoint +may in the future undergo some processing intended to improve the operation of +the viewer (e.g. compensating for certain bugs in ZIM creation). + + +``/raw/ZIMNAME/meta/METADATAID`` +-------------------------------- + +Returns the metadata item ``METADATAID`` from the ZIM file with :term:`name +` ``ZIMNAME``. ``/search``