diff --git a/docs/_tables/fr/config/directions-profile-auth.csv b/docs/_tables/fr/config/directions-profile-auth.csv new file mode 100644 index 000000000..bea6ca057 --- /dev/null +++ b/docs/_tables/fr/config/directions-profile-auth.csv @@ -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é.,, \ No newline at end of file diff --git a/docs/_tables/fr/config/directions-profile.csv b/docs/_tables/fr/config/directions-profile.csv new file mode 100644 index 000000000..d125504dd --- /dev/null +++ b/docs/_tables/fr/config/directions-profile.csv @@ -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é. ,, \ No newline at end of file diff --git a/docs/_tables/fr/config/directions.csv b/docs/_tables/fr/config/directions.csv index d08a44452..ff4725659 100644 --- a/docs/_tables/fr/config/directions.csv +++ b/docs/_tables/fr/config/directions.csv @@ -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/ `_ +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/ ` +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.,, \ No newline at end of file diff --git a/docs/config_json.rst b/docs/config_json.rst index d07471f54..1e5564202 100644 --- a/docs/config_json.rst +++ b/docs/config_json.rst @@ -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 @@ -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