-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathapi_doc.json
471 lines (469 loc) · 18.2 KB
/
api_doc.json
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
{"swagger": "2.0",
"produces": [
"application/json"
],
"info": {
"version": "0.5.8",
"title": "Data Catalog API",
"description": "Enables search, retrieval and storageof metadata describing data sets."
},
"paths": {
"/rest/datasets": {
"get": {
"responses": {
"200": {
"description": "Result queries returned.",
"schema": {
"$ref": "#/definitions/SearchHits"
}
},
"400": {
"description": "Invalid or malformed query."
},
"500": {
"description": "Internal error."
}
},
"parameters": [
{
"name": "onlyPrivate",
"required": false,
"in": "query",
"type": "boolean",
"description": "Returns a list of the private data sets only"
},
{
"name": "query",
"required": false,
"in": "query",
"type": "string",
"description": "A query JSON object."
},
{
"name": "onlyPublic",
"required": false,
"in": "query",
"type": "boolean",
"description": "Returns a list of the public data sets only."
},
{
"name": "orgs",
"required": false,
"in": "query",
"type": "array",
"items": {
"type": "string"
},
"description": "A list of org UUIDs."
}
],
"tags": [
"rest/datasets"
],
"description": "Query should be in this format:\n{\n \"query\": SEARCH_TEXT,\n \"filters\":[\n {FILTERED_FIELD_NAME: [FIELD_VALUE_1, FIELD_VALUE_1]}\n ],\n \"from\": FROM_HIT_NUMBER,\n \"size\": NUMBER_OF_HITS\n}\n\nAll query fields are optional.\nWhen filtering by time ranges, you must supply exactly two filter field values.\n-1 can be used as infinity.\n\n\"from\" and \"size\" are used for pagination of search queries.\nIf we get 20 hits for a query, we can set \"from\" and \"size\" to 10\nto get the second half of hits.\n\nFilter examples:\n\n{\"creationTime\": [-1, \"2015-02-24T14:56\"]} <- all until 2015-02-24T14:56\n{\"format\": [\"csv\", \"json\"]} <- all CSV and JSON data sets\n\nField 'orgs' should be in a form of a list of org uuids separated with a coma\nexample: orguuid-01,oruuid-02\n\nFields 'onlyPublic' and 'onlyPrivate' should have boolean value (true or false).\nIn addition to a query, they allow to choose only private data sets or only public ones.\nThey are mutually exclusive!\n\nConsumer of this endpoint must have a valid OAuth token. Also, user has to be a member of the organization owning the data sets. This doesn't concern admins (console.admin in token's scope) who always have access. Moreover an admin owning the data sets being targeted by this request receives data from all orgs.",
"summary": "Do a search for data sets",
"operationId": "get_data_set_search_resource"
}
},
"/rest/datasets/count": {
"get": {
"tags": [
"rest/datasets"
],
"operationId": "get_data_set_count_resource",
"description": "Consumer of this endpoint must have a valid OAuth token. Also, user has to be a member of the organization owning the data sets. This doesn't concern admins (console.admin in token's scope) who always have access. Moreover an admin owning the data sets being targeted by this request receives data from all orgs.",
"responses": {
"200": {
"description": "Data set count returned.",
"schema": {
"type": "integer"
}
}
},
"parameters": [
{
"name": "onlyPrivate",
"required": false,
"in": "query",
"type": "boolean",
"description": "Returns a list of the private data sets only"
},
{
"name": "orgs",
"required": false,
"in": "query",
"type": "array",
"items": {
"type": "string"
},
"description": "A list of org UUIDs."
},
{
"name": "onlyPublic",
"required": false,
"in": "query",
"type": "boolean",
"description": "Returns a list of the public data sets only."
}
],
"summary": "Get the number of current data sets in the index per organisation"
}
},
"/rest/datasets/{entry_id}": {
"put": {
"responses": {
"200": {
"description": "Entry updated."
},
"201": {
"description": "Entry created."
},
"400": {
"description": "Putting data set in index failed: malformed data in meta data fields."
},
"403": {
"description": "Forbidden access to required organisation"
},
"503": {
"description": "Putting data set in index failed: failed to connect to ElasticSearch."
}
},
"parameters": [
{
"name": "entry_id",
"required": true,
"in": "path",
"type": "string",
"description": "ID of a metadata entry (data set)."
},
{
"required": true,
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/InputMetadataEntry"
},
"description": "JSON-formatted metadata entry."
}
],
"tags": [
"rest/datasets"
],
"summary": "Puts a metadata entry in the search index under the given ID",
"consumes": [
"application/x-www-form-urlencoded",
"multipart/form-data"
],
"description": "Consumer of this endpoint must have a valid OAuth token. Also, user has to be a member of the organization owning the data sets. This doesn't concern admins (console.admin in token's scope) who always have access.",
"operationId": "put_metadata_entry_resource"
},
"post": {
"responses": {
"200": {
"description": "Data set attributes are updated."
},
"400": {
"description": "Wrong input data."
},
"403": {
"description": "Forbidden access to the resource"
},
"404": {
"description": "No entry with the given ID found."
}
},
"parameters": [
{
"name": "entry_id",
"required": true,
"in": "path",
"type": "string",
"description": "ID of a metadata entry (data set)."
},
{
"required": true,
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/InputMetadataEntry"
},
"description": "Attributes with values to change."
}
],
"tags": [
"rest/datasets"
],
"description": "The body of the POST method should be formed in a following way:\n\n{\n \"argumentName\": [\"value01\", \"value02\"]\n}\n\nThe value of a given argument will replace current value for this argument\nin the specified metadata entry.\n\nExample:\n{\n \"title\": \"A new, better title for this data set!\"\n}\n\nConsumer of this endpoint must have a valid OAuth token. Also, user has to be a member of the organization owning the data set. This doesn't concern admins (console.admin in token's scope) who always have access.",
"summary": "Updates specified attributes of metadata entry with the given ID",
"operationId": "post_metadata_entry_resource"
},
"delete": {
"tags": [
"rest/datasets"
],
"description": "Consumer of this endpoint must have a valid OAuth token. Also, user has to be a member of the organization owning the data sets. This doesn't concern admins (console.admin in token's scope) who always have access.",
"operationId": "delete_metadata_entry_resource",
"responses": {
"200": {
"description": "Entry has been removed from Elastic Search. Status of deletion from external services is in response's body",
"schema": {
"$ref": "#/definitions/DeleteResponse"
}
},
"401": {
"description": "Authorization header not found."
},
"403": {
"description": "Forbidden access to the resource"
},
"404": {
"description": "No entry with the given ID found."
},
"503": {
"description": "Problem connecting to ElasticSearch."
}
},
"parameters": [
{
"name": "entry_id",
"required": true,
"in": "path",
"type": "string",
"description": "ID of the metadata entry describing some data set."
}
],
"summary": "Deletes a metadata entry labeled with the given ID"
},
"get": {
"tags": [
"rest/datasets"
],
"description": "Consumer of this endpoint must have a valid OAuth token. Also, user has to be a member of the organization owning the data sets. This doesn't concern admins (console.admin in token's scope) who always have access.",
"operationId": "get_metadata_entry_resource",
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/QueryHit"
}
},
"403": {
"description": "Forbidden access to the resource"
},
"404": {
"description": "No entry with the given ID found."
},
"503": {
"description": "Problem while connecting to the index."
}
},
"parameters": [
{
"name": "entry_id",
"required": true,
"in": "path",
"type": "string",
"description": "ID of the metadata entry describing some data set."
}
],
"summary": "Gets a metadata entry labeled with the given ID"
}
}
},
"responses": {},
"tags": [
{
"name": "default",
"description": "Default namespace"
},
{
"name": "rest/datasets",
"description": "Data Catalog - enables search, retrieval and storage of metadata describing data sets."
}
],
"basePath": "/",
"definitions": {
"SearchHits": {
"required": [
"categories",
"formats",
"hits",
"total"
],
"properties": {
"hits": {
"items": {
"$ref": "#/definitions/InputMetadataEntryWithID"
},
"type": "array"
},
"total": {
"type": "integer"
},
"categories": {
"items": {
"type": "string"
},
"type": "array"
},
"formats": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"QueryHit": {
"required": [
"_id",
"_index",
"_source",
"_type",
"_version",
"found"
],
"properties": {
"_type": {
"type": "string"
},
"_index": {
"type": "string"
},
"_source": {
"$ref": "#/definitions/InputMetadataEntry"
},
"_version": {
"type": "integer"
},
"found": {
"type": "boolean"
},
"_id": {
"type": "string"
}
}
},
"InputMetadataEntryWithID": {
"required": [
"category",
"dataSample",
"format",
"id",
"isPublic",
"orgUUID",
"recordCount",
"size",
"sourceUri",
"targetUri",
"title"
],
"properties": {
"category": {
"type": "string"
},
"dataSample": {
"type": "string"
},
"sourceUri": {
"type": "string"
},
"format": {
"type": "string"
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"isPublic": {
"type": "boolean"
},
"orgUUID": {
"type": "string"
},
"targetUri": {
"type": "string"
},
"recordCount": {
"type": "integer"
},
"title": {
"type": "string"
},
"id": {
"type": "string"
},
"size": {
"type": "integer"
}
}
},
"DeleteResponse": {
"required": [
"deleted_from_downloader",
"deleted_from_publisher"
],
"properties": {
"deleted_from_publisher": {
"type": "boolean"
},
"deleted_from_downloader": {
"type": "boolean"
}
}
},
"InputMetadataEntry": {
"required": [
"category",
"dataSample",
"format",
"isPublic",
"orgUUID",
"recordCount",
"size",
"sourceUri",
"targetUri",
"title"
],
"properties": {
"category": {
"type": "string"
},
"dataSample": {
"type": "string"
},
"sourceUri": {
"type": "string"
},
"format": {
"type": "string"
},
"orgUUID": {
"type": "string"
},
"isPublic": {
"type": "boolean"
},
"creationTime": {
"type": "string",
"format": "date-time"
},
"targetUri": {
"type": "string"
},
"recordCount": {
"type": "integer"
},
"title": {
"type": "string"
},
"size": {
"type": "integer"
}
}
}
},
"consumes": [
"application/json"
]
}