Fixed & elaborated documentation of OPDS catalog pagination

kiwix / kiwix-tools

Command line Kiwix tools: kiwix-serve, kiwix-manage, ...

https://download.kiwix.org/release/kiwix-tools/

GNU General Public License v3.0

408 stars 79 forks source link

Fixed & elaborated documentation of OPDS catalog pagination #599

Closed veloman-yunkan closed 1 year ago

veloman-yunkan commented 1 year ago

Fixes #595

It turned out that the count parameter of the /catalog/v2/entries endpoint was documented incorrectly. I both fixed and elaborated the documentation.

This PR is secretly published on RTD. See the documentation of the relevant section at https://kiwix-tools.readthedocs.io/en/documentation_of_catalog_pagination/kiwix-serve.html#catalog-v2-entries

rgaudin commented 1 year ago

We agreed to remove the the count=0 special behavior now but the documentation should mention this now former behavior.