paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-02 13:45:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

documentation

Browse Source
This commit is contained in:
jonaswinkler 2020-12-05 12:52:49 +01:00
parent 782dbee3a0
commit 1e9e347f15
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/api.rst
View File

@ -109,6 +109,7 @@ Result list object returned by the endpoint:
"count": 1, "count": 1,
"page": 1, "page": 1,
"page_count": 1, "page_count": 1,
"corrected_query": "",
"results": [ "results": [
] ]
@ -119,6 +120,8 @@ Result list object returned by the endpoint:
the page you requested, if you requested a page that is behind the page you requested, if you requested a page that is behind
the last page. In that case, the last page is returned. the last page. In that case, the last page is returned.
* ``page_count``: The total number of pages. * ``page_count``: The total number of pages.
* ``corrected_query``: Corrected version of the query string. Can be null.
If not null, can be used verbatim to start a new query.
* ``results``: A list of result objects on the current page. * ``results``: A list of result objects on the current page.
Result object: Result object: