Skip to content

Commit

Permalink
docs(config): use jsonpath for options parameter headings
Browse files Browse the repository at this point in the history
  • Loading branch information
TheGreatRefrigerator committed Feb 6, 2024
1 parent bf28fa3 commit 76a62cc
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/api-reference/endpoints/directions/routing-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@ For structure refer to the [examples](#examples).

## Available parameters

### `avoid_borders`
### `options.avoid_borders`
String value specifying which borders to avoid. Only for **`driving-*`** profiles.

| Value | Description |
|----------------|----------------------------------------------|
| `"all"` | for no border crossing |
| `"controlled"` | cross open borders but avoid controlled ones |

### `avoid_countries`
### `options.avoid_countries`
An integer array of country ids to exclude from routing with **`driving-*`** profiles. Can be used together with `"avoid_borders": "controlled"`.
The list of countries and application examples can be found in the [country list](../../../technical-details/country-list.md).

`"[11,193]"` would exclude Austria and Switzerland.

### `avoid_features`
### `options.avoid_features`
A string array of features to avoid. The available features are :

| Feature | Available for |
Expand All @@ -33,13 +33,13 @@ A string array of features to avoid. The available features are :
| `fords` | driving-\*, cycling-\*, foot-\* |
| `steps` | cycling-\*, foot-\*, wheelchair |

### `avoid_polygons`
### `options.avoid_polygons`
Comprises areas to be avoided for the route. Formatted as [geojson polygon](https://datatracker.ietf.org/doc/html/rfc7946#appendix-A.3) or [geojson multipolygon](https://datatracker.ietf.org/doc/html/rfc7946#appendix-A.6).

### `profile_params`
### `options.profile_params`
An object of additional routing parameters for all profiles except `driving-car`:

#### `weightings`
#### `options.profile_params.weightings`
Weightings will prioritize specified factors over the shortest path.
The value is an object that can have the following properties:

Expand Down Expand Up @@ -67,7 +67,7 @@ The value is an object that can have the following properties:
| `0` | normal routing |
| `1` | prefer quiet ways over a shorter route |

#### `restrictions`
#### `options.profile_params.restrictions`

[//]: # (see RequestProfileParamsRestrictions)

Expand Down Expand Up @@ -95,7 +95,7 @@ An object specifying restrictions for `cycling-*`, `driving-hgv` or `wheelchair`
| `maximum_incline` | Integer | Specifies the maximum incline as a percentage. `3`, `6`(default), `10`, `15` or `any`. |
| `minimum_width` | Number | Specifies the minimum width of a road in meters. |

### `round-trip`
### `options.round-trip`

An object with specifications of a round-trip:

Expand All @@ -105,7 +105,7 @@ An object with specifications of a round-trip:
| `points` | Integer | The number of points to use on the route. Larger values create more circular routes. |
| `seed` | Integer | A seed to use for adding randomisation to the overall direction of the generated route (optional). |

### `vehicle_type`
### `options.vehicle_type`
For `profile=driving-hgv` only.
It is needed for **vehicle restrictions** to work (see [tag filtering](/technical-details/tag-filtering.md#driving-hgv)).
Possible values:
Expand Down

0 comments on commit 76a62cc

Please sign in to comment.