Skip to content

Commit

Permalink
release notes for 1.3.1
Browse files Browse the repository at this point in the history
  • Loading branch information
tyrasd committed Jan 22, 2021
1 parent dc20f91 commit c256322
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 44 deletions.
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,12 @@

### Bug Fixes

* fix crash when `elementsFullHistory` requests use the `filter` parameter ([#97])
* fix a bug where `groupBy/boundary` requests do ignore a given `filter` ([#99])
* update to OSHDB version 0.6.2, fixing a crash when building certain invalid multipolygon relations ([OSHDB#334])

[#97]: https://github.com/GIScience/ohsome-api/pull/97
[#99]: https://github.com/GIScience/ohsome-api/issues/99
[OSHDB#334]: https://github.com/GIScience/oshdb/issues/334


Expand Down Expand Up @@ -44,6 +48,8 @@

## 1.2.2

### Bug Fixes

* provide contributions response as a downloadable file ([#78])

[#78]: https://github.com/GIScience/ohsome-api/pull/78
Expand All @@ -60,7 +66,7 @@

## 1.2.0

### Prominent Changes
### Prominent Changes

* several improvements to the docs (e.g. [#49] and partially in [#34])
* upgrade to ohsome-filter 1.3 ([#62])
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.3.0](https://github.com/GIScience/ohsome-api/releases/tag/1.3.0). 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.1](https://github.com/GIScience/ohsome-api/releases/tag/1.3.1). 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.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`
* 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`

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.0",
"apiVersion": "1.3.1",
"metadata": {
"executionTime": 858,
"description": "Total length of items in meters.",
Expand Down
Loading

0 comments on commit c256322

Please sign in to comment.