1
edit
Difference between revisions of "OPDS"
Jump to navigation
Jump to search
added category tag info for /catalog/search endpoint
(Better introduction sentence) |
(added category tag info for /catalog/search endpoint) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[Kiwix-serve]] provides an | [[Kiwix-serve]] provides an [https://en.wikipedia.org/wiki/Open_Publication_Distribution_System OPDS] feed. This API allows to retrieve the library metadata, but not the content themselves. | ||
A live instance can be see at https://library.kiwix.org/. | A live instance can be see at https://library.kiwix.org/. | ||
== End points == | == End points == | ||
* | * https://library.kiwix.org/catalog/searchdescription.xml which proposes an overall OPDS description in XML format | ||
* https://library.kiwix.org/catalog/search which accepts a few GET parameter: | * https://library.kiwix.org/catalog/search which accepts a few GET parameter: | ||
** <code>q=<PATTERN></code> which proposes a keyword based search in the catalogue (on title and description). | ** <code>q=<PATTERN></code> which proposes a keyword based search in the catalogue (on title and description). | ||
** <code>lang=fra</code> which proposes a language filter. Use an ISO639-3 language value (like in ZIM metadata). | ** <code>lang=fra</code> which proposes a language filter. Use an ISO639-3 language value (like in ZIM metadata). | ||
** <code>tag=wikipedia</code> to filter | ** <code>tag=wikipedia</code> to list only entries with all of the specified tags. | ||
** <code>category=phet</code> to list all entries with specified category. | |||
** <code>notag=</code>_videos:yes to filter out entries with any of the specified tags. | |||
** <code>name=wikipedia_ny_all</code> to list only entries with the specified name (exact match). | |||
** <code>maxsize=1234567890</code> to filter out entries larger than the specified size. | |||
** <code>count=2</code> to limit the number of results. | ** <code>count=2</code> to limit the number of results. | ||
** <code>start=1</code> to indicate an offset in search results. | ** <code>start=1</code> to indicate an offset in search results. | ||