Évolutions v0.3.0 : suppression id_lieu, id_local devient obligatoire (…

…#29) * - Correction de l'exemple CSV correct - Mise à jour des liens des exemples dans le `schema.json` - Mise à jour du readme * Première passe vers la v0.3.0 * Mise à jour des fichiers d'exemple * Ajout de restrictions pour les champs de type boolean * Correction du schéma (trueValues, falseValues) * Précisions mineures V0.3.0 * Update CHANGELOG.md Mise à jour date changelog V0.3.0 * Apply suggestions from code review Co-authored-by: Antoine Augusti <antoine.augusti@beta.gouv.fr> --------- Co-authored-by: Antoine Augusti <antoine.augusti@beta.gouv.fr>
etalab · Dec 19, 2023 · 3c9c1df · 3c9c1df
1 parent 7fb8eca
commit 3c9c1df
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 33 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,13 +2,20 @@
 
 Ce fichier répertorie les changements entre différentes versions d'un schéma.
 
+## Version 0.3.0 - 2023-12-18
+- La colonne `id_lieu` est supprimée
+- La colonne `id_local` devient obligatoire
+- Précision dans les valeurs booléennes possibles (`true` ou `false`uniquement)
+- Mise à jour des exemples CSV correct/incorrect
+- Mise à jour du README
+
 ## Version 0.2.8 - 2023-07-17
 - Correction de l'exemple CSV correct
 - Mise à jour des liens des exemples dans le `schema.json`
-- Mise à jour du readme
+- Mise à jour du README
 
 ## Version 0.2.7 - 2023-04-13
-- Mise à jour du readme : ajout d'une information concernant la sécurité des aires
+- Mise à jour du README : ajout d'une information concernant la sécurité des aires
 
 ## Version 0.2.6 - 2022-08-26
 - Correction de la valeur d'exemple du champ `id_lieu`

diff --git a/README.md b/README.md
@@ -22,20 +22,18 @@ Les lieux de covoiturage sont des données précieuses, notamment pour les appli
 ## Transmission des données
 Dans le but de constituer un répertoire national des lieux de covoiturage, ouvert et accessible à tous, les collectivités peuvent transmettre systématiquement, sous forme de tableau mis à jour, les données relatives aux lieux qu'elles considèrent pertinents pour les covoitureurs.
 
-Les différents moyens permettant de contribuer sont détaillés dans la documentation "[Contribution à la Base nationale des Lieux de Covoiturage (BNLC)](https://doc.transport.data.gouv.fr/producteurs/lieux-de-covoiturage/contribuer-a-la-base-nationale-des-lieux-de-covoiturage)".
+Les différents moyens permettant de contribuer sont détaillés dans la documentation "[Publier des données > La Base nationale des Lieux de Covoiturage (BNLC)](https://doc.transport.data.gouv.fr/type-donnees/lieux-de-covoiturage/administration-des-donnees/contribuer-a-la-base-nationale-des-lieux-de-covoiturage)".
 
-En cas de contribution directement sur data.gouv.fr, il faut sélectionner le schéma `Lieu de covoiturage` lors de la publication du jeu de données. [Plus de détails sur l'ajout d'un schéma](https://guides.data.gouv.fr/publier-des-donnees/guide-qualite/maitriser-les-schemas-de-donnees/indiquer-et-verifier-quune-ressource-respecte-un-schema-de-donnees)
+En cas de contribution directement sur data.gouv.fr, il faut sélectionner le schéma `Lieu de covoiturage` lors de la publication du jeu de données, afin que celui-ci soit ajouté automatiquement à la BNLC. [Plus de détails sur l'ajout d'un schéma](https://guides.data.gouv.fr/publier-des-donnees/guide-qualite/maitriser-les-schemas-de-donnees/indiquer-et-verifier-quune-ressource-respecte-un-schema-de-donnees)
 
 ### Format des fichiers
-Le fichier doit être un fichier CSV, encodé en UTF-8 et utilisant le point-virgule comme séparateur de colonnes. L'en-tête de colonne sur la première ligne est obligatoire. Tous les champs du schéma sont obligatoires ; si la donnée n'est pas disponible, la colonne doit malgré tout être présente mais vide.
-
-Lorsque vous contribuez via data.gouv.fr, nous préconisons ce format de nom du fichier : `AAAAMMJJ_idproducteur_lieuxcovoit.csv` où `AAAAMMJJ`est la date de mise à jour des données et `idproducteur` est le SIREN de la collectivité productrice des données. Par exemple pour le département de l'Ain, avec des données mises à jour le 18 juin 2023 :  `20230618_220100010_lieuxcovoit.csv`.
+Le fichier doit être un fichier CSV, encodé en UTF-8 et utilisant la virgule comme séparateur de colonnes. L'en-tête de colonne sur la première ligne est obligatoire. Tous les champs du schéma sont obligatoires ; si la donnée n'est pas disponible, la colonne doit malgré tout être présente mais vide.
 
 ### Fichiers d'exemple
 Nous mettons à disposition des fichiers d'exemple qui peuvent servir de base pour renseigner vos lieux de covoiturage.
 
-- [Télécharger un fichier exemple valide au format CSV](https://github.com/etalab/lieux-covoiturage/blob/master/exemple-valide.csv)
-- [Télécharger un fichier d'exemple invalide](https://github.com/etalab/lieux-covoiturage/blob/master/exemple-invalide.csv) contenant des erreurs dans le formatage des dates et une inversion des coordonnées géographiques latitude/longitude
+- [Télécharger un fichier exemple valide au format CSV](https://github.com/etalab/schema-lieux-covoiturage/raw/v0.3.0/exemple-valide.csv)
+- [Télécharger un fichier d'exemple invalide](https://github.com/etalab/schema-lieux-covoiturage/raw/v0.3.0/exemple-invalide.csv) contenant des erreurs dans le formatage des dates et une inversion des coordonnées géographiques latitude/longitude
 
 ### Mises à jour
 Les mises à jour sont effectuées à partir du fichier communiqué précédemment et en reprennent, en les modifiant le cas échéant, les données qui y figurent déjà.

diff --git a/exemple-invalide.csv b/exemple-invalide.csv
@@ -1,3 +1,3 @@
-id_lieu;id_local;nom_lieu;ad_lieu;com_lieu;insee;type;date_maj;ouvert;source;Xlong;Ylat;nbre_pl;nbre_pmr;duree;horaires;proprio;lumiere;comm
-76217-C-001;23X01;Gare SNCF de Dieppe;2 Boulevard Georges Clemenceau;Dieppe;76217;Parking;2019-06-25;true;217602176;1.081183;49.921823;20;2;;true;Ville de Dieppe;true;Correspondance avec la ligne TER Dieppe-Rouen
-76217-C-002;23X02;Gare Routière de Dieppe;2 Avenue Victor Louis;Dieppe;76000;Parking;24-06-2019;true;576578587;49.921921;1.065656;2;3;;false;Ville de Dieppe;true;Proximité de la gare SNCF
+id_local,nom_lieu,ad_lieu,com_lieu,insee,type,date_maj,ouvert,source,Xlong,Ylat,nbre_pl,nbre_pmr,duree,horaires,proprio,lumiere,comm
+23X01,Gare SNCF de Dieppe,2 Boulevard Georges Clemenceau,Dieppe,76217,Parking,2019-06-25,true,217602176,1.081183,49.921823,20,2,,true,Ville de Dieppe,true,Correspondance avec la ligne TER Dieppe-Rouen
+23X02,Gare Routière de Dieppe,2 Avenue Victor Louis,Dieppe,76000,Parking,24-06-2019,true,576578587,49.921921,1.065656,2,3,,false,Ville de Dieppe,true,Proximité de la gare SNCF
diff --git a/exemple-valide.csv b/exemple-valide.csv
@@ -1,2 +1,2 @@
-id_lieu;id_local;nom_lieu;ad_lieu;com_lieu;insee;type;date_maj;ouvert;source;Xlong;Ylat;nbre_pl;nbre_pmr;duree;horaires;proprio;lumiere;comm
-"76217-C-001";;Gare SNCF de Dieppe;2 Boulevard Georges Clemenceau;Dieppe;76217;Parking;2019-06-25;true;217602176;1.081183;49.921823;20;2;;true;Ville de Dieppe;true;"Correspondance avec la ligne TER Dieppe-Rouen"
+id_local,nom_lieu,ad_lieu,com_lieu,insee,type,date_maj,ouvert,source,Xlong,Ylat,nbre_pl,nbre_pmr,duree,horaires,proprio,lumiere,comm
+23X01,Gare SNCF de Dieppe,2 Boulevard Georges Clemenceau,Dieppe,76217,Parking,2019-06-25,true,217602176,1.081183,49.921823,20,2,,true,Ville de Dieppe,true,Correspondance avec la ligne TER Dieppe-Rouen
diff --git a/schema.json b/schema.json
@@ -19,20 +19,20 @@
         {
           "title": "Ressource valide",
           "name": "exemple-valide",
-          "path": "https://github.com/etalab/schema-lieux-covoiturage/raw/v0.2.2/exemple-valide.csv"
+          "path": "https://github.com/etalab/schema-lieux-covoiturage/raw/v0.3.0/exemple-valide.csv"
         },
         {
           "title": "Ressource invalide",
           "name": "exemple-invalide",
-          "path": "https://github.com/etalab/schema-lieux-covoiturage/raw/v0.2.2/exemple-invalide.csv"
+          "path": "https://github.com/etalab/schema-lieux-covoiturage/raw/v0.3.0/exemple-invalide.csv"
         }
       ],
     "author":"Antoine Augusti pour Etalab",
     "contact":"contact@transport.beta.gouv.fr",
     "contributors": [
         {
-            "title": "Miryad Ali et Francis Chabouis",
-            "email": "contact@transport.beta.gouv.fr",
+            "title": "Miryad Ali, Francis Chabouis, Aurélien Cadiou",
+            "email": "contact@transport.data.gouv.fr",
             "organisation": "transport.data.gouv.fr",
             "role": "contributor"
         },
@@ -73,30 +73,20 @@
             "role": "contributor"
         }
     ],
-    "version":"0.2.8",
+    "version":"0.3.0",
     "created":"2019-06-25",
-    "lastModified":"2023-07-17",
+    "lastModified":"2023-10-06",
     "homepage":"https://github.com/etalab/schema-lieux-covoiturage",
     "uri":"https://github.com/etalab/lieux-covoiturage/blob/master/schema.json",
     "example":"https://github.com/etalab/lieux-covoiturage/blob/master/exemple-valide.csv",
     "fields":[
-        {
-            "name":"id_lieu",
-            "description":"Identifiant du lieu de covoiturage, délivré par le Point d'Accès National selon la règle INSEE-C-XXX où INSEE est le code INSEE de la commune et XXX est le numéro d’ordre d'arrivée dans la base sur 3 chiffres, commençant par 001. L'identifiant 35238-C-001 désigne ainsi la première aire référencée dans la commune de code INSEE 35238.",
-            "example":"35238-C-001",
-            "type":"string",
-            "constraints":{
-                "required":true,
-                "pattern":"^([013-9]\\d|2[AB1-9])\\d{3}-C-\\d{3}$"
-            }
-        },
         {
             "name":"id_local",
             "description":"Identifiant du lieu de covoiturage fixé par le producteur de la donnée pour son propre usage",
             "example":"23X01",
             "type":"string",
             "constraints":{
-                "required":false
+                "required":true
             }
         },
         {
@@ -169,6 +159,8 @@
             "description":"Le lieu est-il actuellement accessible (actif ou inactif)",
             "example":"true",
             "type":"boolean",
+            "trueValues": ["true"],
+            "falseValues": ["false"],
             "constraints":{
                 "required":true
             }
@@ -258,6 +250,8 @@
             "description":"Un éclairage nocturne est-il présent",
             "example":false,
             "type":"boolean",
+            "trueValues": ["true"],
+            "falseValues": ["false"],
             "constraints":{
                 "required":false
             }
@@ -288,6 +282,5 @@
     ],
     "missingValues":[
         ""
-    ],
-    "primaryKey":"id_lieu"
+    ]
 }