Skip to content

Commit

Permalink
docs: apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Jakob Schnell <[email protected]>
  • Loading branch information
aoles and koebi committed Sep 27, 2024
1 parent 2aef320 commit 3006b72
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/api-reference/endpoints/directions/routing-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The `options` parameter is a JSON object, multiple of the here mentioned paramet
For structure refer to the [examples](#examples).

::: warning
Some of the options below rely on auxiliary data included on the graph, see [External storages](../../../run-instance/configuration/ors/engine/profiles.md#ext_storages)
Some of the options below rely on auxiliary data included in the graph, see [External storages](../../../run-instance/configuration/ors/engine/profiles.md#ext_storages)
:::

## Available parameters
Expand Down
5 changes: 2 additions & 3 deletions docs/run-instance/configuration/ors/engine/profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,7 @@ Properties beneath `ors.engine.profiles.*.execution.methods.core`:
For each profile it can be defined which auxiliary metadata should be included in the graph.
This information is made available as `extra_info` in a routing response.
Additionally, data from `WayCategory` and `Tollways` is being used to filter out certain roads via
[`avoid_features`](../../../../api-reference/endpoints/directions/routing-options.md#options-avoid-features) api query
parameter, and `Borders` is necessary for the functionality behind [`avoid_borders`](../../../../api-reference/endpoints/directions/routing-options.md#options-avoid-borders)
the [`avoid_features`](../../../../api-reference/endpoints/directions/routing-options.md#options-avoid-features) query parameter, and `Borders` is necessary for the functionality behind [`avoid_borders`](../../../../api-reference/endpoints/directions/routing-options.md#options-avoid-borders)
and [`avoid_countries`](directions/routing-options#options-avoid-countries) query parameters.

To do so, add a key from the list below.
Expand All @@ -178,7 +177,7 @@ Properties beneath `ors.engine.profiles.*.ext_storages`:
| WayCategory | object | Returns the way category in the route response, compatible with any profile type | |
| WaySurfaceType | object | Returns the way surface in the route response, compatible with any profile type | |
| Tollways | object | Returns way tolls in the route response, compatible with driving profiles | |
| HillIndex | object | Returns the ascent/descent in the route response, sompatible with any profile type | |
| HillIndex | object | Returns the ascent/descent in the route response, compatible with any profile type | |
| TrailDifficulty | object | Returns the trail difficulty in the route response, compatible with profile-hiking | |
| RoadAccessRestrictions | object | RoadAccessRestrictions are where roads are restricted to certain vehicles to certain circumstances, e.g. access=destination. | [RoadAccessRestrictions](#roadaccessrestrictions) |
| Wheelchair | object | Compatible for wheelchair | [Wheelchair](#wheelchair) |
Expand Down

0 comments on commit 3006b72

Please sign in to comment.