processing-rnb/processing-config-schema.json at main · data-fair/processing-rnb · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
{
  "$id": "https://github.com/data-fair/processing-rnb/processing-config",
  "type": "object",
  "title": "ProcessingConfig",
  "layout": "tabs",
  "required": ["datasetMode"],
  "allOf": [
    {
      "title": "Dataset",
      "x-i18n-title": { "fr": "Jeu de données" },
      "oneOf": [
        {
          "title": "Create a dataset — full national import",
          "x-i18n-title": { "fr": "Créer un jeu de données — import national complet" },
          "required": ["datasetMode", "datasetTitle"],
          "properties": {
            "datasetMode": {
              "type": "string",
              "const": "create",
              "title": "Action",
              "x-i18n-title": { "fr": "Action" }
            },
            "datasetTitle": {
              "type": "string",
              "title": "Title of the dataset to create",
              "x-i18n-title": { "fr": "Titre du jeu de données à créer" },
              "default": "Bâtiments RNB",
              "description": "The dataset is created on the first run and the full national export (about 43 million buildings) is loaded. The processing then switches to update mode: every following run only applies the nightly diff.",
              "x-i18n-description": {
                "fr": "Le jeu de données est créé à la première exécution et l'export national complet (environ 43 millions de bâtiments) est chargé. Le traitement bascule ensuite en mode mise à jour : chaque exécution suivante n'applique que le différentiel de la nuit."
              }
            }
          }
        },
        {
          "title": "Update a dataset — nightly diff",
          "x-i18n-title": { "fr": "Mettre à jour un jeu de données — différentiel nocturne" },
          "required": ["dataset"],
          "properties": {
            "datasetMode": {
              "type": "string",
              "const": "update",
              "title": "Action",
              "x-i18n-title": { "fr": "Action" }
            },
            "dataset": {
              "type": "object",
              "title": "Dataset",
              "x-i18n-title": { "fr": "Jeu de données" },
              "description": "Dataset holding the RNB buildings, created by a previous full import or any other dataset with the same schema and the `rnb_id` primary key.",
              "x-i18n-description": {
                "fr": "Jeu de données contenant les bâtiments RNB, créé par un import complet précédent ou tout autre jeu au schéma identique et de clé primaire `rnb_id`."
              },
              "layout": {
                "getItems": {
                  "url": "${context.dataFairUrl}/api/v1/datasets?select=id,title&size=50&${context.ownerFilter}&raw=true",
                  "qSearchParam": "q",
                  "itemsResults": "data.results",
                  "itemTitle": "item.title",
                  "itemKey": "item.id"
                }
              },
              "properties": {
                "id": { "type": "string", "title": "Identifiant" },
                "title": { "type": "string", "title": "Titre" }
              }
            }
          }
        }
      ]
    },
    {
      "title": "Parameters",
      "x-i18n-title": { "fr": "Paramètres" },
      "properties": {
        "fromEmail": {
          "type": "string",
          "format": "email",
          "title": "Contact email",
          "x-i18n-title": { "fr": "Adresse de contact" },
          "description": "Optional. Sent as the `from` parameter of every RNB API call, so the RNB team can warn you before changing an endpoint.",
          "x-i18n-description": {
            "fr": "Optionnel. Envoyée dans le paramètre `from` de chaque appel à l'API RNB, pour que l'équipe RNB puisse vous prévenir en cas de changement d'endpoint."
          }
        },
        "sourceUrl": {
          "type": "string",
          "format": "uri",
          "title": "National export URL",
          "x-i18n-title": { "fr": "URL de l'export national" },
          "default": "https://rnb-opendata.s3.fr-par.scw.cloud/files/RNB_nat.csv.zip",
          "description": "ZIP archive of the national RNB export, as published on [data.gouv.fr](https://www.data.gouv.fr/fr/datasets/referentiel-national-des-batiments/). Only used by the full import (create mode).",
          "x-i18n-description": {
            "fr": "Archive ZIP de l'export national RNB, publiée sur [data.gouv.fr](https://www.data.gouv.fr/fr/datasets/referentiel-national-des-batiments/). Utilisée uniquement par l'import complet (mode création)."
          }
        }
      }
    }
  ]
}