Skip to content

Commit d8c71ed

Browse files
committed
add zip upload twingraph description to dataset upload
1 parent 3f9caab commit d8c71ed

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

dataset/src/main/openapi/dataset.yaml

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,34 @@ paths:
265265
tags:
266266
- dataset
267267
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.
268+
description: |
269+
To create a new graph from flat files, you need to create a Zip file. This Zip
270+
file must countain two folders named Edges and Nodes.
271+
272+
.zip hierarchy:
273+
*main_folder/Nodes
274+
*main_folder/Edges
275+
276+
In each folder you can place one or multiple csv files containing your Nodes or
277+
Edges data.
278+
279+
Your csv files must follow the following header (column name) requirements:
280+
281+
The Nodes CSVs requires at least one column (the 1st).Column name = 'id'. It
282+
will represent the nodes ID
283+
Ids must be populated with string
284+
285+
The Edges CSVs require three columns named, in order,
286+
* source
287+
* target
288+
* id
289+
290+
those colomns represent
291+
* The source of the edge
292+
* The target of the edge
293+
* The id of the edge
294+
295+
All following columns content are up to you.
269296
requestBody:
270297
required: true
271298
content:

0 commit comments

Comments
 (0)