From 1a63742e15ccaef8a6f9f20fa3a074a403103888 Mon Sep 17 00:00:00 2001 From: Maxime Lamer Date: Wed, 13 Mar 2024 10:20:08 -0400 Subject: [PATCH] adjusted docs --- .../fr/config/directions-profile-auth.csv | 3 ++ docs/_tables/fr/config/directions-profile.csv | 4 ++ docs/_tables/fr/config/directions.csv | 4 +- docs/config_json.rst | 54 ++++++++++++------- 4 files changed, 45 insertions(+), 20 deletions(-) create mode 100644 docs/_tables/fr/config/directions-profile-auth.csv create mode 100644 docs/_tables/fr/config/directions-profile.csv 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 6207265a6..ff4725659 100644 --- a/docs/_tables/fr/config/directions.csv +++ b/docs/_tables/fr/config/directions.csv @@ -1,5 +1,5 @@ Propriétés,Type,Description,Valeurs possibles,Valeur défaut -enabled ,Boolean ,Permet d'activer une source spécifique au lancement de l'application. | Une seule source doit être activée dans les configurations. ,true | false ,La source publique est activée par défaut. name ,String ,Nom de la source,, -url ,String ,URL du service retournant l'itinéraire. ,,`https://geoegl.msp.gouv.qc.ca/apis/itineraire/route/v1/driving/ ` +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 43fdcbfee..1e5564202 100644 --- a/docs/config_json.rst +++ b/docs/config_json.rst @@ -841,31 +841,31 @@ DirectionsSources .. line-block:: - Permet de définir une ou plusieurs sources utilisées pour la création d'itinéraires. Le service utilisée par IGO2 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 sources, une publique ('public') et une privée ('private'). + La configuration peut contenir, pour le moment, jusqu'à deux profils. Exemples .. code:: json - "directionsSources": [ - { - "osrm": { - "name": "OSRM Québec (Public)", - "type": "public", - "url": "/apis/itineraire/route/v1/driving/" - } - }, - { - "osrm": { - "name": "OSRM Québec (Partenaires)", - "type": "private", - "url": "/apis/itineraire/route/v1/forestier/", - "authorizationUrl": "/apis/igo2/user/igo" - } + "directionsSources": { + "osrm": { + "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 @@ -875,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