extending parameter descriptions in docs

adapting their grouping modifying some descriptions
GIScience · Nov 2, 2020 · 7eb6060 · 7eb6060
1 parent 858fb1a
commit 7eb6060
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 14 deletions.
diff --git a/docs/http-response-status.rst b/docs/http-response-status.rst
@@ -1,7 +1,7 @@
-HTTP response status of the ohsome API
-======================================
+HTTP Response Status
+====================
 
-List of HTTP status codes and respective descriptions of the ohsome API.
+List of HTTP status codes and respective descriptions.
 
 2xx success
 -----------

diff --git a/docs/response-parameters.rst b/docs/response-parameters.rst
@@ -1,23 +1,35 @@
 Response Parameters
 ===================
 
-List and description of response parameters.
+Descriptions of the custom response parameters that are marked with a leading ``@`` for the 
+data extraction and contributions endpoints.
 
-Extraction Endpoints
---------------------
+General Parameters
+------------------
 
 * ``@osmId`` - id of the OSM feature with its type (node/way/relation)
-* ``@validFrom`` - indicates when a creation or change of this feature with these exactly attributes and geometry was made; has the same value as the fromTimestamp if the creation/change happened before the requested timestamp
-* ``@validTo`` - indicates until when this feature with these exactly attributes and geometry stayed unchanged or undeleted; has the same value as the fromTimestamp if the creation/change happened before the requested timestamp
+* ``@version`` - version of the feature
+* ``@changesetId``- id assigned to a changeset
+* ``@osmType``- type (node/way/relation) of OSM feature
 
-Contribution Endpoints
-----------------------
 
-* ``@osmId`` - id of the OSM feature with its type (node/way/relation)
-* ``@osmType``- type (node/way/relation) of OSM feature
+Extraction Parameters
+---------------------
+
+**specific for /elements**
+
+* ``@snapshotTimestamp`` - describes for which timestamp a snapshot of this feature was requested
+* ``@lastEdit`` - describes the timestamp at which this feature was edited the last time
+
+**specific for /elementsFullHistory**
+
+* ``@validFrom`` - indicates when a creation or change of this feature with the provided attributes and geometry was made; has the same value as the fromTimestamp if the creation/change happened before the requested time interval
+* ``@validTo`` - indicates until when this feature with the provided attributes and geometry stayed unchanged or undeleted; has the same value as the toTimestamp if the change/deletion happened after the requested time interval
+
+Contribution Parameters
+-----------------------
+
 * ``@timestamp`` - indicates when this contribution occurred
-* ``@version`` - version of the feature
-* ``@changesetId``- id assigned to a changeset
 * ``@creation``	- contribution type; indicates if this feature is newly created (true); cannot occur in combination with other contribution types
 * ``@geometryChange`` - contribution type; indicates if the geometry of this feature has changed (true); can occur in combination with @tagChange
 * ``@tagChange``- contribution type; indicates if the tag of this feature has changed (true); can occur in combination with @geometryChange