From 00025d6dc2078dde69571a32492d719562731dab Mon Sep 17 00:00:00 2001 From: Rosario Trischitta Date: Thu, 21 Jan 2021 12:29:10 +0100 Subject: [PATCH] docs: add parameter description for aggregation endpoints --- docs/response-parameters.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/response-parameters.rst b/docs/response-parameters.rst index eb15a051..f87dd396 100644 --- a/docs/response-parameters.rst +++ b/docs/response-parameters.rst @@ -21,6 +21,19 @@ When requested, the result will contain OSM elements' tags as individual GeoJSON Aggregation Parameters ---------------------- +**specific for all groupBy endpoints** + +* ``groupByResult`` - GroupBy result object containing the groupBy value and the respective objects. In the /ratio/groupBy/boundary endpoint, this parameter is replaced by ``groupByBoundaryResult`` +* ``groupByObject`` - Object on which the results are grouped on + +**specific for all ratio endpoints** + +* ``ratioResult`` - Result JSON object containing the timestamp together with two values and their resulting ratio. + +**specific for the /ratio/groupBy/boundary endpoint** + +* ``groupByBoundaryResult`` - Result grouped by boundary containing groupByObject and ratioResult objects + Extraction Parameters ---------------------