Commit 8fdfd3b3 authored by Pierre Dittgen's avatar Pierre Dittgen

Add forgotten 'example' property in schemas documentation

parent 69ee73b4
......@@ -2,16 +2,18 @@
> Schéma validant le format relatif à la Base d'Adresses Locales (BAL) du SCDL (Socle Commun des Données Locales).
13 colonnes définies
## Propriétés
- Auteur(s) : OpenDataFrance
- Version : 1.0.1
- Version : 1.0.2
- 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']
- Clef primaire : cle_interop
## Colonnes
......@@ -22,6 +24,7 @@ _Clé d'interopérabilité_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : 35238_3961_00007
- Taille minimale attendue : 16
### `uid_adresse`
......@@ -31,6 +34,7 @@ _Identifiant unique national d’adresse_
- Type attendu : `chaîne de caractères`
- `uuid` identifiant UUID
- exemple(s) :
### `voie_nom`
_Nom complet de la voie_
......@@ -40,6 +44,7 @@ _Nom complet de la voie_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : Rue du Rempart
- Taille minimale attendue : 3
### `numero`
......@@ -49,6 +54,7 @@ _Numéro d’adresse_
- Cette colonne est optionnelle
- Type attendu : `entier`
- exemple(s) : 130
- Valeur minimale autorisée : 1
### `suffixe`
......@@ -58,6 +64,7 @@ _Information suffixée qui complète et précise le numéro d’adresse_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : ter
- La valeur doit respecter le motif suivant : [^a-z0-9]+
### `commune_nom`
......@@ -67,6 +74,7 @@ _Nom officiel de la commune_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : Brest
### `position`
_Code de position de l’adresse_
......@@ -75,6 +83,7 @@ _Code de position de l’adresse_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : segment
- Valeurs autorisées : ['délivrance postale', 'entrée', 'bâtiment', 'cage d’escalier', 'logement', 'parcelle', 'segment', 'service technique']
### `x`
......@@ -84,6 +93,7 @@ _x_
- Cette colonne est optionnelle
- Type attendu : `nombre`
- exemple(s) : 145377.5
### `y`
_y_
......@@ -92,6 +102,7 @@ _y_
- Cette colonne est optionnelle
- Type attendu : `nombre`
- exemple(s) : 6835665.67
### `long`
_Longitude_
......@@ -100,6 +111,7 @@ _Longitude_
- Cette colonne est optionnelle
- Type attendu : `nombre`
- exemple(s) : -4.502217943385534
### `lat`
_Latitude_
......@@ -108,6 +120,7 @@ _Latitude_
- Cette colonne est optionnelle
- Type attendu : `nombre`
- exemple(s) : 48.383985827041485
### `source`
_Nom de l’organisme ayant créé ou diffusé cette adresse_
......@@ -116,6 +129,7 @@ _Nom de l’organisme ayant créé ou diffusé cette adresse_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : Rennes Métropole
### `date_der_maj`
_Date de dernière mise à jour de l'adresse_
......@@ -124,3 +138,4 @@ _Date de dernière mise à jour de l'adresse_
- Cette colonne est optionnelle
- Type attendu : `date`
- exemple(s) : 2014-10-01
......@@ -2,6 +2,8 @@
> Schéma validant le format relatif aux délibérations du SCDL (Socle Commun des Données Locales).
17 colonnes définies
## Propriétés
- Auteur(s) : OpenDataFrance
- Version : 2.0
......@@ -17,6 +19,7 @@ _Nom de la collectivité_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : Ville de Poitiers
### `COLL_SIRET`
_Code SIRET de la collectivité_
......@@ -25,6 +28,7 @@ _Code SIRET de la collectivité_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : 23350001600040
- La valeur doit respecter le motif suivant : ^\d{14}$
### `DELIB_ID`
......@@ -34,12 +38,14 @@ _Identifiant de la délibération_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : 1DL15494
### `DELIB_DATE`
_Date de la délibération_
- Cette colonne est optionnelle
- Type attendu : `date`
- exemple(s) : 2017-10-15
### `DELIB_MATIERE_CODE`
_Code de la matière de la délibération_
......@@ -48,6 +54,7 @@ _Code de la matière de la délibération_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : 1.1, 7.10
- La valeur doit respecter le motif suivant : ^\d\.\d{1,2}$
### `DELIB_MATIERE_NOM`
......@@ -57,6 +64,7 @@ _Nom de la matière de la délibération_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : Finances locales/Divers
- La valeur doit respecter le motif suivant : ^\w+( \w+)*\/[ \w]+$
### `DELIB_OBJET`
......@@ -64,6 +72,7 @@ _Objet de la délibération_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : Lancement d'une démarche partenariale de définition d'une politique montagne et adhésion à l'association nationale des élus de la montagne
### `BUDGET_ANNEE`
_Année du budget_
......@@ -72,6 +81,7 @@ _Année du budget_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : 2017, 2017/2018, 2016/2018
- La valeur doit respecter le motif suivant : ^[0-9]{4}(\/[0-9]{4})?$
### `BUDGET_NOM`
......@@ -80,6 +90,7 @@ _Nom du budget_
> Nom du budget si la délibération engendre une affection budgétaire
- Type attendu : `chaîne de caractères`
- exemple(s) : Budget annexe déchets-collecte et traitement
### `PREF_ID`
_Identifiant de l'entité exerçant le contrôle de légalité_
......@@ -90,36 +101,43 @@ _Identifiant de l'entité exerçant le contrôle de légalité_
> 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`
- exemple(s) : PREF038
### `PREF_DATE`
_Date d'enregistrement de la délibération au contrôle de légalité_
- Type attendu : `date`
- exemple(s) : 2017-02-03
### `VOTE_EFFECTIF`
_Décompte de l'effectif total des élus susceptibles de participer au vote (présents à la séance)_
- Type attendu : `entier`
- exemple(s) : 43
### `VOTE_REEL`
_Décompte de l’effectif total des élus ayant réellement participé au vote (exclusion des absents)_
- Type attendu : `entier`
- exemple(s) : 40
### `VOTE_POUR`
_Nombre de votes Pour_
- Type attendu : `entier`
- exemple(s) : 25
### `VOTE_CONTRE`
_Nombre de votes Contre_
- Type attendu : `entier`
- exemple(s) : 10
### `VOTE_ABSTENTION`
_Nombre de votes Abstention_
- Type attendu : `entier`
- exemple(s) : 5
### `DELIB_URL`
_Lien vers le document de la délibération_
......
......@@ -2,6 +2,8 @@
> 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)
26 colonnes définies
## Propriétés
- Auteur(s) : Virgile Pesce
- Contributeur(s) : Joël Gombin, Charles Népote, Colin Maudry, Pierre Dittgen, Christophe Benz
......@@ -20,6 +22,7 @@ _Identification du marché public_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : 201872300 (2018 723 00) ou 2019000111202 (2019 00001112 02)
- La valeur doit respecter le motif suivant : ^\d{4}.{1,10}\d{2}$
### `ACHETEURS_ID`
......@@ -29,6 +32,7 @@ _Identifiant de l'acheteur_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : 12345678912345
- La valeur doit respecter le motif suivant : ^\d{14}$
### `ACHETEURS_NOM`
......@@ -38,6 +42,7 @@ _Nom de l'acheteur_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : Conseil Départemental de Bretagne
- La valeur doit respecter le motif suivant : [A-Za-zÀÂÄÇÉÈÊËÎÏÔÖÙÛÜŸàâäçéèêëîïôöùûüÿÆŒæœ \-']*
### `NATURE_MARCHE`
......@@ -47,6 +52,7 @@ _Nature du marché_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : marché subséquent
- Valeurs autorisées : ['marché', 'marché de partenariat', 'accord-cadre', 'marché subséquent']
### `MARCHE_OBJET`
......@@ -56,6 +62,7 @@ _Objet du marché ou du lot_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : Entretien des jardins municipaux
- Taille maximale attendue : 256
### `CPV_CODE`
......@@ -65,6 +72,7 @@ _Code CPV principal_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : 45112500
- La valeur doit respecter le motif suivant : ^[0-9]{8}(\-[0-9])?$
### `PROCEDURE`
......@@ -74,6 +82,7 @@ _Procédure de passation du marché_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : Procédure adaptée
- 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`
......@@ -83,6 +92,7 @@ _Code du lieu d'exécution_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : 04070
### `LIEU_EXEC_TYPE`
_Type de code du lieu d'exécution_
......@@ -91,6 +101,7 @@ _Type de code du lieu d'exécution_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : Code région
- Valeurs autorisées : ['Code postal', 'Code commune', 'Code arrondissement', 'Code canton', 'Code département', 'Code région', 'Code pays']
### `LIEU_EXEC_NOM`
......@@ -109,6 +120,7 @@ _Durée initiale du marché_
- Cette colonne est optionnelle
- Type attendu : `entier`
- exemple(s) : 12
- Valeur minimale autorisée : 1
### `NOTIFICATION_DATE`
......@@ -118,6 +130,7 @@ _Date de la notification du marché_
- Cette colonne est optionnelle
- Type attendu : `date`
- exemple(s) : 2017-03-24
### `PUBLICATION_DATE`
_Date de la publication des données essentielles du marché_
......@@ -126,6 +139,7 @@ _Date de la publication des données essentielles du marché_
- Cette colonne est optionnelle
- Type attendu : `date`
- exemple(s) : 2017-07-26
### `MONTANT`
_Montant forfaitaire ou estimé maximum HT_
......@@ -134,6 +148,7 @@ _Montant forfaitaire ou estimé maximum HT_
- Cette colonne est optionnelle
- Type attendu : `nombre`
- exemple(s) : 325038.12
### `PRIX_FORME`
_Forme du prix_
......@@ -151,6 +166,7 @@ _Titulaires du marché_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : 12345678901234
- La valeur doit respecter le motif suivant : ^[A-Z0-9]{9,}$
### `TITULAIRES_ID_TYPE`
......@@ -169,6 +185,7 @@ _Dénomination sociale du titulaire_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : Transit 2000 SA
### `MODIF_OBJET`
_Modification_
......@@ -177,6 +194,7 @@ _Modification_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : Modification du titulaire du marché. Nouveau titulaire : Rodriguez SAS
- Taille maximale attendue : 256
### `MODIF_PUBLICATION_DATE`
......@@ -185,6 +203,7 @@ _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`
- exemple(s) : 2017-12-28
### `MODIF_DUREE_MOIS`
_Nouvelle durée, en mois_
......@@ -193,6 +212,7 @@ _Nouvelle durée, en mois_
- Cette colonne est optionnelle
- Type attendu : `entier`
- exemple(s) : 7
- Valeur minimale autorisée : 1
### `MODIF_MARCHE_MONTANT`
......@@ -201,6 +221,7 @@ _Nouveau montant forfaitaire ou estimé maximum HT_
> Le séparateur décimal doit être un point de type '.'
- Type attendu : `nombre`
- exemple(s) : 325038.12
### `MODIF_TITULAIRES_ID`
_Nouveau titulaire du marché_
......@@ -208,6 +229,7 @@ _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`
- exemple(s) : 12345678901234
### `MODIF_TITULAIRES_ID_TYPE`
_Type de l'ID du nouveau titulaire du marché_
......@@ -224,6 +246,7 @@ _Dénomination sociale du nouveau titulaire_
> Nom du nouvel opérateur économique intervenant sur le marché
- Type attendu : `chaîne de caractères`
- exemple(s) : Transit 2000 SA
### `MODIF_SIGNATURE_DATE`
_Date de la signature de la modification_
......@@ -231,3 +254,4 @@ _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`
- exemple(s) : 2017-06-29
......@@ -6,6 +6,8 @@
>
6 colonnes définies
## Propriétés
- Auteur(s) : Charles Nepote <charles.nepote@fing.org>
- Contributeur(s) : Simon Chignard, Bernadette Kessler, Christian Quest
......
......@@ -2,6 +2,8 @@
> Schéma validant le format relatif aux subventions du SCDL (Socle Commun des Données Locales).
14 colonnes définies
## Propriétés
- Auteur(s) : OpenDataFrance
- Version : 1.1
......@@ -17,6 +19,7 @@ _Nom de l'attribuant_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : Région Bretagne
### `idAttribuant`
_Identification de l'attribuant_
......@@ -25,6 +28,7 @@ _Identification de l'attribuant_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : 23350001600040
- La valeur doit respecter le motif suivant : ^\d{14}$
### `dateConvention`
......@@ -34,6 +38,7 @@ _Date de la convention de subvention_
- Cette colonne est optionnelle
- Type attendu : `date`
- exemple(s) : 2017-06-27
### `referenceDecision`
_Référence de la décision_
......@@ -42,6 +47,7 @@ _Référence de la décision_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : Z34507
### `nomBeneficiaire`
_Nom du bénéficiaire_
......@@ -50,6 +56,7 @@ _Nom du bénéficiaire_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : Rodriguez SA
### `idBeneficiaire`
_Identification du bénéficiaire_
......@@ -58,6 +65,7 @@ _Identification du bénéficiaire_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : 81223113200026
- La valeur doit respecter le motif suivant : ^\d{14}$
### `objet`
......@@ -67,6 +75,7 @@ _Objet de la subvention_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : Aide à l'embauche
- Taille maximale attendue : 256
### `montant`
......@@ -76,6 +85,7 @@ _Montant total de la subvention_
- Cette colonne est optionnelle
- Type attendu : `nombre`
- exemple(s) : 22000.80
### `nature`
_Nature de la subvention_
......@@ -84,6 +94,7 @@ _Nature de la subvention_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : aide en numéraire;aide en nature
- Valeurs autorisées : ['aide en numéraire', 'aide en nature', 'aide en numéraire;aide en nature', 'aide en nature;aide en numéraire']
### `conditionsVersement`
......@@ -93,6 +104,7 @@ _Conditions de versement de la subvention_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) :
- Taille maximale attendue : 256
### `datesPeriodeVersement`
......@@ -102,6 +114,7 @@ _Date ou période de versement_
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : 2017-12-14
- La valeur doit respecter le motif suivant : ^[0-9]{4}\-[0-9]{2}\-[0-9]{2}(\/[0-9]{4}\-[0-9]{2}\-[0-9]{2})?$
### `idRAE`
......@@ -111,6 +124,7 @@ _Numéro unique de référencement dans le Répertoire des Aides aux Entreprises
- Cette colonne est optionnelle
- Type attendu : `chaîne de caractères`
- exemple(s) : 12345
### `notificationUE`
_Aide d'Etat notifiée à la Commission européenne_
......@@ -121,6 +135,7 @@ _Aide d'Etat notifiée à la Commission européenne_
- Type attendu : `booléen`
- Valeurs considérées comme fausses : ['non']
- Valeurs considérées comme vraies : ['oui']
- exemple(s) : oui
### `pourcentageSubvention`
_Pourcentage du montant total de la subvention attribuée au bénéficiaire_
......@@ -129,5 +144,6 @@ _Pourcentage du montant total de la subvention attribuée au bénéficiaire_
- Cette colonne est optionnelle
- Type attendu : `nombre`
- Valeur minimale autorisée : 0
- exemple(s) : 0.8
- Valeur maximale autorisée : 1
- Valeur minimale autorisée : 0
......@@ -136,6 +136,9 @@ def format_constraints(col_content):
else:
buffer.write('- Type non spécifié\n')
if 'example' in col_content:
buffer.write('- exemple(s) : {}\n'.format(col_content['example']))
if 'constraints' in col_content:
# unique
if 'unique' in constraints and constraints['unique'] == 'true':
......@@ -169,6 +172,7 @@ def convert_content(json_content, out_fd):
out_fd.write('# Schéma « {} »\n'.format(json_content['title']))
if 'description' in json_content:
out_fd.write(format_description(json_content['description']))
out_fd.write('\n{} colonnes définies\n'.format(len(json_content['fields'])))
out_fd.write('\n## Propriétés\n')
for prop in ('author', 'contributor', 'version', 'created', 'homepage', 'uri', 'example'):
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment