From e7651eab16e1ac2beb24dbbd879ba865bcb139b2 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Sat, 30 Nov 2019 16:54:48 +0000 Subject: [PATCH] docs: Only include 'order' filter in '/events/' for v1.2+ Even though we don't actually version this thing, don't document for older versions of the API lest people using older deployments get confused. Signed-off-by: Stephen Finucane --- docs/api/schemas/patchwork.j2 | 2 ++ docs/api/schemas/v1.0/patchwork.yaml | 1 - docs/api/schemas/v1.1/patchwork.yaml | 1 - 3 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/schemas/patchwork.j2 b/docs/api/schemas/patchwork.j2 index 12a6f67d..e2c8a8c1 100644 --- a/docs/api/schemas/patchwork.j2 +++ b/docs/api/schemas/patchwork.j2 @@ -336,7 +336,9 @@ paths: parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' +{% if version >= (1, 2) %} - $ref: '#/components/parameters/Order' +{% endif %} - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/BeforeFilter' - $ref: '#/components/parameters/SinceFilter' diff --git a/docs/api/schemas/v1.0/patchwork.yaml b/docs/api/schemas/v1.0/patchwork.yaml index e6adfddd..b01cbcfa 100644 --- a/docs/api/schemas/v1.0/patchwork.yaml +++ b/docs/api/schemas/v1.0/patchwork.yaml @@ -216,7 +216,6 @@ paths: parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/Order' - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/BeforeFilter' - $ref: '#/components/parameters/SinceFilter' diff --git a/docs/api/schemas/v1.1/patchwork.yaml b/docs/api/schemas/v1.1/patchwork.yaml index 6af697c8..f85c8711 100644 --- a/docs/api/schemas/v1.1/patchwork.yaml +++ b/docs/api/schemas/v1.1/patchwork.yaml @@ -216,7 +216,6 @@ paths: parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/Order' - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/BeforeFilter' - $ref: '#/components/parameters/SinceFilter' -- 2.47.3