Skip to content

Commit

Permalink
adapting changelog, readme links and docs examples (#95)
Browse files Browse the repository at this point in the history
for new 1.3.0 release
  • Loading branch information
FabiKo117 authored Jan 15, 2021
1 parent cfde0b7 commit 6bc224e
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 45 deletions.
12 changes: 10 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
## current master
## 1.3.0

### Prominent Changes

* update OSHDB to version 0.6.0 ([#86])
* returned values of `length`, `area` and `perimeter` requests are more precise now: The previously used formulas could be off by a few of % in some cases, now all returned values are within half a percent from the real value. ([OSHDB#193])
* adjusted unit tests accordingly, from now on allowing up to 0.5% discrepancy in all affected tests
* improved performance of `groupBy/boundary` requests ([OSHDB#272]) and processing of complex multipolygon relations ([OSHDB#249] and [OSHDB#287])

### Bug Fixes

* delombok code to enable working javadoc ([#90])

### Other Changes

* data extraction: escape tags with `@` characters ([#40])
* extend info on response parameters ([#73])
* delombok code to enable working javadoc ([#90])

[#40]: https://github.com/GIScience/ohsome-api/issues/40
[#73]: https://github.com/GIScience/ohsome-api/pull/73
Expand Down
8 changes: 4 additions & 4 deletions README.md
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.2.3](https://github.com/GIScience/ohsome-api/releases/tag/1.2.3). 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.0](https://github.com/GIScience/ohsome-api/releases/tag/1.3.0). 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.2.3.jar --database.db=C:/path-to-your-data/ba-wue.oshdb`
* keytables not included: `java -jar target/ohsome-api-1.2.3.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.0.jar --database.db=C:/path-to-your-data/ba-wue.oshdb`
* keytables not included: `java -jar target/ohsome-api-1.3.0.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.2.3",
"apiVersion": "1.3.0",
"metadata": {
"executionTime": 858,
"description": "Total length of items in meters.",
Expand Down
Loading

0 comments on commit 6bc224e

Please sign in to comment.