Skip to content

Commit

Permalink
Merge branch 'main' into fix/td_routing_with_avoid_areas
Browse files Browse the repository at this point in the history
  • Loading branch information
takb authored Oct 28, 2024
2 parents 801c9b9 + 8e58bfb commit feb401f
Show file tree
Hide file tree
Showing 9 changed files with 1,268 additions and 312 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ RELEASING:
7. Adding the corresponding tag is done when releasing via GitHub.
-->
## [unreleased]
### Changed
- update docs dependency: VitePress ([#1872](https://github.com/GIScience/openrouteservice/pull/1872))
- adjust documentation for export endpoint ([#1872](https://github.com/GIScience/openrouteservice/pull/1872))

### Fixed
- do not enforce a time-dependent routing algorithm unless the weighting requires it ([#1865](https://github.com/GIScience/openrouteservice/pull/1865))
- failing queries that combined departure/arrival parameters with avoid polygons ([#1871](https://github.com/GIScience/openrouteservice/pull/1871))
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ and provides global spatial services by consuming user-generated and collaborati
* [Isochrones Service](https://giscience.github.io/openrouteservice/api-reference/endpoints/isochrones/): Obtain areas of reachability from given locations
* [Matrix Service](https://giscience.github.io/openrouteservice/api-reference/endpoints/matrix/): Obtain one-to-many, many-to-one and many-to-many matrices for time and distance
* [Snapping Service](https://giscience.github.io/openrouteservice/api-reference/endpoints/snapping/): Snap coordinates to the road network
* [Export Service](https://giscience.github.io/openrouteservice/api-reference/endpoints/export/)¹: Export the base graph for different modes of transport
* [Export Service](https://giscience.github.io/openrouteservice/api-reference/endpoints/export/): Export the base graph for different modes of transport
* [Health Endpoint](https://giscience.github.io/openrouteservice/api-reference/endpoints/health/)¹: Get information on the health of the running openrouteservice instance
* [Status Endpoint](https://giscience.github.io/openrouteservice/api-reference/endpoints/status/)¹: Get information on the status of the openrouteservice instance

¹) **Export, Health and Status Endpoint are not available in our public openrouteservice API aka "live API"!**
¹) **Health and Status Endpoint are not available in our public openrouteservice API aka "live API"!**
You can use them by running your own instance of openrouteservice.

And to avoid any misunderstandings, it should also be mentioned at this point that our live API provides several other endpoints
Expand Down
2 changes: 1 addition & 1 deletion docs/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export default defineConfig({
{text: 'Isochrones', link: '/api-reference/endpoints/isochrones/'},
{text: 'Matrix', link: '/api-reference/endpoints/matrix/'},
{text: 'Snapping', link: '/api-reference/endpoints/snapping/'},
{text: 'Export (not live)', link: '/api-reference/endpoints/export/'},
{text: 'Export', link: '/api-reference/endpoints/export/'},
{text: 'Health (not live)', link: '/api-reference/endpoints/health/'},
{text: 'Status (not live)', link: '/api-reference/endpoints/status/'},
{text: 'POI', link: '/api-reference/endpoints/poi/'},
Expand Down
6 changes: 0 additions & 6 deletions docs/api-reference/endpoints/export/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
# Export Endpoint

:::warning NOTE
This endpoint is not available in the public API,
but you can use it when running an own instance of openrouteservice.
You can easily create requests with the [swagger-ui](../../index.md#swagger-ui).
:::

Export the base graph for different modes of transport.

In the request, the desired routing profile is specified as the last path parameter,
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/endpoints/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ Openrouteservice offers a set of endpoints for different spatial purposes:
* [Isochrones Service](isochrones/index.md): Obtain areas of reachability from given locations
* [Matrix Service](matrix/index.md): Obtain one-to-many, many-to-one and many-to-many matrices for time and distance
* [Snapping Service](snapping/index.md): Snap coordinates to the road network
* [Export Service](export/index.md): Export the base graph for different modes of transport

## Technical Endpoints

Furthermore, there are technical endpoints that are :warning: _not available_ in our live API:

* [Export Service](export/index.md): Export the base graph for different modes of transport
* [Health Service](health/index.md): Get information on the health of the running openrouteservice instance
* [Status Service](status/index.md): Get information on the status of the openrouteservice instance

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The following chapter [Endpoints](endpoints/index.md) contains explanation and e
be explained sufficiently in the API Playground.
Here, the single endpoints are not completely covered with all their request parameters etc.
But on the other hand, there is also information about endpoints that are not available in our live API,
but e.g. on instances you run or host yourself like [Export](endpoints/export/index.md), [Health](endpoints/health/index.md) and [Status](endpoints/status/index.md).
but e.g. on instances you run or host yourself like [Health](endpoints/health/index.md) and [Status](endpoints/status/index.md).

If you are developing ORS or running your own instance, you might benefit from the included [Swagger-UI](#swagger-ui).

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The fastest way to get to the info you are looking for is **the search bar above
* [Isochrones](api-reference/endpoints/isochrones/index.md) endpoint
* [Matrix](api-reference/endpoints/matrix/index.md) endpoint
* [Snapping](api-reference/endpoints/snapping/index.md) endpoint
* [Export](api-reference/endpoints/export/index.md) endpoint _(not available in our live API)_
* [Export](api-reference/endpoints/export/index.md) endpoint
* [Run ORS instance](run-instance/index.md) contains all info about setting up the ors locally.
* [System requirements](run-instance/system-requirements)
* [Data](run-instance/data) used by openrouteservice
Expand Down
Loading

0 comments on commit feb401f

Please sign in to comment.