@data-fair/catalog-data-fair 0.2.3 → 0.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/README.md +2 -3
  2. package/lib/download.ts +1 -1
  3. package/lib/imports.ts +1 -1
  4. package/package.json +2 -2
  5. package/types/catalogConfig/.type/index.js +1 -1
  6. package/types/catalogConfig/.type/validate.js +1 -1
  7. package/types/catalogConfig/schema.json +1 -1
  8. package/types/datafairSchemas/.type/index.d.ts +14 -14
  9. package/types/datafairSchemas/schema.ts +431 -0
  10. package/types/datafairSchemas/schema.json +0 -425
package/README.md CHANGED
@@ -1,4 +1,3 @@
1
- # <img alt="Data FAIR logo" src="https://cdn.jsdelivr.net/gh/data-fair/data-fair@master/ui/public/assets/logo.svg" width="40"> @data-fair/catalog-mock
1
+ # <img alt="Data FAIR logo" src="https://cdn.jsdelivr.net/gh/data-fair/data-fair@master/ui/public/assets/logo.svg" width="40"> @data-fair/catalog-data-fair
2
2
 
3
- A simple mock plugin for the Data Fair catalogs service.
4
- This plugin can be used as a template for creating new plugins.
3
+ Data Fair plugin for the Data Fair catalogs service.
package/lib/download.ts CHANGED
@@ -41,7 +41,7 @@ const getMetaData = async ({ catalogConfig, resourceId, log, secrets }: GetResou
41
41
  log.info('Import des métadonnées de la ressource', { url })
42
42
  } catch (e) {
43
43
  console.error('Error while fetching metadatas', e)
44
- throw new Error(`Erreur lors de la récuperation de la resource DataFair. ${e instanceof Error ? e.message : e}`)
44
+ throw new Error(`Erreur lors de la récupération de la resource DataFair. ${e instanceof Error ? e.message : e}`)
45
45
  }
46
46
 
47
47
  dataset.schema = (dataset.schema ?? []).map((field) => {
package/lib/imports.ts CHANGED
@@ -52,7 +52,7 @@ export const listResources = async (config: ListContext<DataFairConfig, DataFair
52
52
  data = res.data
53
53
  } catch (e) {
54
54
  console.error(`Error fetching datasets from ${url} : ${e}`)
55
- throw new Error(`Erreur lors de la récuperation de la resource Data Fair (${e instanceof Error ? e.message : ''})`)
55
+ throw new Error(`Erreur lors de la récupération de la resource Data Fair (${e instanceof Error ? e.message : ''})`)
56
56
  }
57
57
 
58
58
  const catalog = prepareCatalog(data.results)
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@data-fair/catalog-data-fair",
3
- "description": "A simple Data Fair plugin for the Data Fair catalogs service.",
4
- "version": "0.2.3",
3
+ "description": "Data Fair plugin for the Data Fair catalogs service.",
4
+ "version": "0.2.4",
5
5
  "main": "index.ts",
6
6
  "type": "module",
7
7
  "scripts": {
package/types/catalogConfig/.type/index.js CHANGED
@@ -62,7 +62,7 @@ export const schema = {
62
62
  "layout": {
63
63
  "props": {
64
64
  "type": "password",
65
- "autocomplete": "new-password"
65
+ "autocomplete": "suppress"
66
66
  }
67
67
  }
68
68
  }
package/types/catalogConfig/.type/validate.js CHANGED
@@ -4,7 +4,7 @@
4
4
  "use strict";
5
5
  export const validate = validate14;
6
6
  export default validate14;
7
- const schema16 = {"$id":"https://github.com/data-fair/catalog-data-fair/catalog-config","x-exports":["types","validate","schema"],"title":"DataFairConfig","type":"object","additionalProperties":false,"required":["url"],"properties":{"url":{"type":"string","title":"URL","description":"The url of the catalog","x-i18n-description":{"fr":"L'URL du portail où le catalogue est publié. Par exemple: `https://opendata.koumoul.com`."},"pattern":"^https?://.*[^/]$","errorMessage":"The URL must start with http:// or https:// and must not end with `/`.","x-i18n-errorMessage":{"fr":"L'URL doit commencer par http:// ou https:// et ne pas se terminer par `/`."},"examples":["https://opendata.koumoul.com"]},"apiKey":{"type":"string","title":"API Key (Optional)","x-i18n-title":{"fr":"Clé API (Optionnelle)"},"description":"The Data Fair API key to access the catalog. You can create one from the 'Settings' tab in Data Fair, under the 'API Keys' section.","x-i18n-description":{"fr":"La clé API Data Fair pour accéder au catalogue. Vous pouvez en créer depuis l'onglet 'Paramètres' de Data Fair, dans la section 'Clés d'API'."},"layout":{"props":{"type":"password","autocomplete":"new-password"}}}}};
7
+ const schema16 = {"$id":"https://github.com/data-fair/catalog-data-fair/catalog-config","x-exports":["types","validate","schema"],"title":"DataFairConfig","type":"object","additionalProperties":false,"required":["url"],"properties":{"url":{"type":"string","title":"URL","description":"The url of the catalog","x-i18n-description":{"fr":"L'URL du portail où le catalogue est publié. Par exemple: `https://opendata.koumoul.com`."},"pattern":"^https?://.*[^/]$","errorMessage":"The URL must start with http:// or https:// and must not end with `/`.","x-i18n-errorMessage":{"fr":"L'URL doit commencer par http:// ou https:// et ne pas se terminer par `/`."},"examples":["https://opendata.koumoul.com"]},"apiKey":{"type":"string","title":"API Key (Optional)","x-i18n-title":{"fr":"Clé API (Optionnelle)"},"description":"The Data Fair API key to access the catalog. You can create one from the 'Settings' tab in Data Fair, under the 'API Keys' section.","x-i18n-description":{"fr":"La clé API Data Fair pour accéder au catalogue. Vous pouvez en créer depuis l'onglet 'Paramètres' de Data Fair, dans la section 'Clés d'API'."},"layout":{"props":{"type":"password","autocomplete":"suppress"}}}}};
8
8
  const pattern0 = new RegExp("^https?://.*[^/]$", "u");
9
9
 
10
10
  function validate14(data, {instancePath="", parentData, parentDataProperty, rootData=data}={}){
package/types/catalogConfig/schema.json CHANGED
@@ -41,7 +41,7 @@
41
41
  "layout": {
42
42
  "props": {
43
43
  "type": "password",
44
- "autocomplete": "new-password"
44
+ "autocomplete": "suppress"
45
45
  }
46
46
  }
47
47
  }
package/types/datafairSchemas/.type/index.d.ts CHANGED
@@ -101,6 +101,20 @@ export type DataFairDataset = {
101
101
  | "daily"
102
102
  | "continuous"
103
103
  | "irregular";
104
+ /**
105
+ * URL d'une image, illustration du jeu de données
106
+ */
107
+ image?: string;
108
+ license?: {
109
+ /**
110
+ * Short title for the license
111
+ */
112
+ title: string;
113
+ /**
114
+ * The URL where the license can be read
115
+ */
116
+ href: string;
117
+ };
104
118
  analysis?: {
105
119
  escapeKeyAlgorithm?: "compat-ods";
106
120
  [k: string]: unknown;
@@ -124,10 +138,6 @@ export type DataFairDataset = {
124
138
  size: number;
125
139
  [k: string]: unknown;
126
140
  };
127
- /**
128
- * URL d'une image, illustration du jeu de données
129
- */
130
- image?: string;
131
141
  /**
132
142
  * JSON schema properties of the fields
133
143
  */
@@ -238,16 +248,6 @@ export type DataFairDataset = {
238
248
  * The number of rowns
239
249
  */
240
250
  count?: number;
241
- license?: {
242
- /**
243
- * Short title for the license
244
- */
245
- title: string;
246
- /**
247
- * The URL where the license can be read
248
- */
249
- href: string;
250
- };
251
251
  [k: string]: unknown;
252
252
  }
253
253
 
package/types/datafairSchemas/schema.ts ADDED
@@ -0,0 +1,431 @@
1
+ export default {
2
+ $id: 'https://github.com/data-fair/catalog-data-fair/catalog-schemas',
3
+ 'x-exports': [
4
+ 'types'
5
+ ],
6
+ title: 'DataFair Catalog',
7
+ type: 'object',
8
+ additionalProperties: false,
9
+ required: [
10
+ 'count',
11
+ 'results'
12
+ ],
13
+ properties: {
14
+ count: {
15
+ type: 'number',
16
+ description: 'Nombre total de jeux de données'
17
+ },
18
+ results: {
19
+ type: 'array',
20
+ items: {
21
+ $ref: '#/$defs/DataFairDataset'
22
+ }
23
+ }
24
+ },
25
+ $defs: {
26
+ DataFairDataset: {
27
+ type: 'object',
28
+ required: [
29
+ 'id',
30
+ 'title'
31
+ ],
32
+ properties: {
33
+ id: {
34
+ type: 'string',
35
+ description: 'Globally unique identifier of the dataset'
36
+ },
37
+ href: {
38
+ type: 'string',
39
+ description: 'Readonly field. The URL where this resource can be fetched'
40
+ },
41
+ page: {
42
+ type: 'string',
43
+ description: 'Readonly field. The URL where this resource can be viewed in the UI'
44
+ },
45
+
46
+ title: {
47
+ type: 'string',
48
+ description: 'Short title of the dataset'
49
+ },
50
+ description: {
51
+ type: 'string',
52
+ description: 'Detailed description of the dataset'
53
+ },
54
+
55
+ keywords: {
56
+ type: 'array',
57
+ description: 'keywords',
58
+ items: {
59
+ type: 'string'
60
+ }
61
+ },
62
+ frequency: {
63
+ type: 'string',
64
+ description: 'update frequency',
65
+ enum: [
66
+ '',
67
+ 'triennial',
68
+ 'biennial',
69
+ 'annual',
70
+ 'semiannual',
71
+ 'threeTimesAYear',
72
+ 'quarterly',
73
+ 'bimonthly',
74
+ 'monthly',
75
+ 'semimonthly',
76
+ 'biweekly',
77
+ 'threeTimesAMonth',
78
+ 'weekly',
79
+ 'semiweekly',
80
+ 'threeTimesAWeek',
81
+ 'daily',
82
+ 'continuous',
83
+ 'irregular'
84
+ ]
85
+ },
86
+ image: {
87
+ type: 'string',
88
+ description: "URL d'une image, illustration du jeu de données"
89
+ },
90
+ license: {
91
+ type: 'object',
92
+ additionalProperties: false,
93
+ required: [
94
+ 'title',
95
+ 'href'
96
+ ],
97
+ properties: {
98
+ title: {
99
+ type: 'string',
100
+ description: 'Short title for the license'
101
+ },
102
+ href: {
103
+ type: 'string',
104
+ description: 'The URL where the license can be read'
105
+ }
106
+ }
107
+ },
108
+
109
+ analysis: {
110
+ type: 'object',
111
+ properties: {
112
+ escapeKeyAlgorithm: {
113
+ type: 'string',
114
+ enum: [
115
+ 'compat-ods'
116
+ ]
117
+ }
118
+ }
119
+ },
120
+ projection: {
121
+ type: 'object',
122
+ properties: {
123
+ code: { type: 'string' },
124
+ title: { type: 'string' }
125
+ }
126
+ },
127
+
128
+ file: {
129
+ type: 'object',
130
+ required: [
131
+ 'size'
132
+ ],
133
+ properties: {
134
+ size: {
135
+ type: 'number',
136
+ description: 'Size of the file on disk'
137
+ }
138
+ }
139
+ },
140
+ originalFile: {
141
+ type: 'object',
142
+ required: [
143
+ 'size'
144
+ ],
145
+ properties: {
146
+ size: {
147
+ type: 'number',
148
+ description: 'Size of the file on disk'
149
+ }
150
+ }
151
+ },
152
+ schema: {
153
+ type: 'array',
154
+ description: 'JSON schema properties of the fields',
155
+ items: {
156
+ type: 'object',
157
+ required: [
158
+ 'key'
159
+ ],
160
+ properties: {
161
+ key: {
162
+ type: 'string',
163
+ readOnly: true,
164
+ 'x-display': 'hidden'
165
+ },
166
+ type: {
167
+ type: 'string'
168
+ },
169
+ format: {
170
+ type: [
171
+ 'string',
172
+ 'null'
173
+ ]
174
+ },
175
+ 'x-originalName': {
176
+ type: [
177
+ 'string',
178
+ 'null'
179
+ ]
180
+ },
181
+ title: {
182
+ type: 'string'
183
+ },
184
+ description: {
185
+ type: 'string'
186
+ },
187
+ icon: {
188
+ type: 'string'
189
+ },
190
+ 'x-group': {
191
+ type: 'string'
192
+ },
193
+ 'x-refersTo': {
194
+ deprecated: true,
195
+ type: [
196
+ 'string',
197
+ 'null'
198
+ ]
199
+ },
200
+ 'x-concept': {
201
+ type: 'object',
202
+ properties: {
203
+ id: {
204
+ type: 'string'
205
+ },
206
+ title: {
207
+ type: 'string'
208
+ },
209
+ primary: {
210
+ type: 'boolean'
211
+ }
212
+ }
213
+ },
214
+ 'x-calculated': {
215
+ type: 'boolean'
216
+ },
217
+ 'x-capabilities': {
218
+ type: 'object',
219
+ properties: {
220
+ index: {
221
+ type: 'boolean',
222
+ default: true,
223
+ 'x-display': 'switch',
224
+ title: 'Filtrable sur valeur exacte',
225
+ description: 'Désactivez cette capacité si la donnée contient par exemple des textes longs pour lesquels des filtres sur valeurs exactes ont peu de sens.'
226
+ },
227
+ values: {
228
+ type: 'boolean',
229
+ default: true,
230
+ 'x-display': 'switch',
231
+ title: 'Triable et groupable',
232
+ description: 'Désactivez cette capacité si la donnée contient par exemple des textes longs pour lesquels trier ou grouper par valeur a peu de sens.'
233
+ },
234
+ textStandard: {
235
+ type: 'boolean',
236
+ default: true,
237
+ 'x-display': 'switch',
238
+ title: 'Texte analysé pour recherche textuelle',
239
+ description: "Désactivez cette capacité dans le cas d'un code, une url, etc. N'importe quel contenu sur lequel la recherche de mots a peu de sens."
240
+ },
241
+ text: {
242
+ type: 'boolean',
243
+ default: true,
244
+ 'x-display': 'switch',
245
+ title: 'Texte analysé spécifiquement pour la langue française',
246
+ description: "Désactivez cette capacité pour tout contenu qui n'est pas en langue française ou pour lequel la recherche de mots a peu de sens."
247
+ },
248
+ textAgg: {
249
+ type: 'boolean',
250
+ default: false,
251
+ 'x-display': 'switch',
252
+ title: 'Statistiques de mots',
253
+ description: "Activez cette capacité si avez l'intention d'obtenir des statistiques sur les occurrences de mots (par exemple pour construire un nuage de mot)."
254
+ },
255
+ wildcard: {
256
+ type: 'boolean',
257
+ default: false,
258
+ 'x-display': 'switch',
259
+ title: 'Texte filtrable sur groupe de caractères',
260
+ description: "Activez cette capacité si vous avez l'intention de filtrer ce contenu spécifiquement sur une suite de caractères (par exemple si un filtre sur mots entiers ou sur valeur exacte ne convient pas)."
261
+ },
262
+ insensitive: {
263
+ type: 'boolean',
264
+ default: true,
265
+ 'x-display': 'switch',
266
+ title: 'Tri amélioré avec casse et accents',
267
+ description: 'Désactivez cette capacité si le contenu ne sera pas utilisé pour du tri ou bien si il ne contient pas de variations avec accents et majuscules.'
268
+ },
269
+ geoShape: {
270
+ type: 'boolean',
271
+ default: true,
272
+ 'x-display': 'switch',
273
+ title: 'Formes géométriques complexes',
274
+ description: 'Désactivez cette capacité si la donnée ne contient que des géométries basiques de points ou bien si requêter les géométries uniquement à partir de leurs centroïdes est suffisant pour vos besoins.'
275
+ },
276
+ vtPrepare: {
277
+ type: 'boolean',
278
+ default: false,
279
+ 'x-display': 'switch',
280
+ title: 'Tuiles vectorielles préparées',
281
+ description: "Activez cette capacité pour précalculer des éléments utiles à la construction de tuiles vectorielles pour le rendu cartographique du jeu de données. Activez cette option si le jeu de données contient des données géogreaphiques denses à afficher en grande quantité. La contre-partie est une augmentation du temps d'indexation et du volume de données indexées."
282
+ },
283
+ indexAttachment: {
284
+ type: 'boolean',
285
+ default: true,
286
+ 'x-display': 'switch',
287
+ title: 'Contenu des pièces jointes analysé pour recherche textuelle',
288
+ description: "Désactivez cette option si vous souhaitez que les pièces jointes soient simplement téléchargeables et que l'extraction de leur contenu textuel pour recherche de mots n'est pas pertinente."
289
+ }
290
+ }
291
+ },
292
+ 'x-labels': {
293
+ type: 'object',
294
+ patternProperties: {
295
+ '.*': {
296
+ type: 'string'
297
+ }
298
+ }
299
+ },
300
+ 'x-labelsRestricted': {
301
+ type: 'boolean'
302
+ },
303
+ readOnly: {
304
+ type: 'boolean'
305
+ },
306
+ 'x-required': {
307
+ type: 'boolean'
308
+ },
309
+ minLength: {
310
+ type: 'integer'
311
+ },
312
+ maxLength: {
313
+ type: 'integer'
314
+ },
315
+ minimum: {
316
+ type: 'number'
317
+ },
318
+ maximum: {
319
+ type: 'number'
320
+ },
321
+ pattern: {
322
+ type: 'string',
323
+ format: 'regex'
324
+ },
325
+ patternErrorMessage: {
326
+ type: 'string'
327
+ },
328
+ 'x-master': {
329
+ type: 'object',
330
+ properties: {
331
+ id: {
332
+ type: 'string'
333
+ },
334
+ title: {
335
+ type: 'string'
336
+ },
337
+ remoteService: {
338
+ type: 'string',
339
+ description: "L'identifiant du service distant utilisé pour l'enrichissement"
340
+ },
341
+ action: {
342
+ type: 'string',
343
+ description: "L'identifiant de l'action du service distant à utiliser pour l'enrichissement"
344
+ }
345
+ }
346
+ },
347
+ 'x-display': {
348
+ type: 'string'
349
+ },
350
+ enum: {
351
+ type: 'array',
352
+ readOnly: true,
353
+ description: 'This differs from JSON schema. It is not a restriction, just and observation of the values that are present in the dataset.'
354
+ },
355
+ 'x-cardinality': {
356
+ type: 'integer',
357
+ description: 'The number of distinct values for this field',
358
+ readOnly: true
359
+ },
360
+ 'x-transform': {
361
+ type: 'object',
362
+ description: 'Transformation to apply to the field',
363
+ properties: {
364
+ expr: {
365
+ type: 'string'
366
+ },
367
+ examples: {
368
+ type: 'array',
369
+ items: {
370
+ type: 'string'
371
+ }
372
+ },
373
+ type: {
374
+ type: 'string'
375
+ },
376
+ format: {
377
+ type: 'string'
378
+ }
379
+ }
380
+ }
381
+ }
382
+ }
383
+ },
384
+ storage: {
385
+ type: 'object',
386
+ description: 'All storage space info of this dataset',
387
+ properties: {
388
+ size: {
389
+ type: 'integer'
390
+ },
391
+ dataFiles: {
392
+ type: 'array',
393
+ description: 'Le tableau de résultats.',
394
+ items: {
395
+ type: 'object',
396
+ properties: {
397
+ key: {
398
+ type: 'string'
399
+ },
400
+ size: {
401
+ type: 'number'
402
+ },
403
+ name: {
404
+ type: 'string'
405
+ },
406
+ mimetype: {
407
+ type: 'string'
408
+ },
409
+ updatedAt: {
410
+ type: 'string',
411
+ format: 'date-time'
412
+ },
413
+ title: {
414
+ type: 'string'
415
+ },
416
+ url: {
417
+ type: 'string'
418
+ }
419
+ }
420
+ }
421
+ }
422
+ }
423
+ },
424
+ count: {
425
+ type: 'number',
426
+ description: 'The number of rowns'
427
+ }
428
+ }
429
+ }
430
+ }
431
+ }
package/types/datafairSchemas/schema.json DELETED
@@ -1,425 +0,0 @@
1
- {
2
- "$id": "https://github.com/data-fair/catalog-data-fair/catalog-schemas",
3
- "x-exports": [
4
- "types"
5
- ],
6
- "title": "DataFair Catalog",
7
- "type": "object",
8
- "additionalProperties": false,
9
- "required": [
10
- "count",
11
- "results"
12
- ],
13
- "properties": {
14
- "count": {
15
- "type": "number",
16
- "description": "Nombre total de jeux de données"
17
- },
18
- "results": {
19
- "type": "array",
20
- "items": {
21
- "$ref": "#/$defs/DataFairDataset"
22
- }
23
- }
24
- },
25
- "$defs": {
26
- "DataFairDataset": {
27
- "type": "object",
28
- "required": [
29
- "id",
30
- "title"
31
- ],
32
- "properties": {
33
- "id": {
34
- "type": "string",
35
- "description": "Globally unique identifier of the dataset"
36
- },
37
- "href": {
38
- "type": "string",
39
- "description": "Readonly field. The URL where this resource can be fetched"
40
- },
41
- "page": {
42
- "type": "string",
43
- "description": "Readonly field. The URL where this resource can be viewed in the UI"
44
- },
45
- "title": {
46
- "type": "string",
47
- "description": "Short title of the dataset"
48
- },
49
- "description": {
50
- "type": "string",
51
- "description": "Detailed description of the dataset"
52
- },
53
- "keywords": {
54
- "type": "array",
55
- "description": "keywords",
56
- "items": {
57
- "type": "string"
58
- }
59
- },
60
- "frequency": {
61
- "type": "string",
62
- "description": "update frequency",
63
- "enum": [
64
- "",
65
- "triennial",
66
- "biennial",
67
- "annual",
68
- "semiannual",
69
- "threeTimesAYear",
70
- "quarterly",
71
- "bimonthly",
72
- "monthly",
73
- "semimonthly",
74
- "biweekly",
75
- "threeTimesAMonth",
76
- "weekly",
77
- "semiweekly",
78
- "threeTimesAWeek",
79
- "daily",
80
- "continuous",
81
- "irregular"
82
- ]
83
- },
84
- "analysis": {
85
- "type": "object",
86
- "properties": {
87
- "escapeKeyAlgorithm": {
88
- "type": "string",
89
- "enum": ["compat-ods"]
90
- }
91
- }
92
- },
93
- "projection": {
94
- "type": "object",
95
- "properties": {
96
- "code": { "type": "string" },
97
- "title": { "type": "string" }
98
- }
99
- },
100
- "file": {
101
- "type": "object",
102
- "required": [
103
- "size"
104
- ],
105
- "properties": {
106
- "size": {
107
- "type": "number",
108
- "description": "Size of the file on disk"
109
- }
110
- }
111
- },
112
- "originalFile": {
113
- "type": "object",
114
- "required": [
115
- "size"
116
- ],
117
- "properties": {
118
- "size": {
119
- "type": "number",
120
- "description": "Size of the file on disk"
121
- }
122
- }
123
- },
124
- "image": {
125
- "type": "string",
126
- "description": "URL d'une image, illustration du jeu de données"
127
- },
128
- "schema": {
129
- "type": "array",
130
- "description": "JSON schema properties of the fields",
131
- "items": {
132
- "type": "object",
133
- "required": [
134
- "key"
135
- ],
136
- "properties": {
137
- "key": {
138
- "type": "string",
139
- "readOnly": true,
140
- "x-display": "hidden"
141
- },
142
- "type": {
143
- "type": "string"
144
- },
145
- "format": {
146
- "type": [
147
- "string",
148
- "null"
149
- ]
150
- },
151
- "x-originalName": {
152
- "type": [
153
- "string",
154
- "null"
155
- ]
156
- },
157
- "title": {
158
- "type": "string"
159
- },
160
- "description": {
161
- "type": "string"
162
- },
163
- "icon": {
164
- "type": "string"
165
- },
166
- "x-group": {
167
- "type": "string"
168
- },
169
- "x-refersTo": {
170
- "deprecated": true,
171
- "type": [
172
- "string",
173
- "null"
174
- ]
175
- },
176
- "x-concept": {
177
- "type": "object",
178
- "properties": {
179
- "id": {
180
- "type": "string"
181
- },
182
- "title": {
183
- "type": "string"
184
- },
185
- "primary": {
186
- "type": "boolean"
187
- }
188
- }
189
- },
190
- "x-calculated": {
191
- "type": "boolean"
192
- },
193
- "x-capabilities": {
194
- "type": "object",
195
- "properties": {
196
- "index": {
197
- "type": "boolean",
198
- "default": true,
199
- "x-display": "switch",
200
- "title": "Filtrable sur valeur exacte",
201
- "description": "Désactivez cette capacité si la donnée contient par exemple des textes longs pour lesquels des filtres sur valeurs exactes ont peu de sens."
202
- },
203
- "values": {
204
- "type": "boolean",
205
- "default": true,
206
- "x-display": "switch",
207
- "title": "Triable et groupable",
208
- "description": "Désactivez cette capacité si la donnée contient par exemple des textes longs pour lesquels trier ou grouper par valeur a peu de sens."
209
- },
210
- "textStandard": {
211
- "type": "boolean",
212
- "default": true,
213
- "x-display": "switch",
214
- "title": "Texte analysé pour recherche textuelle",
215
- "description": "Désactivez cette capacité dans le cas d'un code, une url, etc. N'importe quel contenu sur lequel la recherche de mots a peu de sens."
216
- },
217
- "text": {
218
- "type": "boolean",
219
- "default": true,
220
- "x-display": "switch",
221
- "title": "Texte analysé spécifiquement pour la langue française",
222
- "description": "Désactivez cette capacité pour tout contenu qui n'est pas en langue française ou pour lequel la recherche de mots a peu de sens."
223
- },
224
- "textAgg": {
225
- "type": "boolean",
226
- "default": false,
227
- "x-display": "switch",
228
- "title": "Statistiques de mots",
229
- "description": "Activez cette capacité si avez l'intention d'obtenir des statistiques sur les occurrences de mots (par exemple pour construire un nuage de mot)."
230
- },
231
- "wildcard": {
232
- "type": "boolean",
233
- "default": false,
234
- "x-display": "switch",
235
- "title": "Texte filtrable sur groupe de caractères",
236
- "description": "Activez cette capacité si vous avez l'intention de filtrer ce contenu spécifiquement sur une suite de caractères (par exemple si un filtre sur mots entiers ou sur valeur exacte ne convient pas)."
237
- },
238
- "insensitive": {
239
- "type": "boolean",
240
- "default": true,
241
- "x-display": "switch",
242
- "title": "Tri amélioré avec casse et accents",
243
- "description": "Désactivez cette capacité si le contenu ne sera pas utilisé pour du tri ou bien si il ne contient pas de variations avec accents et majuscules."
244
- },
245
- "geoShape": {
246
- "type": "boolean",
247
- "default": true,
248
- "x-display": "switch",
249
- "title": "Formes géométriques complexes",
250
- "description": "Désactivez cette capacité si la donnée ne contient que des géométries basiques de points ou bien si requêter les géométries uniquement à partir de leurs centroïdes est suffisant pour vos besoins."
251
- },
252
- "vtPrepare": {
253
- "type": "boolean",
254
- "default": false,
255
- "x-display": "switch",
256
- "title": "Tuiles vectorielles préparées",
257
- "description": "Activez cette capacité pour précalculer des éléments utiles à la construction de tuiles vectorielles pour le rendu cartographique du jeu de données. Activez cette option si le jeu de données contient des données géogreaphiques denses à afficher en grande quantité. La contre-partie est une augmentation du temps d'indexation et du volume de données indexées."
258
- },
259
- "indexAttachment": {
260
- "type": "boolean",
261
- "default": true,
262
- "x-display": "switch",
263
- "title": "Contenu des pièces jointes analysé pour recherche textuelle",
264
- "description": "Désactivez cette option si vous souhaitez que les pièces jointes soient simplement téléchargeables et que l'extraction de leur contenu textuel pour recherche de mots n'est pas pertinente."
265
- }
266
- }
267
- },
268
- "x-labels": {
269
- "type": "object",
270
- "patternProperties": {
271
- ".*": {
272
- "type": "string"
273
- }
274
- }
275
- },
276
- "x-labelsRestricted": {
277
- "type": "boolean"
278
- },
279
- "readOnly": {
280
- "type": "boolean"
281
- },
282
- "x-required": {
283
- "type": "boolean"
284
- },
285
- "minLength": {
286
- "type": "integer"
287
- },
288
- "maxLength": {
289
- "type": "integer"
290
- },
291
- "minimum": {
292
- "type": "number"
293
- },
294
- "maximum": {
295
- "type": "number"
296
- },
297
- "pattern": {
298
- "type": "string",
299
- "format": "regex"
300
- },
301
- "patternErrorMessage": {
302
- "type": "string"
303
- },
304
- "x-master": {
305
- "type": "object",
306
- "properties": {
307
- "id": {
308
- "type": "string"
309
- },
310
- "title": {
311
- "type": "string"
312
- },
313
- "remoteService": {
314
- "type": "string",
315
- "description": "L'identifiant du service distant utilisé pour l'enrichissement"
316
- },
317
- "action": {
318
- "type": "string",
319
- "description": "L'identifiant de l'action du service distant à utiliser pour l'enrichissement"
320
- }
321
- }
322
- },
323
- "x-display": {
324
- "type": "string"
325
- },
326
- "enum": {
327
- "type": "array",
328
- "readOnly": true,
329
- "description": "This differs from JSON schema. It is not a restriction, just and observation of the values that are present in the dataset."
330
- },
331
- "x-cardinality": {
332
- "type": "integer",
333
- "description": "The number of distinct values for this field",
334
- "readOnly": true
335
- },
336
- "x-transform": {
337
- "type": "object",
338
- "description": "Transformation to apply to the field",
339
- "properties": {
340
- "expr": {
341
- "type": "string"
342
- },
343
- "examples": {
344
- "type": "array",
345
- "items": {
346
- "type": "string"
347
- }
348
- },
349
- "type": {
350
- "type": "string"
351
- },
352
- "format": {
353
- "type": "string"
354
- }
355
- }
356
- }
357
- }
358
- }
359
- },
360
- "storage": {
361
- "type": "object",
362
- "description": "All storage space info of this dataset",
363
- "properties": {
364
- "size": {
365
- "type": "integer"
366
- },
367
- "dataFiles": {
368
- "type": "array",
369
- "description": "Le tableau de résultats.",
370
- "items": {
371
- "type": "object",
372
- "properties": {
373
- "key": {
374
- "type": "string"
375
- },
376
- "size": {
377
- "type": "number"
378
- },
379
- "name": {
380
- "type": "string"
381
- },
382
- "mimetype": {
383
- "type": "string"
384
- },
385
- "updatedAt": {
386
- "type": "string",
387
- "format": "date-time"
388
- },
389
- "title": {
390
- "type": "string"
391
- },
392
- "url": {
393
- "type": "string"
394
- }
395
- }
396
- }
397
- }
398
- }
399
- },
400
- "count": {
401
- "type": "number",
402
- "description": "The number of rowns"
403
- },
404
- "license": {
405
- "type": "object",
406
- "additionalProperties": false,
407
- "required": [
408
- "title",
409
- "href"
410
- ],
411
- "properties": {
412
- "title": {
413
- "type": "string",
414
- "description": "Short title for the license"
415
- },
416
- "href": {
417
- "type": "string",
418
- "description": "The URL where the license can be read"
419
- }
420
- }
421
- }
422
- }
423
- }
424
- }
425
- }