Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add parameter description in aggregation responses #101

Closed
wants to merge 1 commit into from
Closed

add parameter description in aggregation responses #101

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/response-parameters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------------

Expand Down