Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# CHANGELOG

## 3.0.2

ADDED:
- Valhalla route: optional `date_time` parameter, mapped to Valhalla `date_time` (`type = 1`, `value = <date_time>`)
- Valhalla isochrone: optional `date_time` parameter, mapped to Valhalla `date_time` (`type = 1`, `value = <date_time>`)

UPDATED:
- Valhalla multimodal profile is now exposed in sample capabilities/configuration

## 3.0.1

FIXED:
Expand Down
30 changes: 30 additions & 0 deletions documentation/apis/simple/1.0.0/api.json
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,17 @@
},
"example": "fastest"
},
{
"name": "date_time",
"in": "query",
"description": "Date et heure de départ pour le calcul multimodal Valhalla. Ce paramètre est optionnel et n'est pris en compte que pour les ressources Valhalla configurées en multimodal.",
"required": false,
"schema": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}$"
},
"example": "2026-07-03T08:30"
},
{
"name": "geometryFormat",
"in": "query",
Expand Down Expand Up @@ -550,6 +561,17 @@
},
"example": "départ"
},
{
"name": "date_time",
"in": "query",
"description": "Date et heure de départ pour le calcul multimodal Valhalla. Ce paramètre est optionnel et n'est pris en compte que pour les ressources Valhalla configurées en multimodal.",
"required": false,
"schema": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}$"
},
"example": "2026-07-03T08:30"
},
{
"name": "constraints",
"in": "query",
Expand Down Expand Up @@ -804,6 +826,10 @@
"optimization": {
"type": "string"
},
"date_time": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}$"
},
"constraints": {
"type": "array",
"items": {
Expand Down Expand Up @@ -888,6 +914,10 @@
"arrivé"
]
},
"date_time": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}$"
},
"constraints": {
"type": "array",
"items": {
Expand Down
22 changes: 13 additions & 9 deletions documentation/configuration/resources/valhalla.resource
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@
"defaultValueContent": "car",
"values": [
"car",
"pedestrian"
"pedestrian",
"multimodal"
]
},
{
Expand Down Expand Up @@ -83,6 +84,9 @@
"EPSG:2154"
]
},
{
"id": "date_time"
},
{
"id": "timeUnit",
"defaultValueContent": "minute",
Expand Down Expand Up @@ -125,7 +129,7 @@
{
"id": "resource",
"values": [
"bdtopo-pgr"
"bdtopo-valhalla"
]
},
{
Expand Down Expand Up @@ -155,7 +159,8 @@
"defaultValueContent": "car",
"values": [
"car",
"pedestrian"
"pedestrian",
"multimodal"
]
},
{
Expand All @@ -166,21 +171,20 @@
"arrival"
]
},
{
"id": "date_time"
},
{
"id": "constraints",
"values": [
{
"keyType": "name-pgr",
"keyType": "name-valhalla",
"key": "wayType",
"availableConstraintType": ["banned"],
"availableValues": [
{
"value": "autoroute",
"field": "acces_vehicule_leger",
"condition": {
"type": "equal",
"value": "$niv3$A péage$niv3$"
}
"field": "exclude_tolls"
}
]
}
Expand Down
16 changes: 9 additions & 7 deletions documentation/index.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
# {{ title }} - Documentation

> **Description:** {{ description }}
> **Auteur et contributeurs:** {{ author }}
> **Version:** {{ version }}
> **Code source:** {{ repo_url }}
> **Description:** {{ description }}
> **Auteur et contributeurs:** {{ author }}
> **Version:** {{ version }}
> **Code source:** {{ repo_url }}
> **Dernière mise à jour de la documentation:** {{ date_update }}

## Présentation générale
## Présentation générale

Road2 est un serveur de calcul d'itinéraires et d'isochrones écrit en Javascript et conçu pour fonctionner avec NodeJS. Ce serveur propose le calcul d'itinéraires et d'isochrones via des moteurs existants comme [OSRM](https://github.com/Project-OSRM/osrm-backend) ou [PGRouting](https://pgrouting.org/). Road2 est donc une interface pour moteurs de calculs. Ces derniers ne sont pas fait dans le code de Road2 mais via des appels à ses moteurs. Cela peut se traduire par l'appel à une librairie, ou à une base de données, ou encore à un autre service web.
Road2 est un serveur de calcul d'itinéraires et d'isochrones écrit en Javascript et conçu pour fonctionner avec NodeJS. Ce serveur propose le calcul d'itinéraires et d'isochrones via des moteurs existants comme [OSRM](https://github.com/Project-OSRM/osrm-backend) ou [PGRouting](https://pgrouting.org/). Road2 est donc une interface pour moteurs de calculs. Ces derniers ne sont pas fait dans le code de Road2 mais via des appels à ses moteurs. Cela peut se traduire par l'appel à une librairie, ou à une base de données, ou encore à un autre service web.

Road2 a été conçu dans l'idée de pouvoir facilement ajouter des nouveaux moteurs et de nouvelles APIs, et cela, de manière totalement transparente les uns pour autres. Autrement dit, ajouter un moteur n'a pas d'impact sur les APIs déjà existantes. L'objectif est de faciliter l'ajout de nouvelles fonctionnalités tout en pérennisant l'accès au service. Pour une plus longue discussion sur les concepts logiciels introduits dans Road2, on pourra se référer à la documentation [suivante](./developers/concepts.md).

Actuellement, Road2 propose trois moteurs, OSRM, PGRouting et Valhalla, via une unique API REST.
Actuellement, Road2 propose trois moteurs, OSRM, PGRouting et Valhalla, via une unique API REST.

Pour les ressources Valhalla configurees en multimodal, un parametre optionnel `date_time` est disponible sur les operations `route` et `isochrone` (format attendu: `YYYY-MM-DDTHH:mm`).


```{toctree}
Expand Down
30 changes: 30 additions & 0 deletions documentation_en/apis/simple/1.0.0/api.json
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,17 @@
},
"example": "fastest"
},
{
"name": "date_time",
"in": "query",
"description": "Departure date and time for Valhalla multimodal computation. This parameter is optional and only used on Valhalla resources configured for multimodal routing.",
"required": false,
"schema": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}$"
},
"example": "2026-07-03T08:30"
},
{
"name": "geometryFormat",
"in": "query",
Expand Down Expand Up @@ -558,6 +569,17 @@
},
"example": "départ"
},
{
"name": "date_time",
"in": "query",
"description": "Departure date and time for Valhalla multimodal computation. This parameter is optional and only used on Valhalla resources configured for multimodal routing.",
"required": false,
"schema": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}$"
},
"example": "2026-07-03T08:30"
},
{
"name": "constraints",
"in": "query",
Expand Down Expand Up @@ -812,6 +834,10 @@
"optimization": {
"type": "string"
},
"date_time": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}$"
},
"constraints": {
"type": "array",
"items": {
Expand Down Expand Up @@ -896,6 +922,10 @@
"arrivé"
]
},
"date_time": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}$"
},
"constraints": {
"type": "array",
"items": {
Expand Down
10 changes: 6 additions & 4 deletions documentation_en/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# {{ title }} - Documentation

> **Description:** {{ description }}
> **Authors and contributors:** {{ author }}
> **Version:** {{ version }}
> **Source code:** {{ repo_url }}
> **Description:** {{ description }}
> **Authors and contributors:** {{ author }}
> **Version:** {{ version }}
> **Source code:** {{ repo_url }}
> **last update of the documentation:** {{ date_update }}

## General presentation
Expand All @@ -14,6 +14,8 @@ Road2 was designed with the idea of being able to easily add new engines and new

Currently, Road2 offers three engines, OSRM, PGRouting and Valhalla, through a single REST API.

For Valhalla resources configured for multimodal routing, an optional `date_time` parameter is available on `route` and `isochrone` operations (expected format: `YYYY-MM-DDTHH:mm`).

```{toctree}
---
caption: Road2
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "road2",
"version": "3.0.1",
"version": "3.0.2",
"description": "Calcul d'itinéraire",
"author": "RDEV - IGN",
"main": "src/js/road2.js",
Expand Down
Loading
Loading