CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog

Unreleased

6.8.0 - 2022-10-10

Added

• backend documentation about encoded polylines without elevation data (#1094)
• python code on decoding polylines including elevation data
• Czech language support (thanks to trendspotter for the translation)
• Pedestrian and hiking support for time dependent routing
• Esperanto language support (thanks to ecxod for the translation)
• Romanian language support (thanks to ecxod for the translation)
• link to YouTube docker setup guide to docs (thanks to SyntaxByte)
• prototype of generic CSV-based routing to be used for heat stress
• Shadow Routing

Fixed

• allow bridleways with bicycle=yes for bike profiles (#1167)
• improved log file settings error message (#1110)
• Dockerfile now creates intermediate directories if they are not present (#1109)
• internal properties of IsochronesRequest model not ignored for swagger file generation
• remove non-parameter metricsStrings from API documentation (#756)
• set default vehicle type for HGV profile (#816)
• added missing matchTraffic override (#1133)
• typo in docker documentation
• foot routing via waterway=lock_gate (#1177)
• graph builder for routing over open areas (#1186)
• address data alignment issue in hgv extended storage which occasionally caused ArrayIndexOutOfBoundsException (#1181)
• fix minor spelling errors in Places.md (#1196)
• address matrix failures for HGV profile (#1198)

6.7.1 - 2022-10-05

Added

• optional routing profile parameter force_turn_costs (#1220)

6.7.0 - 2022-01-04

Added

• add core matrix algorithm
• add new workflow to build and publish the docker image (#1035)
• optional encoder_options for wheelchair routing: speed factors for ways classified as problematic/preferred (#980)
• optional routing API parameters allow_unsuitable / surface_quality_known for wheelchair profile (#980)
• Docs folder aggregating documentation from openrouteservice-docs, wiki, README.md and docker-subfolder
• ors-config.json as default ors config option, which will replace app.config (#1017)
• system property ors_config which will replace the ors_app_config property (#1017)
• environment variable ORS_CONFIG which will replace the ORS_APP_CONFIG one (#1017)
• ors config reading priority
  1. System property ors_conf > ors_app_conf
  2. Environment variable pointing to file in class path ORS_CONF > ORS_APP_CONF
  3. File in class path ors-config.json > app.config
  4. Error if none of the above is specified.
• links and info about docker setup to backend documentation
• minimum_width to wheelchair routing options documentation (#1080)

Changed

• Update tomcat version used by docker setup (#1022)
• Refactored smoothness-type-parameter into Enum (#1007)
• Improved wheelchair routing (#980)
• Error message when point is not found even though radius:-1 is specified (#979)
• Formatting of tag filtering
• test config format and filetype to JSON
• docker APP_CONFIG argument to ORS_CONFIG (#1017)
• default minimum surface-type for wheelchair to sett (#1059)
• Default road surface value is now "paved" rather than "asphalt" (#711)
• error_codes.md-documentation now with rest of backend docs (#1069)
• remove duplicated code in *RequestHandlers (#1067)
• extended list of places-request and -response categories

Deprecated

• ors_app_config system property (#1017)
• app.config ors configuration file name (#1017)
• ORS_APP_CONF environment variable (#1017)

Fixed

• Errors in travel speed explanation
• Failing assertion with CALT routing (#1047)
• Improve travel time estimation for ferry routes (#1037)
• Resolving of HGV vehicle type-specific access restrictions does not require vehicle parameters to be set (#1006)

6.6.4 - 2022-01-03

Fixed

• update log4j to version 2.17.1
• switch to GH fork version v0.13.15-4

6.6.3 - 2021-12-15

Fixed

• switch to GH fork version v0.13.15-3 to address updated log4j version

6.6.2 - 2021-12-15

Fixed

• updated log4j version to 2.16.0 which addresses CVE-2021-44228

6.6.1 - 2021-07-05

Fixed

• made ORSKafkaConsumerInitContextListener non-blocking
• Initialize edge centrality scores only for edges fully within bbox
• References to old documentation now point to rendered version of new docs

6.6.0 - 2021-06-08

Added

• Accept single value and array of length 1 as radiuses-parameter (#923)
• Useful error message for isochrone range/interval mismatches

Changed

• Coordinate precision of locations in maneuver-object to 6 decimal places

Fixed

• Correct travel time computation for routes involving time-dependent speeds regardless of the weighting used (#956)
• Compatibility of user provided maximum speed limit with HGV routing profile (#955)
• Clarified "Point not found"-Error message (#922)
• Correct isochrones response documentation (#670)
• Rare bug where virtual edges are used to construct geometry of isochrone. Check whether edge is virtual before using it.
• Duplicate parameter in centrality docs due to spring reading getters for docs
• Bug where supercell subcell ids were out of bounds in storage

6.5.0 - 2021-05-17

Added

• Time-dependent core-based routing algorithms
• Option to disable edge-based routing in core for a single weighting (#928)

Changed

• Speed values falling below encoder's resolution are consequently stored as lowest possible non-zero value rather than being rounded to zero together with setting access to the corresponding edges to false (#944)

Fixed

• Do not consider ill-defined "maxspeed = 0" OSM tags (#940)
• Use JSON definitions of country-specific speed limits (#939)
• Config file parameter to set the number of active landmarks for core routing (#930)
• Make sure A* with beeline approximation is used as default fallback algorithm (#926)
• Prioritize graph build date over data date in routing request (#925)
• Correct package declaration of BoundingBoxFactoryTest (#933)
• Some corrections to Hungarian language support (thanks to debyos)

6.4.4 - 2021-08-30

Changed

• URL for repo.heigit.org to HTTPS

6.4.3 - 2021-04-28

Changed

• Reduced unnecessary warning messages caused by spring output stream handling (#899

Fixed

• Changed fast isochrone calculation behavior for multiple ranges

6.4.2 - 2021-04-21

Added

• Allow to disable OSM conditional access and speed encoders via parameter in config file
• Turkish language support (thanks to kucar17 for the translation)

Changed

• app.config.sample HGV profile has now same settings regarding speed calculation as public API (#806)

Fixed

• Concurrency bug in core edge filters which caused crashes during CALT graph preparation (#905)
• Fixed isochrones range documentation (#882)
• Updated installation instructions and usage to reflect v2 api (#744)
• Fixed isochrones algorithm selection for location_type parameter (#676)
• Updated link to client translations in readme

6.4.1 - 2021-03-31

Fixed

• Fixed incorrect matrix response documentation (#873)
• Fixed incorrect indexing of waypoints for consecutive identical coordinates (#762)
• Changed isochrone polygon calculation to use more buffering

6.4.0 - 2021-03-26

Added

• API endpoint "centrality" to calculate betweenness centrality values for nodes inside a given bounding box. Centrality is calculated using Brandes' algorithm.
• Support for turn restrictions with core-based routing algorithms

Changed

• Use Querygraph and virtual nodes for isochrone calculation in the same manner as in routing
• Remove Isochrones v1 api tests

Fixed

• Fixed calculation of route distance limits with skipped segments (#814)
• Fixed missing segment distance and duration (#695)
• Fixed no response when asking for isochrone intersections (#675)
• Fixed continue_straight option with no bearing on CH-enabled profiles

6.3.7 - 2021-08-30

Changed

• URL for repo.heigit.org to HTTPS

6.3.6 - 2021-02-02

Fixed

• Expand coordinates of all previous limit polygons before adding to new builder to prevent break-in on long polygon edges

6.3.5 - 2021-01-28

Added

• Output run file to signal completion of graph building/loading at init time

Fixed

• Define behavior for first container start with existing app.config

6.3.4 - 2021-01-19

Changed

• Overhaul of Contour creation for fast isochrones. Fixing unexpected behaviour for border edges.

6.3.3 - 2021-01-15

Fixed

• Updated CGIAR URL in GH (see GH fork #35)

6.3.2 - 2020-12-14

Added

• Prototype of time-dependent routing with A*, which takes into account OSM conditional access restrictions and speed limits
• Japanese language support (#811, thanks to higa4 for the translation)

Changed

• Added performance improvement for fast isochrones in active cell calculation

Fixed

• Stabilize geometry for small isochrones with small intervals
• Updated dependencies

6.3.1 - 2020-10-20

Fixed

• Updated documentation for running in Docker (#798)
• Handle invalid combination of HillIndexStorage without elevation (#683)
• Enabled turning off elevation data handling for profiles
• Fixed a bug in fast isochrones preprocessing

6.3.0 - 2020-09-14

Added

• New fast isochrone algorithm based on preprocessed data

Fixed

• Fixed handling of invalid extra info requests (#795)

[6.2.2] - 2021-08-30

Changed

• URL for repo.heigit.org to HTTPS

6.2.1 - 2020-08-13

Added

• Check whether routing points are within different countries before routing and break if they are and all borders should be avoided

Fixed

• Updated Docker process to use Java 11 (#777)
• Correctly resolve routing profile categories when initializing core edge filters in preprocessing (#785)

6.2.0 - 2020-07-15

Added

• New maximum_speed parameter to the driving profiles of the directions API, for specifying a speed limit, above a certain threshold set in the config file.
• Polish translation (#690)
• Configuration parameter to enable elevation smoothing (#725)

Fixed

• Fixed fallback to dynamic routing methods if bearings parameter set (#702)
• Enable elevation interpolation for bridges and tunnels (#685)
• Fixed erroneous duration computation of soft weightings such as green and quiet weightings
• Enable recommended weighting for hgv profile and robustify the matching of routing algorithm to the request (#755)

Changed

• Improve recommended weighting for cycling and walking profiles (#665)
• Restructure AdditionWeighting
• Upgrade to Java 11

Deprecated

• Use recommended weighting instead of fastest (#763)

[6.1.3] - 2021-09-03

Changed

• removed unused dependency

[6.1.2] - 2021-08-30

Changed

• URL for repo.heigit.org to HTTPS

6.1.1 - 2020-06-02

Added

• Configuration option to read elevation tags from pbf data
• Configuration parameters to set location index resolution and the maximum number of iterations in coordinates lookup (#712)

Fixed

• Removing maintenance burden of two app.config files for native and docker setup (#742)
• Allowed the usage of green and noise in extra info parameter (#688)
• Fixed extra info grouping with alternative routes (#681)
• Fixed way surface/type encoding issue (#677)
• Querying shortest weighting can now use CH shortest preparation if available
• Roads tagged with destination access are penalized the same way for hgv as for car (#525)
• JAVA_OPTS and CATALINA_OPTS were not correctly set in Docker setup (#696)
• Suitability values in extra info are not underestimated (#722)
• Fixed problem with incorrect way point values being referenced for round trip (#724)
• Fixed oneway handling for bike routing (#389) [by integrating GH PR #1769 of BikeCommonFlagEncoder]

Changed

• Refactor the algorithm selection process
• Use ALT/A* Beeline for roundtrips. Enable Core-ALT-only for pedestrian profile.
• Enable CH and Core-ALT preprocessing with recommended weighting for all profiles.
• Refactor wheelchair builder
• Running a Docker container will now create a app.config on the host machine, so it's now usable from Dockerhub

6.1.0 - 2020-03-06

Added

• Hebrew language support (thanks to citizen-dror for the translation)
• Configuration options to limit avoid_polygon routing option by area and/or extent (#629)
• Configuration options to limit count parameter and distance when using alternative routes algorithm (#651)
• Configuration options to limit distance when using round trip routing algorithm (#658)
• Enable CALT routing algorithm for cycling profiles (#662)
• Configuration options to send conditional system messages with API responses (#664)

Fixed

• more consistent language API parameters (ISO 639-1 codes & IETF tags)
• Nepali language support can be selected through API
• Fixed invalid JSON and GeoJSON when including elevation (#640)
• Added graph date for isochrones and matrix service and fixed the 0 output (#648)
• Fixed memory issue at graph building (#659)
• Improve way category assignment for ferry connections (#678)

Changed

• improve french translation (directions)
• Make Docker setup more flexible wrt customizations (#627)
• Updated GraphHopper to newer version (0.13)
• Give more details to green and quiet routing API descriptions (#632)

[6.0.2] - 2021-09-03

Changed

• removed unused dependency

[6.0.1] - 2021-08-30

Changed

• URL for repo.heigit.org to HTTPS

6.0.0 - 2019-12-03

Added

• Indonesian Translation Language
• Allow specifying a config file with -Dors_app_config= anywhere on the filesystem
• Enabled round trip routing (#391)
• Enabled aternative routes in API (#377)
• Added information to the response about when graphs were last built for the profile (#542)
• Added default value for maximum snapping radius

Fixed

• Pass JAVA_OPTS and CATALINA_OPTS as Docker build arguments (#587)
• Encoding of waytype ferry (#573)
• Refactored Core-ALT algorithm so that it can be used globally

Changed

• Updated GraphHopper to newer version (0.12)
• Reworked flag encoders to use the methods provided by GraphHopper 0.12
• Renamed packages to follow naming conventions
• Cleanup of a number of code files

Deprecated

• Removed geocoding endpoint and code
• Removed accessibilty endpoint and code
• Removed Brotil encoder from servlet filter

5.0.2 - 2019-07-29

Added

• Added a gpx schema validator into the api-tests, testing all gpx outputs while fixing the bug from (#496)
• Added information for countries a route traverses (#349)
• Added scanning of master with sonarcloud (2019-11-29)

Fixed

• isochrone reachfactor gives now more realistic results (#325)
• Fixed the wrong gpx header for api v2 (#496)
• Make sure external storages contain entries for all edge IDs (#535)
• Check if BordersStorage exists before calling it in AvoidBordersCoreEdgeFilter
• Take into account shortcut direction in LM selection weighting (#550)
• Updated Matrix api v2 response to correctly display sources (#560)
• Check for null pointer in LM selection weighting (#550)
• Use commas rather than pipes for weighting options in app.config.sample (#564)
• Update point references when point is not found for routing (#567)
• Fix concurrency issues when requesting extra info in routing (#571)

Changed

• Moved walking and hiking flag encoders to the ORS core system (#440)
• Remove route optimization code (#499)
• Reduced distance for neighbourhood point search in isochrones when small isochrones are generated (#494)
• Removed obsolete storages (#536)
• Refactor fallback to preprocessing-independent algorithm for certain routing request params
• Removed some landmark sets as default from app.config.sample

5.0.1 - 2019-04-08

Added

• CALT routing algorithm - Not for production (Issue #433)
• Makes docker and docker-compose deployment of openrouteservice more customizable (Issue #434)
• Add the possibility to predefine standard maximum search radii in general and for each used profile in the config file (Issue #418)

Fixed

• fix the GPX output of the APIv2. It was broken since release of api v2. (Issue #533)
• fix SRTM URL in GH fork (#394)
• fix classpath issues for resources, Windows builds now (#489)
• isochrone geojson bbox now format compliant (#493)
• v2 isochrones now respects max_locations in app.config (#482)
• Updated documentation to reflect correct isochrone smoothing algorithm (Issue #471)
• Enable > 2 waypoints when geometry_simplify=true (#457)
• Made it so that the wheelchair profile only goes over bridleways if they are set to be foot or wheelchair accessible (#415)
• Fixed the build fail bug when routing_name was set in the config file (#424)
• Fixed problem with border crossings where the way crosses three polygons (#491)

Changed

• Updated pom to always build ors.war (Issue #432)
• Replace usage of packages incompatible with Java >8 (#474)
• Updated Matrix to have a maximum number of routes to calculate rather than locations (#518)

Deprecated

• Removed the code that was inserted for the prototype traffic weightings as it was not used and made GH updates more complicated.

5.0.0 - 2019-02-25

Added

• Updated api code to use the Spring framework, with the v2 api being added (Issue #233)
• Added support for ISO 3166-1 Alpha-2 / Alpha-3 codes for routing directions option avoid_countries (Issue #195)
• Added support for free hand route option/ skip segments (Issue #167)
• Added check on matrix service to make sure that the requested locations are within the bounding area of the graph (Issue #408)
• Makes docker and docker-compose deployment of openrouteservice more customizable (Issue #434)
• Added support for GH alternative_route algorithm (Issue #377)

Fixed

• Fixed geometry_simplify parameter, which had no effect before. geometry_simplify is incompatible with extra_info (#381)

Changed

• Updated rural speed limit in France to be 80km/h (Issue #355)
• Modified smoothing and buffer distances for small isochrones, aswell as other fixes for smaller isochrones (Issue #382)
• Updated pom to use correct opengeo repo and reordered so this is the last in the list, and use latest ORS-Graphhopper library (Issue #398)
• Added /directions as an endpoint for routing (Issue #384)
• Removed the following avoid features: pavedroads, unpavedroads, tunnels, tracks and hills, as well as the option to set maximum speed; for cycling and walking profiles the option to specify difficulty settings such as fitness level and maximum steepness (issue #396)
• Updated pom to always build ors.war (Issue #432)

4.7.2 - 2018-12-10

Added

• Added Unit Tests for RouteSearchParameters.class() (while fixing Issue #291)
• Added ability to return warning messages in the route response which can be used for showing info to a user when warning criteria have been met based on extended storages.
• Added a RoadAccessRestrictions extended storage as a warning extended storage for when a route goes of ways with access restrictions (Issue #342)

Fixed

• If residential penalty reduces speed to <5, set it to 5
• Added a new ParameterValueException in RouteSearchParameters if the profile is driving-car and profile_params are set in the options (Issue #291)
• Fixed API Test to consider the new ParameterValueException (while fixing Issue #291)
• Improved range and resolution of values encoding dimension/weight road restrictions in order to properly resolve them when corresponding hgv parameters are set (fixes issue #263)
• Fixed empty BBox error if the route is located in the southern hemisphere (Issue #348)
• Take into account access restrictions specific to hgv subprofiles (fixes issue #235)
• Properly resolve all tolls, especially hgv-specific ones (fixes issue #358)
• Updated checks on pedestrian way filter for access restrictions

Changed

• Allowed access for cars and hgvs on access=destination roads (Issue #342)

4.7.1 - 2018-10-24

Added

Added instructions to readme for installing without Docker (Issue #272) Added area_units for isochrones API as units being misleading (Issue #272)

Fixed

• Area calculation for isochrones using metric crs (Issue #130)
• Decreases maximum peed for bike-regular for more realistic reachability scores (Issue #325)
• Fixes self intersecting polygons when requesting population for isochrones (Issue #297)
• Changes center in isochrones response to snapped edge coordinate on graph (Issue #336)
• Enable HGV axleload restriction (Issue #262)

Changed

• Changed app.config.sample for docker to consider split profiles (Issue #320)
• Changed minor information in pom.xml
• Updated API test starting coordinates to be on a road (Issue #328)

4.7.0 - 2018-10-10

Added

• Removed locations code as this will be handled by openpoiservice in the future (Issue #120)
• Removed Geocoding code as this will be handled by the geocoder service rather than within ORS
• Added smoothing option for isochrones (Issue #137)
• Added ExtraInfo storage for osm way id so that this information can be stored (and accessed) agianst the edges (Issue #217)
• Added a new GeometryUtility function and its unit test to calculate the bbox for a set of coordinates (Issue #241)
• Added support for elevation data above & and below the 60 deg N/S. When you run your own instance make sure that you specify the elevation_provider: multi (instead of just 'cgiar') (Issue #220)
• Added support to keep elevation source data over various path generation processes - add to your app.config: elevation_cache_clear: false
• Added support for new keep left/right turn instructions

Fixed

• Correct logic of determining vehicle type flags in heavy vehicle storage (Issue #211)
• Enable OSM "key:access" tag values to take effect for heavy vehicle profile (Issue #209)
• Fixed problem with avoid polygons excluding ways that should have been accepted (Issue #95)
• Updated code to remove merging of instructions as this resulted in missing important turn instructions (Issue #177)
• Added missing translations for arrival instructions (Issue #171)
• Updated code so that acceleration is taken into account when speeds are calculated for edges (Issue #178)
• Fixed the mising rte tag in gpx issue (Issue #196)
• Fixed the gpx validation errror (Issue #168)
• Added unit conversion so that isochrone response is in user specified unit (issue #91)
• Enabled the reporting of multiple missing points in error response (issue #246)
• Fixed wrong bounding box error (Issue #241)
• Fixed problem with mountain bike profile never using contraction hierarchies.

Changed

• Updated the internal graphhopper libraries from 0.9.x to 0.10.1 and reduced the number of custom implementations and features. This implies that some of the previous features is no longer available in this release of openrouteservice. Most of these adjustments are under the hood and will not be noticeable for anyone. Have said that there is of course one exception: You need to create a separate profile per vehicle. In previous versions it was possible to combine multiple vehicles (like bike, road bike, e-bike and mtb) into a single ors-profile - this is no longer possible. Instead you need to create one profile for bike, one for mtb one for road bike and so on.
• Updated/refactored road bike flagencoder to make it more suitable for road cycling enthusiasts. Please note, that the generated routs might not be compliant to the local regulations - specially when 'Biking trails are obligated to be use'
• Refactored some of the edge filters and cleaned up the code initializing them
• Updated the wheelchair profile to better handle restrictions such as width, kerb heights and instances where sidewalks are attached to roads. (Issue #162)
• Replaced "Sand" surface encoding with "Paving stone"
• Changed the bbox api test (Issue #241)
• Changed the way the bbox is calculated internally (Issue #241)
• Change the license from apache 2.0 to LGPL3 (PR #296)

Deprecated

• Removed references to locations and accessibilty services from web.xml (Issue #186)

4.5.1 - 2018-03-20

Fixed

• Fixed the parameters being the wrong way around in isochrones request when maximum range has been exceeded (Issue #126)
• Fixed the coordinate precision in the geojson export from 4 to 6 decimals (Issue #136)
• Fixed the instructions='false' error when exporting as geojson (Issue #138)
• Fixed missing summary in the geojson output (Issue #139)
• Fixed error when a high exit number for a roundabout is used in instructions (Issue #145)

Changed

• Updated error response code for routing when no route can be found between locations (Issue #144)
• Updated logging so that stack traces are only output when debug logging is enabled (Issue #148)
• Updated the error response for geocding when no address found (Issue #134)

4.5.0 - 2018-02-27

Added

• Functionality has been added to restrict routes so that they do not cross all borders, controlled borders, or the borders of specific countries (Issue #41)
• Added GeoJson export for routing exports (Issue #54)
• Added global export class to combine all exports there (Issue #123)
• Option to specify maximum locations for matrix request when using non-standard weightings (Issue #94)

Fixed

• Fix exception when roundabout exit is not correctly found (Issue #89)
• Option to specify maximum locations for matrix request when using non-standard weightings (Issue #94)
• Geocoder now returns a 404 response if no address is found for reverse geocoding (Issue #113)
• Fixed error codes (Issue #109)
• Correct querying of population statistics data for isochrones (Issue #106)

Changed

• RoutingProfile was changed to make sure whenever pop_total or pop_area is queried, both are present in the attributes (Issue #106)
• Response with a detour factor now uses "detourfactor" rather than "detour_factor" (Issue #61)
• Changed the gpx export to the new global export processor (Issue #123)

Deprecated

• getStatisticsOld | Connected to the old statistics library (Issue #106)
• geometryToWKB | Connected to the old statistics library (Issue #106)

4.4.2 - 2018-01-31

Added

• Ability to get routes in GPX format (Issue #8)
• Ability to read HGV tags from OSM Nodes (Issue #49)
• No need to add optimisation parameter in request (PR #87)
• Option to respond md5 of osm file used for graph generation (Issue #48)

Fixed

• Updated code to not use empty bearings when continue_straight=true is set (Issue #51)
• Fixed problem with HGV restrictions only being taken into account if less than three provided (Issue #75)
• RPHAST performance optimisations (Issue #64)
• Updated duration calculations for urban areas (Issue #44)
• Increase hikari pool size for db connections (PR #52)

4.4.1 - 2017-10-12

Added

• Ability to compute and flush graphs without holding them in memory.

Fixed

• Optionally define bearings for specific waypoints.

4.4.0 - 2017-10-09

Added

• Updated functional tests.
• Bearings parameter may be passed for cycling profiles.
• Radiuses parameter may be passed for cycling profiles.
• Continue forward parameter may be passed for cycling profiles.
• Considering OSM tag smoothness=impassable in routing.
• First prototype of statistics provider in isochrones added.

Fixed

• Remove tracking of the highest node in DownwardSearchEdgeFilter.
• Unable to find appropriate routing profile for optimized=true if not available.
• Possible Hash function in MultiTreeMetricsExtractor collision now removed.
• Minor speed up fix in ConcaveBallsIsochroneMapBuilder.
• Fix bug in RPHAST when location lies on a oneway road.
• Consider turn restrictions if optimized=false is passed.