Schémas : documentation technique

Schémas

• etalab/schema.data.gouv.fr comporte plusieurs fonctionnalités propres aux schémas :

  • un aggrégateur qui aggrège et valide des schémas depuis plusieurs dépôts Git selon plusieurs standards (Table Schema, JSON Schema, XSD)
  • un site web Jekyll qui héberge une documentation expliquant le fonctionnement des schémas et listant les différents schémas préalablement validés par l'aggrégateur. Sur le site web, on retrouve des liens vers Validata (validation), JDD consolidés sur data.gouv.fr, JDD ayant spécifié un schéma
  • collecte de données et exposition de celles-ci en JSON : des données sur les schémas actuellement sur la plateforme, les issues décrivant les schémas en validation et construction, une liste de recommendation pour les JDD consolidés par rapport aux schémas pour udata-recommendations

• etalab/udata-schema-gouvfr est un plugin udata dédié à l'intégration avec schema.data.gouv.fr. Ce plugin ajoute un bouton "Schéma" sur les ressources avec un attribut schema renseigné et ajoute une modale d'informations. Ce plugin propose également une tâche udata job run set-irve-schemas qui renseigne l'attribut schema pour les ressources consolidées dans le JDD national IRVE.

• etalab/monitor-consolidation se repose sur des informations de chaque système pour évaluer la qualité d'un jeu de données consolidé, publié sur data.gouv.fr, par rapport au schéma correspondant sur schema.data.gouv.fr. Les données collectées sont stockées en CSV et JSON et mises en ligne sur GitHub Pages. Ces éléments de qualité d'une ressource consolidée par rapport à un schéma sont ensuite affichées sur schema.data.gouv.fr. De plus, ce dépôt surveille les ressources ajoutées sur les jeux de données consolidés uniquement et reporte la qualité de ces ressources par rapport au schéma de référence sur une discussion du jeu de données data.gouv.fr, par le biais de l'API.

• etalab/csv-gg permet de créer des fichiers CSV conformes par rapport à un schéma. Cet outil se repose sur schema.data.gouv.fr pour avoir la liste des schémas au format Table Schema et leur contenu. CSV-GG ne s'intègre pas avec data.gouv.fr, il n'est par exemple pas possible d'upload le CSV résultant de la saisie directement sur data.gouv.fr.

• Validata est un logiciel libre développé par Open Data France. Il utilise schema.data.gouv.fr pour avoir la liste des schémas et est utilisé par CSV-GG et monitor-consolidation pour évaluer la confirmité d'une ressource par rapport à un schéma. Une instance de Validata est déployée par Etalab à l'adresse https://validata.etalab.studio.