From a8afbfd27d2f93035f7104aee1882424b4d4cef5 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Sun, 15 Oct 2017 22:49:12 +0100 Subject: [PATCH] Avoid external link in search swagger --- api/client-server/search.yaml | 6 +++++- specification/client_server_api.rst | 2 ++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/api/client-server/search.yaml b/api/client-server/search.yaml index 78dace90..37e49490 100644 --- a/api/client-server/search.yaml +++ b/api/client-server/search.yaml @@ -88,8 +88,12 @@ paths: filter: type: object title: Filter + # Within the C-S spec document, `filter`_ is picked up + # as a link to the filtering section. In OpenAPI 3.0, + # we could use the link feature, but we're still on 2.0 + # for now :/ description: |- - This takes a `filter `_. + This takes a `filter`_. order_by: title: "Ordering" type: string diff --git a/specification/client_server_api.rst b/specification/client_server_api.rst index eda2eb26..c6104fa8 100644 --- a/specification/client_server_api.rst +++ b/specification/client_server_api.rst @@ -880,6 +880,8 @@ Where $streamtoken is an opaque token which can be used in another query to get the next set of results. The "start" and "end" keys can only be omitted if the complete dataset is provided in "chunk". +.. _`filter`: + Filtering ---------