From 1e9e347f15b427830ded3b05978666983b850893 Mon Sep 17 00:00:00 2001 From: jonaswinkler Date: Sat, 5 Dec 2020 12:52:49 +0100 Subject: [PATCH] documentation --- docs/api.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/api.rst b/docs/api.rst index 4c9ae0b13..81334b9ec 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -109,6 +109,7 @@ Result list object returned by the endpoint: "count": 1, "page": 1, "page_count": 1, + "corrected_query": "", "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 last page. In that case, the last page is returned. * ``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. Result object: