Skip to content

Commit

Permalink
Merge branch 'master' into 1.8
Browse files Browse the repository at this point in the history
  • Loading branch information
tyrasd committed Feb 9, 2023
2 parents 51cb289 + dcd9653 commit 5810de5
Show file tree
Hide file tree
Showing 19 changed files with 452 additions and 237 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.5.0`]
- Version of the ohsome API [e.g. `1.8.0`]
- 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
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,21 @@
Changelog
=========

## 1.9.0-SNAPSHOT (current master)


## 1.8.1

### Bug Fixes
* Fix crash and incorrect output of `…/groupBy/tag` and `…/groupBy/key` endpoints when non-existing tag keys or values are used in a query ([#291])

### Documentation
* Complete documentation of ohsome filters ([#290])

[#290]: https://github.com/GIScience/ohsome-api/pull/290
[#291]: https://github.com/GIScience/ohsome-api/pull/291


## 1.8.0

### Breaking Changes
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

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.8.0](https://github.com/GIScience/ohsome-api/releases/tag/1.8.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.8.1](https://github.com/GIScience/ohsome-api/releases/tag/1.8.1). 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.8.0",
"apiVersion": "1.8.1",
"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.8.0.jar --database.db=C:/path-to-your-data/ba-wue.oshdb`
* keytables not included: `java -jar target/ohsome-api-1.8.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.8.1.jar --database.db=C:/path-to-your-data/ba-wue.oshdb`
* keytables not included: `java -jar target/ohsome-api-1.8.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
4 changes: 4 additions & 0 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
html.writer-html5 .rst-content table.docutils td > p, html.writer-html5 .rst-content table.docutils th > p {
/* this setting is changed in the theme for tables, but shouldn't change for us. */
line-height: 24px;
}
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

html_css_files = ['custom.css']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
Expand Down
Loading

0 comments on commit 5810de5

Please sign in to comment.