Skip to content

Commit

Permalink
release v1.10.3
Browse files Browse the repository at this point in the history
  • Loading branch information
tyrasd committed Jun 28, 2024
2 parents 397c0c8 + eb42115 commit 89d8422
Show file tree
Hide file tree
Showing 10 changed files with 210 additions and 149 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A clear and concise description of what the bug is.

### General Information
Please include the following general information about the issue and list any additional steps needed to reproduce the bug.
- Version of the ohsome API [e.g. `1.10.0`]
- Version of the ohsome API [e.g. `1.10.3`]
- Which API instance was requested [e.g. remote instance at `https://api.ohsome.org/v1`, local instance with an h2 file or connected to the cluster, etc.]
- Affected endpoint(s) [e.g. /contributions/count]
- URL of your request (and request body if applicable)
Expand Down
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
Changelog
=========

## 1.10.3

### Bug Fixes
* Fix contributions extractions endpoints which were missing _deletion_ contributions that were later reverted ([#324])

### Other
* Fix filter documentation ([#326])
* Upgrade to OSHDB [v1.2.3](https://github.com/GIScience/oshdb/blob/main/CHANGELOG.md#123)

[#324]: https://github.com/GIScience/ohsome-api/pull/324
[#326]: https://github.com/GIScience/ohsome-api/pull/326


## 1.10.2

### Bug Fixes
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.heigit.ohsome/ohsome-api/badge.svg)](https://search.maven.org/artifact/org.heigit.ohsome/ohsome-api)
[![LICENSE](https://img.shields.io/github/license/GIScience/ohsome-api)](LICENSE)
[![API docs](https://img.shields.io/badge/API-docs-blue.svg)](https://docs.ohsome.org/ohsome-api/stable)
[![JavaDocs](https://img.shields.io/badge/Java-docs-blue.svg)](https://docs.ohsome.org/java/ohsome-api)
[![javadoc](https://javadoc.io/badge2/org.heigit.ohsome/ohsome-api/javadoc.svg)](https://javadoc.io/doc/org.heigit.ohsome/ohsome-api)
[![status: active](https://github.com/GIScience/badges/raw/master/status/active.svg)](https://github.com/GIScience/badges#active)

The ohsome API is a generic web API for in-depth analysis of OpenStreetMap (OSM) data with a focus on its 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.10.2](https://github.com/GIScience/ohsome-api/releases/tag/1.10.2). 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.10.3](https://github.com/GIScience/ohsome-api/releases/tag/1.10.3). Developed and maintained by [HeiGIT](https://heigit.org/).

## Using the ohsome API

Expand Down Expand Up @@ -39,7 +39,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.10.2",
"apiVersion": "1.10.3",
"metadata": {
"executionTime": 858,
"description": "Total length of items in meters.",
Expand Down Expand Up @@ -122,8 +122,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.10.2.jar --database.db=C:/path-to-your-data/ba-wue.oshdb`
* keytables not included: `java -jar target/ohsome-api-1.10.2.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.10.3.jar --database.db=C:/path-to-your-data/ba-wue.oshdb`
* keytables not included: `java -jar target/ohsome-api-1.10.3.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 All @@ -133,7 +133,7 @@ Now you should have a running local API, which is ready for receiving requests u
* to disable multithreading: `--database.multithreading=false`
* if you want to run the maven project in your IDE, you need to set the paths to your data in the run configurations
* in Eclipse: *Run As --> Run Configurations --> (x)= Arguments --> Program arguments: 'enter the parameters here'*
* if you want to get information about the code directly, you can access the [Javadoc](https://docs.ohsome.org/java/ohsome-api/), which gets updated daily.
* if you want to get information about the code directly, you can access the [Javadoc](https://javadoc.io/doc/org.heigit.ohsome/ohsome-api), which gets updated daily.

## Testing

Expand Down
Loading

0 comments on commit 89d8422

Please sign in to comment.