Skip to content

Commit

Permalink
update documentation to 1.3.2 release (#105)
Browse files Browse the repository at this point in the history
  • Loading branch information
@tyrasd
tyrasd authored Jan 29, 2021
1 parent 206662e commit c52d5f8
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 43 deletions.
8 changes: 4 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

The ohsome API is a generic web API for in-depth analysis of OpenStreetMap (OSM) data with a focus on it's history. It allows to get aggregated statistics about the evolution of OSM data itself and about the contributors behind the data. Furthermore, data extraction methods are provided to access the historic development of individual OSM features.

The functionalities of the ohsome API can be accessed via HTTP requests. As a basis underneath serves the [OSHDB API](https://github.com/GIScience/oshdb). The current stable version is [v1.3.1](https://github.com/GIScience/ohsome-api/releases/tag/1.3.1). Developed and maintained by [HeiGIT](https://heigit.org/).
The functionalities of the ohsome API can be accessed via HTTP requests. As a basis underneath serves the [OSHDB API](https://github.com/GIScience/oshdb). The current stable version is [v1.3.2](https://github.com/GIScience/ohsome-api/releases/tag/1.3.2). Developed and maintained by [HeiGIT](https://heigit.org/).

## Using the ohsome API

Expand Down Expand Up @@ -38,8 +38,8 @@ These instructions will get you a copy of the project up and running on your loc
2. move to your Maven project directory in a shell (e.g. Windows PowerShell)
3. enter the command `mvn -DskipTests=true package` to build the project (if you want to build it running the integrated tests too, look at the section [Testing](#testing))
4. to run the jar file enter the following (if no additional keytables file is given, you can assume that it is included):
* keytables included: `java -jar target/ohsome-api-1.3.1.jar --database.db=C:/path-to-your-data/ba-wue.oshdb`
* keytables not included: `java -jar target/ohsome-api-1.3.1.jar --database.db=C:/path-to-your-data/ba-wue.oshdb --database.keytables=C:/path-to-your-keytablesFile/keytables`
* keytables included: `java -jar target/ohsome-api-1.3.2.jar --database.db=C:/path-to-your-data/ba-wue.oshdb`
* keytables not included: `java -jar target/ohsome-api-1.3.2.jar --database.db=C:/path-to-your-data/ba-wue.oshdb --database.keytables=C:/path-to-your-keytablesFile/keytables`

Now you should have a running local API, which is ready for receiving requests under *http://localhost:8080/*.
<br>To check if it is running properly, you should be able to visit the swagger documentation under *http://localhost:8080/swagger-ui.html*.
Expand Down Expand Up @@ -97,7 +97,7 @@ Here you see an example response giving the length of residential roads for a bo
"url": "https://ohsome.org/copyrights",
"text": "© OpenStreetMap contributors"
},
"apiVersion": "1.3.1",
"apiVersion": "1.3.2",
"metadata": {
"executionTime": 858,
"description": "Total length of items in meters.",
Expand Down
78 changes: 39 additions & 39 deletions docs/endpoints.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ How big is the area of farmland in the region Rhein-Neckar?
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"result" : [ {
"timestamp" : "2014-01-01T00:00:00Z",
"value" : 1.020940258E7
Expand All @@ -92,7 +92,7 @@ How big is the area of farmland in the region Rhein-Neckar?
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"result" : [ {
"timestamp" : "2014-01-01T00:00:00Z",
"value" : 1.020940258E7
Expand All @@ -107,7 +107,7 @@ How big is the area of farmland in the region Rhein-Neckar?
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"result" : [ {
"timestamp" : "2014-01-01T00:00:00Z",
"value" : 10209402.58
Expand All @@ -121,7 +121,7 @@ How big is the area of farmland in the region Rhein-Neckar?
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"result" : [ {
"timestamp" : "2014-01-01T00:00:00Z",
"value" : 1.020940258E7
Expand Down Expand Up @@ -175,7 +175,7 @@ What is the density of restaurants with wheelchair access in Heidelberg?
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"result" : [ {
"timestamp" : "2019-05-07T00:00:00Z",
"value" : 0.79
Expand All @@ -189,7 +189,7 @@ What is the density of restaurants with wheelchair access in Heidelberg?
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"result" : [ {
"timestamp" : "2019-05-07T00:00:00Z",
"value" : 0.79
Expand All @@ -204,7 +204,7 @@ What is the density of restaurants with wheelchair access in Heidelberg?
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"result" : [ {
"timestamp" : "2019-05-07T00:00:00Z",
"value" : 0.79
Expand All @@ -218,7 +218,7 @@ What is the density of restaurants with wheelchair access in Heidelberg?
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"result" : [ {
"timestamp" : "2019-05-07T00:00:00Z",
"value" : 0.79
Expand Down Expand Up @@ -276,7 +276,7 @@ How many oneway streets exist within living_street streets in Heidelberg over ti
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"ratioResult" : [ {
"timestamp" : "2016-01-01T00:00:00Z",
"value" : 28660.519999999997,
Expand All @@ -303,7 +303,7 @@ How many oneway streets exist within living_street streets in Heidelberg over ti
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"ratioResult" : [ {
"timestamp" : "2016-01-01T00:00:00Z",
"value" : 28660.519999999997,
Expand Down Expand Up @@ -331,7 +331,7 @@ How many oneway streets exist within living_street streets in Heidelberg over ti
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"ratioResult" : [ {
"timestamp" : "2016-01-01T00:00:00Z",
"value" : 28660.519999999997,
Expand All @@ -357,7 +357,7 @@ How many oneway streets exist within living_street streets in Heidelberg over ti
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"ratioResult" : [ {
"timestamp" : "2016-01-01T00:00:00Z",
"value" : 28660.519999999997,
Expand Down Expand Up @@ -436,7 +436,7 @@ How often information about the roof of buildings is present?
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"groupByResult" : [ {
"result" : [ {
"timestamp" : "2018-01-01T00:00:00Z",
Expand Down Expand Up @@ -466,7 +466,7 @@ How often information about the roof of buildings is present?
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"groupByResult" : [ {
"result" : [ {
"timestamp" : "2018-01-01T00:00:00Z",
Expand Down Expand Up @@ -495,7 +495,7 @@ How often information about the roof of buildings is present?
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"groupByResult" : [ {
"result" : [ {
"timestamp" : "2018-01-01T00:00:00Z",
Expand Down Expand Up @@ -524,7 +524,7 @@ How often information about the roof of buildings is present?
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"groupByResult" : [ {
"result" : [ {
"timestamp" : "2018-01-01T00:00:00Z",
Expand Down Expand Up @@ -608,7 +608,7 @@ Compare length of different types of streets for two or more regions.
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"groupByResult" : [ {
"result" : [ {
"timestamp" : "2018-01-01T00:00:00Z",
Expand Down Expand Up @@ -668,7 +668,7 @@ Compare length of different types of streets for two or more regions.
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"groupByResult" : [ {
"result" : [ {
"timestamp" : "2018-01-01T00:00:00Z",
Expand Down Expand Up @@ -727,7 +727,7 @@ Compare length of different types of streets for two or more regions.
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"groupByResult" : [ {
"result" : [ {
"timestamp" : "2018-01-01T00:00:00Z",
Expand Down Expand Up @@ -786,7 +786,7 @@ Compare length of different types of streets for two or more regions.
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"groupByResult" : [ {
"result" : [ {
"timestamp" : "2018-01-01T00:00:00Z",
Expand Down Expand Up @@ -901,7 +901,7 @@ Show number of users editing buildings before, during and after Nepal earthquake
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"result" : [ {
"fromTimestamp" : "2015-03-01T00:00:00Z",
"toTimestamp" : "2015-04-01T00:00:00Z",
Expand Down Expand Up @@ -933,7 +933,7 @@ Show number of users editing buildings before, during and after Nepal earthquake
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"result" : [ {
"fromTimestamp" : "2015-03-01T00:00:00Z",
"toTimestamp" : "2015-04-01T00:00:00Z",
Expand Down Expand Up @@ -965,7 +965,7 @@ Show number of users editing buildings before, during and after Nepal earthquake
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"result" : [ {
"fromTimestamp" : "2015-03-01T00:00:00Z",
"toTimestamp" : "2015-04-01T00:00:00Z",
Expand Down Expand Up @@ -996,7 +996,7 @@ Show number of users editing buildings before, during and after Nepal earthquake
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"result" : [ {
"fromTimestamp" : "2015-03-01T00:00:00Z",
"toTimestamp" : "2015-04-01T00:00:00Z",
Expand Down Expand Up @@ -1142,7 +1142,7 @@ Extract the modifications of the blown up tower of the heidelberg castle over ti
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"type" : "FeatureCollection",
"features" : [{
"type" : "Feature",
Expand Down Expand Up @@ -1180,7 +1180,7 @@ Extract the modifications of the blown up tower of the heidelberg castle over ti
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"type" : "FeatureCollection",
"features" : [{
"type" : "Feature",
Expand Down Expand Up @@ -1219,7 +1219,7 @@ Extract the modifications of the blown up tower of the heidelberg castle over ti
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"type" : "FeatureCollection",
"features" : [{
"type" : "Feature",
Expand Down Expand Up @@ -1257,7 +1257,7 @@ Extract the modifications of the blown up tower of the heidelberg castle over ti
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"type" : "FeatureCollection",
"features" : [{
"type" : "Feature",
Expand Down Expand Up @@ -1338,7 +1338,7 @@ Get the changes of pharmacies with opening hours in a certain area of Heidelberg
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"metadata" : {
"description" : "Latest contributions as GeoJSON features.",
"requestUrl" : "https://api.ohsome.org/v1/contributions/latest/geometry?bboxes=8.6720,49.3988,8.7026,49.4274&filter=amenity=pharmacy%20and%20opening_hours=*%20and%20type:node&time=2020-02-01,2020-06-29&showMetadata=yes&properties=metadata,tags&clipGeometry=false"
Expand Down Expand Up @@ -1414,7 +1414,7 @@ Get the changes of pharmacies with opening hours in a certain area of Heidelberg
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"metadata" : {
"description" : "Latest contributions as GeoJSON features.",
"requestUrl" : "https://api.ohsome.org/v1/contributions/latest/geometry?bboxes=8.6720,49.3988,8.7026,49.4274&filter=amenity=pharmacy%20and%20opening_hours=*%20and%20type:node&time=2020-02-01,2020-06-29&showMetadata=yes&properties=metadata,tags&clipGeometry=false"
Expand Down Expand Up @@ -1490,7 +1490,7 @@ Get the changes of pharmacies with opening hours in a certain area of Heidelberg
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"metadata" : {
"description" : "Latest contributions as GeoJSON features.",
"requestUrl" : "https://api.ohsome.org/v1/contributions/latest/geometry?bboxes=8.6720,49.3988,8.7026,49.4274&filter=amenity=pharmacy%20and%20opening_hours=*%20and%20type:node&time=2020-02-01,2020-06-29&showMetadata=yes&properties=metadata,tags&clipGeometry=false"
Expand Down Expand Up @@ -1566,7 +1566,7 @@ Get the changes of pharmacies with opening hours in a certain area of Heidelberg
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"metadata" : {
"description" : "Latest contributions as GeoJSON features.",
"requestUrl" : "https://api.ohsome.org/v1/contributions/latest/geometry?bboxes=8.6720,49.3988,8.7026,49.4274&filter=amenity=pharmacy%20and%20opening_hours=*%20and%20type:node&time=2020-02-01,2020-06-29&showMetadata=yes&properties=metadata,tags&clipGeometry=false"
Expand Down Expand Up @@ -1680,7 +1680,7 @@ Get the latest change of constructions in a certain area of the Bahnstadt in Hei
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"metadata" : {
"description" : "Latest contributions as GeoJSON features.",
"requestUrl" : "https://api.ohsome.org/v1/contributions/latest/geometry?bboxes=8.6644159,49.401099,8.6663353,49.4027195&filter=landuse=construction%20and%20type:way&time=2020-06-29,2014-07-01&showMetadata=yes&properties=metadata,tags&clipGeometry=false"
Expand Down Expand Up @@ -1731,7 +1731,7 @@ Get the latest change of constructions in a certain area of the Bahnstadt in Hei
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"metadata" : {
"description" : "Latest contributions as GeoJSON features.",
"requestUrl" : "https://api.ohsome.org/v1/contributions/latest/geometry?bboxes=8.6644159,49.401099,8.6663353,49.4027195&filter=landuse=construction%20and%20type:way&time=2020-06-29,2014-07-01&showMetadata=yes&properties=metadata,tags&clipGeometry=false"
Expand Down Expand Up @@ -1782,7 +1782,7 @@ Get the latest change of constructions in a certain area of the Bahnstadt in Hei
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"metadata" : {
"description" : "Latest contributions as GeoJSON features.",
"requestUrl" : "https://api.ohsome.org/v1/contributions/latest/geometry?bboxes=8.6644159,49.401099,8.6663353,49.4027195&filter=landuse=construction%20and%20type:way&time=2020-06-29,2014-07-01&showMetadata=yes&properties=metadata,tags&clipGeometry=false"
Expand Down Expand Up @@ -1833,7 +1833,7 @@ Get the latest change of constructions in a certain area of the Bahnstadt in Hei
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"metadata" : {
"description" : "Latest contributions as GeoJSON features.",
"requestUrl" : "https://api.ohsome.org/v1/contributions/latest/geometry?bboxes=8.6644159,49.401099,8.6663353,49.4027195&filter=landuse=construction%20and%20type:way&time=2020-06-29,2014-07-01&showMetadata=yes&properties=metadata,tags&clipGeometry=false"
Expand Down Expand Up @@ -1918,7 +1918,7 @@ Get metadata of the underlying OSHDB data
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"timeout": 600.0,
"extractRegion" : {
"spatialExtent" : {
Expand All @@ -1940,7 +1940,7 @@ Get metadata of the underlying OSHDB data
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"extractRegion" : {
"spatialExtent" : {
"type" : "Polygon",
Expand All @@ -1961,7 +1961,7 @@ Get metadata of the underlying OSHDB data
"url" : "https://ohsome.org/copyrights",
"text" : "© OpenStreetMap contributors"
},
"apiVersion" : "1.3.1",
"apiVersion" : "1.3.2",
"extractRegion" : {
"spatialExtent" : {
"type" : "Polygon",
Expand Down

0 comments on commit c52d5f8

Please sign in to comment.