Skip to content

Latest commit

 

History

History
86 lines (51 loc) · 5.59 KB

integrer-un-schema-de-donnees-a-schema.data.gouv.fr.md

File metadata and controls

86 lines (51 loc) · 5.59 KB

Intégrer un schéma de données à schema.data.gouv.fr

{% hint style="info" %} Qu'est-ce que schema.data.gouv.fr ?

schema.data.gouv.fr est l’initiative de data.gouv.fr de référencement des schémas de données publiques pour la France.

Cette plateforme de référencement national permet un accès aux schémas produits par différents acteurs et facilite l’intégration avec des systèmes informatiques par le biais de standards, d’URLs stables, de processus de validation et d’API. {% endhint %}

Page d'accueil de schema.data.gouv.fr

Qui peut référencer des schémas de données ?

Tout acteur est libre de proposer le référencement de schémas sur schema.data.gouv.fr : administration, entreprise privée, association, citoyen, etc.

Quels schémas de données sont acceptés ?

Schémas de données acceptés sur schema.data.gouv.fr

  • Des schémas de données décrivant des données publiques.

{% hint style="success" %} Les schémas de données sont acceptés dès lors que leur l’existence est justifiée par voie :

  • réglementaire : c'est une disposition réglementaire qui est à l'origine de la définition du schéma de données ;

  • d’usage : la réutilisation des données décrites par le schéma bénéficie à un grand nombre ou de nombreux producteurs sont amenés à utiliser ce schéma de données. {% endhint %}

  • Des schémas de données décrits par un standard technique (cf. page "Phase de construction") : les schémas de données décrits uniquement par de la documentation textuelle ou des tableaux ne sont pas acceptés.

{% hint style="info" %} Standards techniques supportés

Les standards techniques de schémas de données actuellement supportés sont les suivants :

  • Table Schema : adapté pour la description de données tabulaires (sous forme de tableurs ou de CSV). Ce standard technique utilise le format JSON.
  • JSON Schema : adapté pour la description de données avec une notion de hiérarchie. Ce standard utilise le format JSON.
  • XML Schema Definition (XSD) : adapté pour la description de données avec une notion de hiérarchie. Ce standard utilise le format XML. {% endhint %}

Prérequis de validation des schémas de données sur schema.data.gouv.fr

{% hint style="info" %} Lexique : Validation d’un schéma de données

La validation d’un schéma de données est l’étape qui permet de vérifier si celui-ci est conforme au standard technique sélectionné et aux prérequis de schema.data.gouv.fr. Cette étape s’intéresse uniquement au schéma de données et à la façon dont il est publié.

Il ne faut pas confondre la validation d’un schéma avec le fait de vérifier que des données correspondent à un schéma. {% endhint %}

Pour tous les types de schéma de données, il faut que :

  • le schéma de données soit sur un dépôt Git, à raison d’un dépôt par schéma. Ce dépôt doit pouvoir être cloné depuis Internet sans authentification préalable ;
  • le dépôt Git doit comporter des tags indiquant les versions du schéma de données. Ces versions doivent respecter la gestion sémantique de version semver, sous la forme 1.3.2 par exemple ;
  • le dépôt doit comporter un fichier README.md à la racine contenant une documentation du schéma de données indiquant par exemple le contexte de production, la gouvernance ;
  • passer avec succès les tests spécifiques au type de schéma de données que le dépôt contient.

{% hint style="info" %} Critères complets de validation

Cette page présente les grands principes de validation des schémas de données.

Le détail des prérequis propres à chaque type de schéma de données, ainsi que des exemples, sont disponibles ici. {% endhint %}

Etalab se réserve le droit de refuser le référencement de schémas en motivant son refus. Il est encouragé d'initier une discussion préalablement à l’ouverture d’une pull request.

Quand référencer un schéma de données ?

Il est recommandé de référencer un schéma de données le plus tôt possible, dès la phase d’investigation.

En référençant celui-ci en amont, vous bénéficierez de l’accompagnement d’Etalab et de partenaires tout au long de la création de votre schéma de données : de l'investigation au référencement sur schema.data.gouv.fr.

Comment référencer un schéma de données ?

Pour référencer un schéma de données, vous pouvez :

Une page dédiée détaille la procédure.

Une liste de schémas de données actuellement en phase d'investigation ou de construction est tenue à jour sur cette même page.