From 60d91d8ce4b24bc06d9ff05cdfdd86b15df7a884 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafael=20Weing=C3=A4rtner?= Date: Wed, 15 Mar 2023 13:32:30 -0300 Subject: [PATCH] Improve reprocessing task documentation Change-Id: I51e50d1b4f7d5fbe7dcbda7ddcc8b8453eb5c439 --- api-ref/source/v2/task/reprocessing.inc | 1 + api-ref/source/v2/task/reprocessing_parameters.yml | 9 +++++++++ 2 files changed, 10 insertions(+) diff --git a/api-ref/source/v2/task/reprocessing.inc b/api-ref/source/v2/task/reprocessing.inc index b7cdc346..df04d493 100644 --- a/api-ref/source/v2/task/reprocessing.inc +++ b/api-ref/source/v2/task/reprocessing.inc @@ -113,6 +113,7 @@ one can retrieve all reprocessing tasks scheduled for a scope. .. rest_parameters:: task/reprocessing_parameters.yml - scope_ids: scope_ids_query + - order: scope_ids_order_query Status codes ------------ diff --git a/api-ref/source/v2/task/reprocessing_parameters.yml b/api-ref/source/v2/task/reprocessing_parameters.yml index c6ecf471..0a4bfb10 100644 --- a/api-ref/source/v2/task/reprocessing_parameters.yml +++ b/api-ref/source/v2/task/reprocessing_parameters.yml @@ -19,6 +19,15 @@ offset: type: int required: false +scope_ids_order_query: &scope_ids_order_query + in: query + description: | + The order in which reprocessing tasks are returned. By default, we + order reprocessing tasks ``desc`` by their insertion order in the + database. The possible values are ``desc`` or ``asc``. + required: false + type: string + scope_ids_query: &scope_ids_query in: query description: |