Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(directions): added possibility to toggle between two routing sources #1151

Merged
merged 1 commit into from
May 16, 2024
Merged
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
3 changes: 3 additions & 0 deletions docs/_tables/fr/config/directions-profile-auth.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Propriétés,Type,Description,Valeurs possibles,Valeur par défaut
url ,String ,URL permettant de vérifier l'accessibilité d'un profil à un utilisateur. | Utilisé pour un profil protégé.,,
property ,String ,Propriété utilisée pour la vérification de l'accessibilité.,,
4 changes: 4 additions & 0 deletions docs/_tables/fr/config/directions-profile.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Propriétés,Type,Description,Valeurs possibles,Valeur par défaut
enabled ,Boolean ,Permet d'activer un profil spécifique au lancement de l'application. | Un seul doit être activé dans les configurations. ,true | false ,Le premier profil est activé par défaut.
name ,String ,Nom du profil. | Le nom est ajouté à baseURL afin de créer la route finale,,
authorization ,BaseDirectionsSourceOptionsProfileAuthorization ,Objet permettant de gérer l'accessibilité à un profil protégé. ,,
6 changes: 4 additions & 2 deletions docs/_tables/fr/config/directions.csv
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
Propriétés,Type,Description,Valeurs possibles,Valeur défaut
enabled ,Boolean ,Permet d'activer/ désactiver la source. ,true | false ,true
url ,String ,Url du serveur retournant l'itinéraire. ,,`https://geoegl.msp.gouv.qc.ca/services/itineraire/route/v1/driving/ <https://geoegl.msp.gouv.qc.ca/services/itineraire/route/v1/driving/>`_
name ,String ,Nom de la source,,
baseUrl ,String ,URL du service retournant l'itinéraire. ,,`https://geoegl.msp.gouv.qc.ca/apis/itineraire/route/v1/driving/ <https://geoegl.msp.gouv.qc.ca/apis/itineraire/route/v1/driving/>`
profiles , BaseDirectionsSourceOptionsProfile[] , Liste de profils à utiliser. ,
authorizationUrl ,String ,URL permettant de vérifier l'accessibilité d'une source à un utilisateur. | Utilisé pour une source privée.,,
42 changes: 37 additions & 5 deletions docs/config_json.rst
Original file line number Diff line number Diff line change
Expand Up @@ -836,22 +836,36 @@ Exemples
.. _igoroutingsource:

***************
RoutingSource
DirectionsSources
***************

.. line-block::

Permet de définir la source serveur utilisée pour la création d'itinéraires. Actuellement, le serveur utilisé est OSRM.
Permet de définir une ou plusieurs profils utilisés pour la création d'itinéraires. Le service utilisé par IGO2 est OSRM.

La configuration peut contenir, pour le moment, jusqu'à deux profils.

Exemples

.. code:: json

"routingSources": {
"directionsSources": {
"osrm": {
"enabled": true,
"url": "https://geoegl.msp.gouv.qc.ca/services/itineraire/route/v1/driving/"
"name": "OSRM Québec",
"baseUrl": "/apis/itineraire/route/v1/",
"profiles": [
{
"name": "driving",
},
{
"name": "forestier",
"authorization": {
"url": "/apis/igo2/user/igo",
"property": "hasOsrmPrivateAccess"
}
}]
}
}

Propriétés

Expand All @@ -861,7 +875,25 @@ Propriétés
:file: _tables/fr/config/directions.csv
:header-rows: 1
:widths: 10 10 30 15 10

**BaseDirectionsSourceOptionsProfile**

.. tabularcolumns:: |p{1cm}|p{2cm}|p{7cm}|p{2cm}|p{2cm}|

.. csv-table::
:file: _tables/fr/config/directions-profile.csv
:header-rows: 1
:widths: 10 10 30 15 10

**BaseDirectionsSourceOptionsProfileAuthorization**

.. tabularcolumns:: |p{1cm}|p{2cm}|p{7cm}|p{2cm}|p{2cm}|

.. csv-table::
:file: _tables/fr/config/directions-profile-auth.csv
:header-rows: 1
:widths: 10 10 30 15 10

Important : Les propriétés en caractère gras suivies d'un * sont obligatoires.

Liens
Expand Down
Loading