Skip to content

Commit 3f9caab

Browse files
committed
fix dataset endpoints descriptions
1 parent aad8a99 commit 3f9caab

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

dataset/src/main/openapi/dataset.yaml

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ paths:
118118
operationId: searchDatasets
119119
tags:
120120
- dataset
121-
summary: Search Datasets
121+
summary: Search Datasets by tags
122122
requestBody:
123123
description: the Dataset search parameters
124124
required: true
@@ -160,7 +160,8 @@ paths:
160160
operationId: copyDataset
161161
tags:
162162
- dataset
163-
summary: Copy a Dataset to another Dataset. Source must have a read capable connector and Target a write capable connector.
163+
summary: Copy a Dataset to another Dataset.
164+
description: Not implemented!
164165
requestBody:
165166
description: the Dataset copy parameters
166167
required: true
@@ -263,8 +264,8 @@ paths:
263264
operationId: uploadTwingraph
264265
tags:
265266
- dataset
266-
summary: Upload Twingraph with ZIP File
267-
description: Upload Twingraph ZIP
267+
summary: Upload data from zip file to dataset's twingraph
268+
description: Upload data from zip containing two folder 'edges' and 'nodes' themself containing nodes and edges as csv files.
268269
requestBody:
269270
required: true
270271
content:
@@ -303,10 +304,10 @@ paths:
303304
operationId: createSubDataset
304305
tags:
305306
- dataset
306-
summary: Run a query on a dataset
307-
description: Run a query on a dataset
307+
summary: Create a sub-dataset from the dataset in parameter
308+
description: Create a copy of the dataset using the results of the list of queries given in parameter.
308309
requestBody:
309-
description: the query to run
310+
description: the Cypher query to filter
310311
required: true
311312
content:
312313
application/json:
@@ -337,8 +338,8 @@ paths:
337338
operationId: refreshDataset
338339
tags:
339340
- dataset
340-
summary: Refresh dataset
341-
description: Refresh ADT, Storage dataset
341+
summary: Refresh data on dataset from dataset's source
342+
description: Lauch a import from source (ADT or Azure Storage). This replace currently stored data with just extracted data from source.
342343
responses:
343344
'200':
344345
description: Successful response
@@ -365,7 +366,7 @@ paths:
365366
operationId: twingraphQuery
366367
tags:
367368
- dataset
368-
summary: Run a query on a graph instance and return the result as a json
369+
summary: Return the result of a query made on the graph instance as a json
369370
description: Run a query on a graph instance and return the result as a json
370371
requestBody:
371372
description: the query to run
@@ -639,8 +640,8 @@ paths:
639640
operationId: downloadTwingraph
640641
tags:
641642
- dataset
642-
summary: Download a graph compressed in a zip file
643-
description: Download a graph compressed in a zip file
643+
summary: Download a graph as a zip file
644+
description: Download the compressed graph reference by the hash in a zip file
644645
responses:
645646
'200':
646647
description: Successful response
@@ -674,8 +675,8 @@ paths:
674675
operationId: getDatasetTwingraphStatus
675676
tags:
676677
- dataset
677-
summary: Get the status of twingraph import
678-
description: Get the status of a twingraph import
678+
summary: Get the dataset's refresh job status
679+
description: Get the status of the import workflow lauch on the dataset's refresh.
679680
responses:
680681
'200':
681682
description: Successful response

0 commit comments

Comments
 (0)