Commit 69ee73b4 authored by Pierre Dittgen's avatar Pierre Dittgen
Browse files

Add static generated documentation

parent dee2b990
## Contrainte d'obligation
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
schema | body | 9 |
### Explication:
La colonne {column_number} est obligatoire, mais la ligne {row_number} ne comporte de valeur pour cette colonne
### Description:
Cette colonne est obligatoire mais elle contient des valeurs vides.
Pour résoudre le problème :
- Si c'est une erreur de données, complétez la valeur manquante.
- Si ce n'est pas une erreur, retirez la contrainte `required` du schéma pour cette colonne.
- Si vous ne souhaitez pas être notifié de cette erreur, désactivez la vérification `required-constraint` dans {validator}.
\ No newline at end of file
## Erreur de schéma
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
schema | table | 15 |
### Explication:
Erreur de schéma : {error_message}
### Description:
Le schéma fourni est invalide.
Pour résoudre le problème:
- Mettez à jour le schéma pour le rendre valide.
- Si vous ne souhaitez pas être notifié de cette erreur, désactivez la vérification de schéma dans {validator}.
\ No newline at end of file
## Erreur de protocole
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
source | table | 100 |
### Explication:
Le protocole d'accès à la source est inconnu, impossible d'extraire des données tabulaires
### Description:
Erreur de lecture des données due à un protocole d'accès inconnu.
Pour résoudre le problème :
- Corrigez le protocole (modifiez par exemple `ftp` en `http`).
- Positionnez une valeur de protocole valide dans {validator}.
\ No newline at end of file
## Erreur de source
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
source | table | 100 |
### Explication:
Le format des données est inconnu, impossible d'extraire des données tabulaires
### Description:
Erreur de lecture des données, le contenu n'est pas reconnu.
Pour résoudre le problème :
- Corrigez les données (modidiez, par exemple, le contenu JSON en tableau ou objets.
- Corrigez le paramétrage de la source dans {validator}.
\ No newline at end of file
## Erreur de format ou de type
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
schema | body | 9 |
### Explication:
La valeur {value} à la ligne {row_number} et colonne {column_number} n'est pas de type {field_type} et format {field_format}
### Description:
La valeur ne correspond pas au type et format défini dans le schéma pour cette colonne.
Pour résoudre le problème :
- Si c'est une erreur de valeur, corrigez-la.
- Si la valeur est correct, modifiez le type et/ou le format dans le schéma.
- Si vous ne souhaitez pas être notifié de cette erreur, désactivez la vérification `type-or-format-error` dans {validator}. Attention, toutes les erreurs sur les valeurs seront alors ignorées.
\ No newline at end of file
## Contrainte d'unicité
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
schema | body | 9 |
### Explication:
Les valeurs des lignes {row_numbers} ne respectent pas la contrainte d'unicité définie pour la colonne {column_number}
### Description:
Les valeurs de cette colonne doivent être uniques, cependant une même valeur a été utilisée plusieurs fois sur des lignes différentes.
Pour résoudre le problème :
- Si c'est un problème de données, corrigez la valeur.
- Si la valeur est correcte, cette colonne ne respecte pas la contrainte d'unicité. Retirez la contrainte `unique` du schéma pour cette colonne.
- Si vous ne souhaitez pas être notifié de cette erreur, désactivez la vérification `unique-constraint` dans {validator}.
\ No newline at end of file
# Schéma « Schéma SCDL Base d'Adresse Locale »
> Schéma validant le format relatif à la Base d'Adresses Locales (BAL) du SCDL (Socle Commun des Données Locales).
## Propriétés
- Auteur(s) : OpenDataFrance
- Version : 1.0.1
- Schéma créé le : 2018-05-30
- Page d'accueil : https://git.opendatafrance.net/scdl/bal
- Site web : https://git.opendatafrance.net/scdl/bal/blob/master/schema.json
## Propriétés complémentaires
- Clef primaire : cle_interop
- Valeurs manquantes : ['', '99999']
## Colonnes
### `cle_interop`
_Clé d'interopérabilité_
> Composée du code insee (code INSEE) + code de voie (FANTOIR DGFiP sur 4 caractères) + numéro d’adresse (5 caractères préfixé par des zéros) + suffixe (indice de répétition et complément) séparés par `_`
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- Taille minimale attendue : 16
### `uid_adresse`
_Identifiant unique national d’adresse_
> Cet identifiant unique d’adresse est géré et attribué par le service `guichet national d’identification` de la BAN
- Type attendu : `chaîne de caractères`
- `uuid` identifiant UUID
### `voie_nom`
_Nom complet de la voie_
> Concaténation du type et du nom de la voie en majuscules et minuscules accentuées
> Le nom de la voie peut également être un lieu-dit
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- Taille minimale attendue : 3
### `numero`
_Numéro d’adresse_
> Numéro d’adresse dans la voie et, dans le cas des voies sans adresse, la valeur “99999” est attendue
- Cette colonne est optionnelle
- Type attendu : `entier`
- Valeur minimale autorisée : 1
### `suffixe`
_Information suffixée qui complète et précise le numéro d’adresse_
> Indice de répétition et/ou complément d'adresse (nom d’entrée d’immeuble) normalisé en minuscules sans espace
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- La valeur doit respecter le motif suivant : [^a-z0-9]+
### `commune_nom`
_Nom officiel de la commune_
> Texte libre qui permet d’identifier rapidement la commune dans laquelle l’adresse est située
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
### `position`
_Code de position de l’adresse_
> Décrit la position d’une adresse à partir d’une liste de valeurs qui provient de la spécification INSPIRE v 3.1 sur le thème “Adresses” : délivrance postale, entrée, bâtiment, cage d’escalier, logement, parcelle, segment, service technique
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- Valeurs autorisées : ['délivrance postale', 'entrée', 'bâtiment', 'cage d’escalier', 'logement', 'parcelle', 'segment', 'service technique']
### `x`
_x_
> Coordonnée X du système légal en vigueur sur le territoire concerné
- Cette colonne est optionnelle
- Type attendu : `nombre`
### `y`
_y_
> Coordonnée Y du système légal en vigueur sur le territoire concerné
- Cette colonne est optionnelle
- Type attendu : `nombre`
### `long`
_Longitude_
> Coordonnée de longitude exprimée en WGS84
- Cette colonne est optionnelle
- Type attendu : `nombre`
### `lat`
_Latitude_
> Coordonnée de latitude exprimée en WGS84
- Cette colonne est optionnelle
- Type attendu : `nombre`
### `source`
_Nom de l’organisme ayant créé ou diffusé cette adresse_
> Nom de l’organisme ayant créé ou diffusé cette adresse
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
### `date_der_maj`
_Date de dernière mise à jour de l'adresse_
> Date de dernière mise à jour connue de la donnée au format AAAA-MM-JJ
- Cette colonne est optionnelle
- Type attendu : `date`
# Schéma « Schéma SCDL Délibérations »
> Schéma validant le format relatif aux délibérations du SCDL (Socle Commun des Données Locales).
## Propriétés
- Auteur(s) : OpenDataFrance
- Version : 2.0
- Schéma créé le : 2018-05-23
- Page d'accueil : https://git.opendatafrance.net/scdl/deliberations
## Colonnes
### `COLL_NOM`
_Nom de la collectivité_
> Nom officiel de la collectivité délibérante
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
### `COLL_SIRET`
_Code SIRET de la collectivité_
> Identifiant du Système d'Identification du Répertoire des Etablissements (SIRET)
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- La valeur doit respecter le motif suivant : ^\d{14}$
### `DELIB_ID`
_Identifiant de la délibération_
> Identifiant interne de délibération respectant le formalisme propre à la collectivité
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
### `DELIB_DATE`
_Date de la délibération_
- Cette colonne est optionnelle
- Type attendu : `date`
### `DELIB_MATIERE_CODE`
_Code de la matière de la délibération_
> Code de l'indexation de niveau 2 de la nomenclature Actes
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- La valeur doit respecter le motif suivant : ^\d\.\d{1,2}$
### `DELIB_MATIERE_NOM`
_Nom de la matière de la délibération_
> Intitulé de matière niveau 1 suivi de l'intitulé de sous-matière niveau 2 séparés par « / »
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- La valeur doit respecter le motif suivant : ^\w+( \w+)*\/[ \w]+$
### `DELIB_OBJET`
_Objet de la délibération_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
### `BUDGET_ANNEE`
_Année du budget_
> Année de l'exercice budgétaire sur lequel s'applique la décision si celle-ci a un impact budgétaire. Format AAAA pour une année ou AAAA/AAAA pour un intervalle entre deux années (ISO 8601).
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- La valeur doit respecter le motif suivant : ^[0-9]{4}(\/[0-9]{4})?$
### `BUDGET_NOM`
_Nom du budget_
> Nom du budget si la délibération engendre une affection budgétaire
- Type attendu : `chaîne de caractères`
### `PREF_ID`
_Identifiant de l'entité exerçant le contrôle de légalité_
> Pour les préfectures : PREFNNN (7 caractères)
> Pour les sous-préfectures : SPREFNNNM (9 caractères)
> Pour les SGAR : SGARNNN (7 caractères)
> Où NNN : numéro sur 3 caractères du département et M : numéro sur un chiffre de l'arrondissement
- Type attendu : `chaîne de caractères`
### `PREF_DATE`
_Date d'enregistrement de la délibération au contrôle de légalité_
- Type attendu : `date`
### `VOTE_EFFECTIF`
_Décompte de l'effectif total des élus susceptibles de participer au vote (présents à la séance)_
- Type attendu : `entier`
### `VOTE_REEL`
_Décompte de l’effectif total des élus ayant réellement participé au vote (exclusion des absents)_
- Type attendu : `entier`
### `VOTE_POUR`
_Nombre de votes Pour_
- Type attendu : `entier`
### `VOTE_CONTRE`
_Nombre de votes Contre_
- Type attendu : `entier`
### `VOTE_ABSTENTION`
_Nombre de votes Abstention_
- Type attendu : `entier`
### `DELIB_URL`
_Lien vers le document de la délibération_
- Type attendu : `chaîne de caractères`
- `uri` adresse URL
# Schéma « Spécification SCDL Marchés Publics »
> Les données fixées dans l’arrêté du 14 avril 2017 doivent être publiées à compter du 1er octobre 2018 pour chaque marché public dont le montant est supérieur à 25 000 € HT et pour chaque contrat de concession. (https://www.legifrance.gouv.fr/affichTexte.do?cidTexte=JORFTEXT000034492587&dateTexte=&categorieLien=id)
## Propriétés
- Auteur(s) : Virgile Pesce
- Contributeur(s) : Joël Gombin, Charles Népote, Colin Maudry, Pierre Dittgen, Christophe Benz
- Version : 1.0.1
- Schéma créé le : 2018-03-01
- Page d'accueil : https://git.opendatafrance.net/scdl/marches-publics/
- Site web : https://git.opendatafrance.net/scdl/marches-publics/blob/master/schemas/marche_public_SCDL.json
- Données d'exemple : https://git.opendatafrance.net/scdl/marches-publics/blob/master/exemples/exemple_marche_public.csv
## Colonnes
### `MARCHE_ID`
_Identification du marché public_
> L'ID marché est composé de trois parties: année de notification (4 caractères) ; le numéro d'ordre interne propre à l'acheteur public (1 à 10 caractères alphanumériques),le numéro d'ordre de la modification (2 caractères, 00 si pas de modification, 01 si une modification, etc.)
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- La valeur doit respecter le motif suivant : ^\d{4}.{1,10}\d{2}$
### `ACHETEURS_ID`
_Identifiant de l'acheteur_
> Numéro SIRET donc 9 chiffres suivi de 5, soit 14 chiffres. http://xml.insee.fr/schema/siret.html#SIRET_stype
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- La valeur doit respecter le motif suivant : ^\d{14}$
### `ACHETEURS_NOM`
_Nom de l'acheteur_
> Si le marché est passé par un groupement d'acheteurs, c'est le mandataire en charge d'effectuer la procédure du passation.
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- La valeur doit respecter le motif suivant : [A-Za-zÀÂÄÇÉÈÊËÎÏÔÖÙÛÜŸàâäçéèêëîïôöùûüÿÆŒæœ \-']*
### `NATURE_MARCHE`
_Nature du marché_
> Valeurs possibles : marché, marché de partenariat, accord-cadre, marché subséquent
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- Valeurs autorisées : ['marché', 'marché de partenariat', 'accord-cadre', 'marché subséquent']
### `MARCHE_OBJET`
_Objet du marché ou du lot_
> Description synthétique de l'objet du marché ou du lot. Ne doit pas excéder 256 caractères
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- Taille maximale attendue : 256
### `CPV_CODE`
_Code CPV principal_
> Le code CPV principal (8 caractères + 1 caractère de contrôle). Même si toléré, il préférable d'omettre le caractère de contrôle (-9). Nomenclature européenne permettant d'identifier les catégories de biens et de service faisant l'objet du marché (http://simap.ted.europa.eu/web/simap/cpv).
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- La valeur doit respecter le motif suivant : ^[0-9]{8}(\-[0-9])?$
### `PROCEDURE`
_Procédure de passation du marché_
> La procédure de passation de marché utilisée par l'acheteur
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- Valeurs autorisées : ['procédure adaptée', "appel d'offres ouvert", "appel d'offres restreint", 'procédure concurrentielle avec négociation', 'procédure négociée avec mise en concurrence préalable', 'marché négocié sans publicité ni mise en concurrence préalable', 'dialogue compétitif']
### `LIEU_EXEC_CODE`
_Code du lieu d'exécution_
> Code du lieu d'exécution (code postal, commune, canton, arrondissement, département, région, pays). Les codes INSEE sont à privilégier aux dépens du code postal.
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
### `LIEU_EXEC_TYPE`
_Type de code du lieu d'exécution_
> Le type de code utilisé pour désigner le lieu d'exécution. Hormis le « Code postal », les codes sont des codes géographiques gérés par l'INSEE (http://www.insee.fr/fr/methodes/nomenclatures/cog/default.asp)
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- Valeurs autorisées : ['Code postal', 'Code commune', 'Code arrondissement', 'Code canton', 'Code département', 'Code région', 'Code pays']
### `LIEU_EXEC_NOM`
_Nom du lieu d'exécution_
> Nom du lieu. http://xml.insee.fr/schema/commun.html#ChaineFrancaisOfficiel_stype
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- La valeur doit respecter le motif suivant : ^[A-Za-zÀÂÄÇÉÈÊËÎÏÔÖÙÛÜŸàâäçéèêëîïôöùûüÿÆŒæœ \-']*$
### `DUREE_MOIS`
_Durée initiale du marché_
> Valeur minimum : 1. La durée du marché, en mois, telle que définie au moment de la publication des données. La durée initale du marché comprend la durée des tranches et reconductions potentielles. Si la durée n'est pas un nombre exact de mois, arrondir au nombre supérieur. Exemples : 9 pour 9 mois ; 1 pour 2 semaines ; 2 pour 1 mois et 3 semaines. Si, une fois les données initiales du marché publiées une modification de la durée du marché intervient, elle doit être retranscrite via la propriété MODIF_DUREE_MOIS et la propriété DUREE_MOIS initiale ne doit pas être modifiée.
- Cette colonne est optionnelle
- Type attendu : `entier`
- Valeur minimale autorisée : 1
### `NOTIFICATION_DATE`
_Date de la notification du marché_
> Date à laquelle le marché a été notifié au(x) titulaire(s), au format AAAA-MM-JJ.
- Cette colonne est optionnelle
- Type attendu : `date`
### `PUBLICATION_DATE`
_Date de la publication des données essentielles du marché_
> Date à laquelle les données essentielles du marché décrit ont été publiées pour la première fois. Cette date n'est donc pas mise à jour en cas de modification du marché.
- Cette colonne est optionnelle
- Type attendu : `date`
### `MONTANT`
_Montant forfaitaire ou estimé maximum HT_
> Le séparateur décimal doit être un point de type '.'
- Cette colonne est optionnelle
- Type attendu : `nombre`
### `PRIX_FORME`
_Forme du prix_
> Ferme : le prix est fixé pour toute la durée marché. Ferme et actualisable : le prix peut évoluer périodiquement selon des conditions prévues dans le contrat initial (ex: variation d'indice. Révisable : l'acheteur et le titulaire peuvent s'entendre sur une modification du prix après la signature du marché.
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- Valeurs autorisées : ['ferme', 'ferme et actualisable', 'révisable']
### `TITULAIRES_ID`
_Titulaires du marché_
> Les opérateurs économiques titulaires du marché. Types d'identifiants possibles (favoriser le SIRET) : SIRET, TVA, TAHITI, RIDET, FRWF, IREP, HORS UE.
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- La valeur doit respecter le motif suivant : ^[A-Z0-9]{9,}$
### `TITULAIRES_ID_TYPE`
_Titulaires du marché_
> Le type d'identifiant utilisé pour identifier le titulaire du marché.
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- Valeurs autorisées : ['SIRET', 'TVA', 'TAHITI', 'RIDET', 'FRWF', 'IREP', 'HORS UE']
### `TITULAIRES_DENOMINATION`
_Dénomination sociale du titulaire_
> Nom de l'opérateur économique intervenant sur le marché
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
### `MODIF_OBJET`
_Modification_
> Une modification du marché ayant lieu après la publication des données essentielles du marché. Limité à 256 caractères.
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- Taille maximale attendue : 256
### `MODIF_PUBLICATION_DATE`
_Date de la republication des données incluant la modification_
> Date à laquelle les données essentielles sont republiées suite à la modification, au format AAAA-MM-JJ.
- Type attendu : `date`
### `MODIF_DUREE_MOIS`
_Nouvelle durée, en mois_
> Valeur minimum : 1. La durée du marché, en mois, telle que définie au moment de la republication des données. Si la durée n'est pas un nombre exact de mois, arrondir au nombre supérieur. Exemples : 9 pour 9 mois ; 1 pour 2 semaines ; 2 pour 1 mois et 3 semaines.
- Cette colonne est optionnelle
- Type attendu : `entier`
- Valeur minimale autorisée : 1
### `MODIF_MARCHE_MONTANT`
_Nouveau montant forfaitaire ou estimé maximum HT_
> Le séparateur décimal doit être un point de type '.'
- Type attendu : `nombre`
### `MODIF_TITULAIRES_ID`
_Nouveau titulaire du marché_
> Les opérateurs économiques titulaires du marché. Types d'identifiants possibles (favoriser le SIRET) : SIRET, TVA, TAHITI, RIDET, FRWF, IREP, UE, HORS-UE.
- Type attendu : `chaîne de caractères`
### `MODIF_TITULAIRES_ID_TYPE`
_Type de l'ID du nouveau titulaire du marché_
> Le type d'identifiant utilisé pour identifier le titulaire du marché.
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- Valeurs autorisées : ['SIRET', 'TVA', 'TAHITI', 'RIDET', 'FRWF', 'IREP', 'HORS UE']
### `MODIF_TITULAIRES_DENOMINATION`
_Dénomination sociale du nouveau titulaire_
> Nom du nouvel opérateur économique intervenant sur le marché
- Type attendu : `chaîne de caractères`
### `MODIF_SIGNATURE_DATE`
_Date de la signature de la modification_
> Date à laquelle les données essentielles sont republiées suite à la modification, au format AAAA-MM-JJ.
- Type attendu : `date`
# Schéma « Spécification de la liste annuelle des prénoms des nouveaux-nés déclarés à l'état-civil »
> La liste annuelle des prénoms des nouveaux-nés est un jeu de données simple et très apprécié du public. Il consiste en une liste de prénoms déclarés à l'état-civil de la commune de naissance, avec l'occurrence de chacun pour une année donnée. Les prénoms listés correspondent au premier prénom donné dans chaque acte de naissance.
>
> Ce schéma décrit le détail de chaque champ. Pour chacun, nous fournissons également l'expression rationnelle informatique (ou "regexp") qui permet de contrôler le contenu du champ.
>
>
## Propriétés
- Auteur(s) : Charles Nepote <charles.nepote@fing.org>
- Contributeur(s) : Simon Chignard, Bernadette Kessler, Christian Quest
- Version : 1.1.1
- Schéma créé le : 2018-04-12
- Page d'accueil : https://github.com/CharlesNepote/liste-prenoms-nouveaux-nes
- Site web : https://github.com/CharlesNepote/liste-prenoms-nouveaux-nes/blob/v1.1.1/prenom-schema.json
- Données d'exemple : https://gist.githubusercontent.com/CharlesNepote/48a73b05762d0e49bcc26d5ea5265a75/raw/1fa1a085a793e6925991b0dc6a07d653d3726506/prenom-nouveaux-nes.exemple.1.1.csv
## Colonnes
### `COMMUNE_NOM`
_Commune concernée_
> Nom de la commune où les prénoms sont enregistrés à l'état-civil, c'est-à-dire le lieu de naissance. Le lieu de naissance peut être différent du lieu de résidence des parents, comme cela peut être le cas pour les enfants nés dans une maternité. Le renseignement de ce champ est facultatif. Il permet cependant de faciliter l'usage des données, notamment par le grand public.
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- La valeur doit respecter le motif suivant : ^(Le |La |Les |Los |Aux |L'|)([A-ZÉÇŒÈÎ])(((-| | - |')[A-ZÉÇŒÈÎ])|('|-| |)[a-zàâéèêëïîÿôûüœç])*( \([A-Z][a-z]*\)|)$