Skip to content

Commit 5bf2e20

Browse files
committed
LKE-14245: Post-review
1 parent 447e247 commit 5bf2e20

File tree

4 files changed

+9
-4
lines changed

4 files changed

+9
-4
lines changed

src/api/GraphEdge/index.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,9 @@ export class GraphEdgeAPI extends Request {
6363
}
6464

6565
/**
66-
* Add a chunk of edges to the graph.
66+
* Add a chunk of edges to the graph. Optionally accepts an import ID parameter. If it is
67+
* provided, the edges are linked to this import (via a hidden property). Otherwise, the
68+
* edges are created without any link.
6769
*/
6870
public bulkCreateEdges(params: BulkCreateEdgesParams) {
6971
return this.request({

src/api/GraphEdge/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,6 @@ export interface IDeleteEdgeParams extends IDataSourceParams {
2929
}
3030

3131
export interface BulkCreateEdgesParams extends IDataSourceParams {
32-
nodes: Omit<ICreateEdgeParams, 'sourceKey'>;
32+
edges: Omit<ICreateEdgeParams, 'sourceKey'>;
3333
importId?: number;
3434
}

src/api/GraphNode/index.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,9 @@ export class GraphNodeAPI extends Request {
100100
}
101101

102102
/**
103-
* Add a chunk of nodes to the graph.
103+
* Add a chunk of nodes to the graph. Optionally accepts an import ID parameter. If it is
104+
* provided, the nodes are linked to this import (via a hidden property). Otherwise, the
105+
* nodes are created without any link.
104106
*/
105107
public bulkCreateNodes(params: BulkCreateNodesParams) {
106108
return this.request({

src/api/import/index.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ export class ImportAPI extends Request {
2727
}
2828

2929
/**
30-
* List all the existing imports.
30+
* List all the existing imports (for the current user if they are not admin, or for all users
31+
* if the current user is an admin).
3132
*/
3233
getImports(this: Request<{items: Import[]}>) {
3334
return this.request({

0 commit comments

Comments
 (0)