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

Add static generated documentation

parent dee2b990
## En-tête vide
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
structure | head | 3 |
### Explication:
L'en-tête de la colonne {column_number} est vide
### Description:
Une colonne de l'en-tête est vide. Dans l'en-tête, toutes les colonnes doivent avoir un libellé.
Pour résoudre le problème:
- Ajouter le libellé manquant dans l'en-tête.
- Si la première ligne de données commence ou termine par une virgule, retirez celle-ci.
- Si vous ne souhaitez pas être notifié de cette erreur, désactivez la vérification `blank-header` dans {validator}.
\ No newline at end of file
## Ligne vide
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
structure | body | 9 |
### Explication:
La ligne {row_number} is vide
### Description:
La ligne est vide. Une ligne doit comporter au moins une valeur.
Pour résoudre le problème :
- Supprimez la ligne vide.
- Si vous ne souhaitez pas être notifié de cette erreur, désactivez la vérification `blank-row` dans {validator}.
\ No newline at end of file
## En-tête dupliqué
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
structure | head | 3 |
### Explication:
Le libellé de la colonne {column_number} dans l'en-tête est utilisé également pour les colonnes {column_numbers}
### Description:
Deux colonnes dans l'en-tête ont le même libellé. Dans l'en-tête, les libellés de colonnes doivent être uniques.
Pour résoudre le problème:
- Ajouter le libellé manquant dans l'en-tête.
- Si la première ligne de données commence ou termine par une virgule, retirez celle-ci.
- Si vous ne souhaitez pas être notifié de cette erreur, désactivez la vérification `duplicate-header` dans {validator}.
\ No newline at end of file
## Ligne dupliquée
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
structure | body | 5 |
### Explication:
Le contenu de la ligne {row_number} est identique à celui de(s) ligne(s) {row_numbers}
### Description:
Une copie exacte des données a été trouvé sur une autre ligne.
Pour résoudre le problème :
- Corrigez les données si celles-ci sont incorrectes.
- Si la ligne est effectivement un doublon, supprimez-la.
- Si vous ne souhaitez pas être averti de ce type d'erreur, désactivez la vérification `duplicate-row` dans {validator}.
\ No newline at end of file
## Erreur d'encodage
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
source | table | 100 |
### Explication:
Les données ne peuvent être correctement décodées en {encoding}
### Description:
Erreur de lecture des données due à un problème d'encodage.
Pour résoudre le problème:
- Corrigez les problèmes d'encodage des données.
- Positionnez une valeur d'encodage correcte dans {validator}.
\ No newline at end of file
## Contrainte d'énumération
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
schema | body | 7 |
### Explication:
La valeur {value} à la ligne {row_number} et la colonne {column_number} ne fait pas partie de l'énumération : {constraint}
### Description:
Les valeurs de cette colonne doivent être choisies dans l'énumération définie.
Pour résoudre le problème :
- Si c'est une erreur de données, corrigez la valeur.
- Si la valeur est correcte, mettez à jour la liste des valeurs de l'énumération ou supprimez cette contrainte dans le schéma.
- Si vous ne souhaitez pas être notifié de cette erreur, désactivez la vérification `enumerable-constraint` dans {validator}.
\ No newline at end of file
## En-tête incorrect (libellé en trop)
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
schema | head | 9 |
### Explication:
Libellé surnuméraire à la colonne {column_number}
### Description:
La ligne d'en-tête du fichier contient un libellé non déclaré dans le schéma.
Pour résoudre le problème:
- Supprimez le libellé incriminé de l'en-tête du fichier ou déclarez-le dans le schéma.
- Si vous ne souhaitez pas être notifié de cette erreur, désactivez la vérification `extra-header` dans {validator}.
\ No newline at end of file
## Valeur surnuméraire
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
structure | body | 9 |
### Explication:
La ligne {row_number} contient une valeur supplémentaire dans {column_number}
### Description:
Cette ligne contient plus de valeurs que défini dans la ligne d'en-tête (i.e. la première ligne du fichier). Toutes les lignes d'un fichier tabulaire doivent comporter exactement le même nombre de colonnes.
Pour résoudre le problème:
- Vérifiez que cette ligne ne contient pas un séparateur (virgule) en trop.
- Si vous ne souhaitez pas être averti de ce type d'erreur, désactivez la vérification `extra-value` dans {validator}.
\ No newline at end of file
## Erreur de format
**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 due à un format inconnu.
Pour résoudre le problème :
- Corrigez le format (en changeant par exemple l'extension de fichier de `txt` en `csv`).
- Positionnez une valeur de format correct dans {validator}.
\ No newline at end of file
## Erreur HTTP
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
source | table | 100 |
### Explication:
Le serveur HTTP qui héberge les données a renvoyé une erreur de type {status_code}
### Description:
Erreur de lecture des données due à une erreur HTTP.
Pour résoudre le problème :
- Vérifiez que l'URL d'accès est correcte.
\ No newline at end of file
# Types d'erreur
* [Erreur de source](./errors/source-error.md)
* [Erreur HTTP](./errors/http-error.md)
* [Valeur manquante](./errors/missing-value.md)
* [Contrainte de valeur maximale](./errors/maximum-constraint.md)
* [En-tête incorrect (libellé en trop)](./errors/extra-header.md)
* [Erreur de schéma](./errors/schema-error.md)
* [Contrainte d'expression](./errors/pattern-constraint.md)
* [Contrainte d'unicité](./errors/unique-constraint.md)
* [Contrainte d'énumération](./errors/enumerable-constraint.md)
* [En-tête incorrect (libellé manquant)](./errors/missing-header.md)
* [En-tête vide](./errors/blank-header.md)
* [Erreur de format ou de type](./errors/type-or-format-error.md)
* [En-tête non conforme](./errors/non-matching-header.md)
* [Ligne dupliquée](./errors/duplicate-row.md)
* [Erreur de protocole](./errors/scheme-error.md)
* [Contrainte de longueur maximale](./errors/maximum-length-constraint.md)
* [Erreur d'encodage](./errors/encoding-error.md)
* [Erreur d'entrée/sortie](./errors/io-error.md)
* [En-tête dupliqué](./errors/duplicate-header.md)
* [Contrainte de longueur minimale](./errors/minimum-length-constraint.md)
* [Erreur de format](./errors/format-error.md)
* [Valeur surnuméraire](./errors/extra-value.md)
* [Contrainte d'obligation](./errors/required-constraint.md)
* [Ligne vide](./errors/blank-row.md)
* [Contrainte de valeur minimale](./errors/minimum-constraint.md)
\ No newline at end of file
## Erreur d'entrée/sortie
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
source | table | 100 |
### Explication:
L'accès aux données a rencontré une erreur de type {error_type}
### Description:
Erreur de lecture de données due à un problème d'entrée/sortie.
Pour résoudre le problème :
- Vérifiez que le chemin d'accès est correct.
\ No newline at end of file
## Contrainte de valeur maximale
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
schema | body | 7 |
### Explication:
La valeur {value} à la ligne {row_number} et la colonne {column_number} ne respecte pas la contrainte de maximum {constraint}
### Description:
Les valeurs de cette colonne doivent être inférieures ou égales au maximum défini dans le schéma.
Pour résoudre le problème :
- Si c'est une erreur de données, corrigez la valeur.
- Si la valeur est correcte, changez la valeur maximale définie ou retirez la contrainte dans le schéma.
- Si vous ne souhaitez pas être notifié de cette erreur, désactivez la vérification `maximum-constraint` dans {validator}.
\ No newline at end of file
## Contrainte de longueur maximale
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
schema | body | 7 |
### Explication:
La valeur {value} à la ligne {row_number} et la colonne {column_number} ne respecte pas la contrainte de longueur maximum {constraint}
### Description:
La longueur des valeurs de cette colonne doit être inférieure ou égale à celle définie dans le schéma.
Pour résoudre le problème:
- Si c'est une erreur de données, corrigez la valeur.
- Si la valeur est correcte, changez la longueur définie pour la contrainte `maximumLength` ou retirez-la du schéma.
- Si vous ne souhaitez pas être notifié de cette erreur, désactivez la vérification `maximum-length-constraint` dans {validator}.
\ No newline at end of file
## Contrainte de valeur minimale
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
schema | body | 7 |
### Explication:
La valeur {value} à la ligne {row_number} et la colonne {column_number} ne respecte pas la contrainte de minimum {constraint}
### Description:
Les valeurs de cette colonne doivent être supérieures ou égales au minimum défini dans le schéma.
Pour résoudre le problème :
- Si c'est une erreur de données, corrigez la valeur.
- Si la valeur est correcte, changez la valeur minimale définie ou retirez la contrainte dans le schéma.
- Si vous ne souhaitez pas être notifié de cette erreur, désactivez la vérification `minimum-constraint` dans {validator}.
\ No newline at end of file
## Contrainte de longueur minimale
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
schema | body | 7 |
### Explication:
La valeur {value} à la ligne {row_number} et la colonne {column_number} ne respecte pas la contrainte de longueur minimum {constraint}
### Description:
La longueur des valeurs de cette colonne doit être supérieure ou égale à celle définie dans le schéma.
Pour résoudre le problème:
- Si c'est une erreur de données, corrigez la valeur.
- Si la valeur est correcte, changez la longueur définie pour la contrainte `minimumLength` ou retirez-la du schéma.
- Si vous ne souhaitez pas être notifié de cette erreur, désactivez la vérification `minimum-length-constraint` dans {validator}.
\ No newline at end of file
## En-tête incorrect (libellé manquant)
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
schema | head | 9 |
### Explication:
Libellé manquant à la colonne {column_number}
### Description:
Le schéma définit un libellé de colonne qui n'est pas trouvé dans l'en-tête.
Pour résoudre le problème :
- Ajoutez la colonne manquante au fichier ou retirez sa déclaration au sein du schéma.
- Si vous ne souhaitez pas être notifié de cette erreur, désactivez la vérification `missing-header` dans {validator}
\ No newline at end of file
## Valeur manquante
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
structure | body | 9 |
### Explication:
À la ligne {row_number}, il manque une valeur pour la colonne {column_number}
### Description:
Cette ligne contient moins de valeurs que défini dans la ligne d'en-tête (i.e. la première ligne du fichier). Toutes les lignes d'un fichier tabulaire doivent comporter exactement le même nombre de colonnes.
Pour résoudre le problème:
- Vérifiez qu'il ne manque pas un séparateur (virgule) entre deux valeurs sur cette ligne.
- Si vous ne souhaitez pas être averti de ce type d'erreur, désactivez la vérification `missing-value` dans {validator}.
\ No newline at end of file
## En-tête non conforme
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
schema | head | 9 |
### Explication:
Le libellé de la colonne {column_number} ne correspond pas au libellé {field_name} déclaré dans le schéma
### Description:
Un des libellés de colonne du fichier ne correspond pas à ce qui est déclaré dans le schéma.
Pour résoudre le problème:
- Renommer la colonne dans le fichier ou dans le schéma
- Si vous ne souhaitez pas être notifié de cette erreur, désactivez la vérification `non-matching-header` dans {validator}.
\ No newline at end of file
## Contrainte d'expression
**Type d'erreur** | **Contexte** | **Poids**
:---: | :---: | :---:
schema | body | 7 |
### Explication:
La valeur {value} à la ligne {row_number} et la colonne {column_number} n'est pas conforme à l'expression {constraint}
### Description:
Les valeurs de cette colonne doivent respecter l'expression définie.
Pour résoudre le problème :
- Si c'est une erreur de données, corrigez la valeur.
- Si la valeur est correcte, mettez à jour l'expression ou retirez la contrainte `pattern` du schéma pour cette colonne.
- Si vous ne souhaitez pas être notifié de cette erreur, désactivez la vérification `pattern-constraint` dans {validator}.
\ No newline at end of file
## 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`