-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathopenapi.yaml
More file actions
658 lines (634 loc) · 18 KB
/
openapi.yaml
File metadata and controls
658 lines (634 loc) · 18 KB
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
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
openapi: 3.1.0
info:
title: Samyama Graph Database API
version: 0.7.0
description: |
HTTP API for the Samyama high-performance distributed graph database.
Supports OpenCypher queries, graph status, and CRUD operations.
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8080
description: Local development server
paths:
/api/query:
post:
operationId: executeQuery
summary: Execute a Cypher query
description: |
Execute an OpenCypher query against the graph database.
Supports both read (MATCH) and write (CREATE, SET, DELETE, MERGE) queries.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryRequest'
examples:
matchAll:
summary: Match all Person nodes
value:
query: "MATCH (n:Person) RETURN n"
matchWithFilter:
summary: Match with WHERE filter
value:
query: "MATCH (n:Person) WHERE n.age > 25 RETURN n.name, n.age"
createNode:
summary: Create a new node
value:
query: 'CREATE (n:Person {name: "Alice", age: 30})'
traversal:
summary: Traverse relationships
value:
query: "MATCH (a:Person)-[:KNOWS]->(b:Person) RETURN a.name, b.name"
responses:
'200':
description: Query executed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResponse'
'400':
description: Query error (parse error, execution error)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/schema:
get:
operationId: getSchema
summary: Get graph schema
description: |
Returns the full schema of the graph database including node types with
property keys/types, edge types with source/target labels, indexes,
constraints, and basic statistics.
responses:
'200':
description: Graph schema
content:
application/json:
schema:
$ref: '#/components/schemas/SchemaResponse'
/api/import/csv:
post:
operationId: importCsv
summary: Import nodes from CSV
description: |
Upload a CSV file to create nodes. The first row is treated as column headers
(property names). Each subsequent row creates one node with the specified label.
Property types are auto-detected (integer → float → boolean → string).
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
required:
- file
- label
properties:
file:
type: string
description: CSV file content
label:
type: string
description: Node label to assign to all created nodes
id_column:
type: string
description: Column to use as node ID mapping (optional)
delimiter:
type: string
description: "CSV delimiter character (default: ',')"
graph:
type: string
description: "Target graph/tenant name (default: 'default')"
responses:
'200':
description: Import successful
content:
application/json:
schema:
$ref: '#/components/schemas/CsvImportResponse'
'400':
description: Import error (missing fields, parse error)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/import/json:
post:
operationId: importJson
summary: Import nodes from JSON
description: |
Create nodes from an array of JSON objects. Each object becomes one node
with the specified label. Object keys become property names; values must be
string, number, or boolean (other types are silently skipped).
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/JsonImportRequest'
example:
label: Person
nodes:
- name: Alice
age: 30
- name: Bob
age: 25
responses:
'200':
description: Import successful
content:
application/json:
schema:
$ref: '#/components/schemas/JsonImportResponse'
'400':
description: Import error (missing label, invalid data)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/status:
get:
operationId: getStatus
summary: Get server status
description: Returns the health status, version, and storage statistics of the database.
responses:
'200':
description: Server status
content:
application/json:
schema:
$ref: '#/components/schemas/StatusResponse'
example:
status: healthy
version: 0.7.0
storage:
nodes: 2000
edges: 11000
/api/tenants:
get:
operationId: listTenants
summary: List all tenants
description: Returns all configured tenants with their settings and quotas.
responses:
'200':
description: List of tenants
content:
application/json:
schema:
type: object
properties:
tenants:
type: array
items:
$ref: '#/components/schemas/Tenant'
post:
operationId: createTenant
summary: Create a new tenant
description: Create a new tenant with optional resource quotas.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTenantRequest'
example:
id: analytics
name: Analytics Team
responses:
'201':
description: Tenant created
content:
application/json:
schema:
$ref: '#/components/schemas/Tenant'
'409':
description: Tenant already exists
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/tenants/{id}:
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Tenant ID
get:
operationId: getTenant
summary: Get a tenant
description: Returns a single tenant by ID.
responses:
'200':
description: Tenant details
content:
application/json:
schema:
$ref: '#/components/schemas/Tenant'
'404':
description: Tenant not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
operationId: deleteTenant
summary: Delete a tenant
description: Delete a tenant by ID. The "default" tenant cannot be deleted.
responses:
'200':
description: Tenant deleted
content:
application/json:
schema:
type: object
properties:
status:
type: string
id:
type: string
'403':
description: Cannot delete default tenant
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Tenant not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
patch:
operationId: updateTenant
summary: Update tenant settings
description: |
Update a tenant's enabled status, resource quotas, or configuration.
Only provided fields are updated; omitted fields remain unchanged.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTenantRequest'
responses:
'200':
description: Updated tenant
content:
application/json:
schema:
$ref: '#/components/schemas/Tenant'
'404':
description: Tenant not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/tenants/{id}/usage:
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Tenant ID
get:
operationId: getTenantUsage
summary: Get tenant resource usage
description: Returns current resource usage for a tenant (nodes, edges, memory, storage, connections).
responses:
'200':
description: Resource usage
content:
application/json:
schema:
$ref: '#/components/schemas/UsageResponse'
'404':
description: Tenant not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
QueryRequest:
type: object
required:
- query
properties:
query:
type: string
description: An OpenCypher query string
examples:
- "MATCH (n:Person) RETURN n"
graph:
type: string
description: "Target graph/tenant name (default: 'default')"
default: default
QueryResponse:
type: object
properties:
nodes:
type: array
description: Graph nodes referenced in the result (for visualization)
items:
$ref: '#/components/schemas/GraphNode'
edges:
type: array
description: Graph edges referenced in the result (for visualization)
items:
$ref: '#/components/schemas/GraphEdge'
columns:
type: array
description: Column names for the tabular result
items:
type: string
records:
type: array
description: Tabular result rows, one array per record
items:
type: array
items: {}
GraphNode:
type: object
properties:
id:
type: string
description: Node ID
labels:
type: array
items:
type: string
description: Node labels
properties:
type: object
additionalProperties: true
description: Node properties
GraphEdge:
type: object
properties:
id:
type: string
description: Edge ID
source:
type: string
description: Source node ID
target:
type: string
description: Target node ID
type:
type: string
description: Relationship type
properties:
type: object
additionalProperties: true
description: Edge properties
StatusResponse:
type: object
properties:
status:
type: string
description: Server health status
examples:
- healthy
version:
type: string
description: Server version
examples:
- 0.7.0
storage:
type: object
properties:
nodes:
type: integer
description: Number of nodes in the graph
edges:
type: integer
description: Number of edges in the graph
SchemaResponse:
type: object
properties:
node_types:
type: array
items:
type: object
properties:
label:
type: string
count:
type: integer
properties:
type: object
additionalProperties:
type: string
description: "Property type: String, Integer, Float, Boolean, Vector, Unknown"
edge_types:
type: array
items:
type: object
properties:
type:
type: string
count:
type: integer
source_labels:
type: array
items:
type: string
target_labels:
type: array
items:
type: string
properties:
type: object
additionalProperties:
type: string
indexes:
type: array
items:
type: object
properties:
label:
type: string
property:
type: string
type:
type: string
constraints:
type: array
items:
type: object
properties:
label:
type: string
property:
type: string
type:
type: string
statistics:
type: object
properties:
total_nodes:
type: integer
total_edges:
type: integer
avg_out_degree:
type: number
JsonImportRequest:
type: object
required:
- label
- nodes
properties:
label:
type: string
description: Node label to assign to all created nodes
nodes:
type: array
description: Array of JSON objects, each becoming a node
items:
type: object
additionalProperties: true
graph:
type: string
description: "Target graph/tenant name (default: 'default')"
default: default
CsvImportResponse:
type: object
properties:
status:
type: string
examples:
- ok
nodes_created:
type: integer
label:
type: string
columns:
type: array
items:
type: string
JsonImportResponse:
type: object
properties:
status:
type: string
examples:
- ok
nodes_created:
type: integer
label:
type: string
ErrorResponse:
type: object
properties:
error:
type: string
description: Error message
Tenant:
type: object
properties:
id:
type: string
description: Tenant ID (unique identifier)
name:
type: string
description: Display name
enabled:
type: boolean
description: Whether the tenant is enabled
created_at:
type: integer
description: Creation timestamp (Unix seconds)
quotas:
$ref: '#/components/schemas/ResourceQuotas'
nlq_config:
type: object
nullable: true
description: NLQ configuration
agent_config:
type: object
nullable: true
description: Agent configuration
embed_config:
type: object
nullable: true
description: Auto-embed configuration
ResourceQuotas:
type: object
properties:
max_nodes:
type: integer
nullable: true
description: Maximum number of nodes
max_edges:
type: integer
nullable: true
description: Maximum number of edges
max_memory_bytes:
type: integer
nullable: true
description: Maximum memory in bytes
max_storage_bytes:
type: integer
nullable: true
description: Maximum storage in bytes
max_connections:
type: integer
nullable: true
description: Maximum concurrent connections
max_query_time_ms:
type: integer
nullable: true
description: Maximum query execution time in milliseconds
CreateTenantRequest:
type: object
required:
- id
- name
properties:
id:
type: string
description: Tenant ID (unique)
name:
type: string
description: Display name
quotas:
$ref: '#/components/schemas/ResourceQuotas'
UpdateTenantRequest:
type: object
properties:
enabled:
type: boolean
description: Enable or disable the tenant
quotas:
$ref: '#/components/schemas/ResourceQuotas'
nlq_config:
type: object
description: NLQ configuration
agent_config:
type: object
description: Agent configuration
embed_config:
type: object
description: Auto-embed configuration
UsageResponse:
type: object
properties:
tenant_id:
type: string
node_count:
type: integer
edge_count:
type: integer
memory_bytes:
type: integer
storage_bytes:
type: integer
active_connections:
type: integer