processing-transfer-file/processing-config-schema.json at main · data-fair/processing-transfer-file · 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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
{
  "type": "object",
  "x-display": "tabs",
  "required": ["datasetMode"],
  "allOf": [
    {
      "title": "Jeu de données",
      "oneOf": [
        {
          "title": "Créer un jeu de données",
          "required": ["dataset"],
          "properties": {
            "datasetMode": {
              "type": "string",
              "const": "create",
              "title": "Action"
            },
            "dataset": {
              "type": "object",
              "properties": {
                "title": {
                  "type": "string",
                  "title": "Titre (laissez vide pour utiliser le nom de fichier téléchargé)"
                }
              }
            }
          }
        },
        {
          "title": "Mettre à jour un jeu de données (fichier)",
          "required": ["dataset"],
          "properties": {
            "datasetMode": { "type": "string", "const": "update" },
            "dataset": {
              "type": "object",
              "title": "Jeu de données",
              "properties": {
                "id": { "type": "string", "title": "Identifiant" },
                "title": { "type": "string", "title": "Titre" }
              },
              "layout": {
                "getItems": {
                  "url": "${context.dataFairUrl}/api/v1/datasets?q={q}&select=id,title&${context.ownerFilter}&size=100",
                  "itemsResults": "data.results",
                  "itemTitle": "item.title",
                  "itemKey": "item.id"
                }
              }
            }
          }
        },
        {
          "title": "Mettre à jour des lignes d'un jeu de données (incrémental)",
          "required": ["dataset", "separator"],
          "properties": {
            "datasetMode": { "type": "string", "const": "lines" },
            "dataset": {
              "type": "object",
              "title": "Jeu de données",
              "properties": {
                "id": { "type": "string", "title": "Identifiant" },
                "title": { "type": "string", "title": "Titre" }
              },
              "layout": {
                "getItems": {
                  "url": "${context.dataFairUrl}/api/v1/datasets?q={q}&select=id,title&rest=true&${context.ownerFilter}&size=100",
                  "itemsResults": "data.results",
                  "itemTitle": "item.title",
                  "itemKey": "item.id"
                }
              }
            },
            "separator": {
              "type": "string",
              "title": "Séparateur",
              "default": ",",
              "enum": [",", ";", "-", "/", "|"]
            }
          }
        }
      ]
    },
    {
      "title": "Paramètres",
      "required": ["url"],
      "properties": {
        "url": {
          "title": "URL source",
          "type": "string",
          "description": "les protocoles supportés sont HTTP, HTTPS, FTP et SFTP"
        },
        "username": {
          "title": "Utilisateur",
          "type": "string",
          "layout": {
            "props": {
              "autocomplete": "new-text"
            }
          }
        },
        "password": {
          "title": "Mot de passe",
          "type": "string",
          "layout": {
            "props": {
              "type": "password",
              "autocomplete": "new-password"
            }
          }
        },
        "sshKey": {
          "title": "Clé SSH privée (uniquement dans le cas d'une URL de type SFTP)",
          "type": "string",
          "layout": "textarea"
        },
        "filename": {
          "title": "Nom du fichier",
          "type": "string",
          "description": "Ce nom apparaîtra lors du téléchargement du fichier source du jeu de données. Par défaut, il est déduit du serveur ftp/sftp ou depuis l'url. Définir un nom de fichier peux résoudre les erreurs `400 - .... type is not supported (/api/v1/datasets)`"
        },
        "encoding": {
          "title": "Encodage du fichier",
          "type": "string",
          "description": "Laissez vide pour une détection automatique de celui-ci"
        },
        "ignoreFirstLines": {
          "title": "Ignorer les N première lignes",
          "type": "integer"
        },
        "processAndDelete": {
          "type": "boolean",
          "title": "Supprimer le fichier source après import (FTP/SFTP uniquement)",
          "description": "Si activé : supprime l'exécution de l'historique des exécutions si le fichier n'existe pas sur le serveur, sinon ça supprime le fichier du serveur FTP/SFTP après l'import (n'a pas d'effet pour HTTP)"
        }
      }
    }
  ]
}