mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-25 08:26:21 +02:00
REST API OpenAPI spec (#612)
* OpenAPI spec in specs/api. Checked lint with redoc.
This commit is contained in:
parent
62b754d788
commit
fce43ae035
84 changed files with 5638 additions and 0 deletions
|
|
@ -0,0 +1,34 @@
|
|||
type: object
|
||||
description: Structured query response
|
||||
properties:
|
||||
data:
|
||||
description: Query results (JSON object or null)
|
||||
oneOf:
|
||||
- type: object
|
||||
additionalProperties: {}
|
||||
- type: "null"
|
||||
example:
|
||||
person:
|
||||
name: Alice
|
||||
knows:
|
||||
- name: Bob
|
||||
worksFor: {name: Acme Corp, department: Engineering}
|
||||
- name: Carol
|
||||
worksFor: {name: Tech Inc, department: Engineering}
|
||||
errors:
|
||||
type: array
|
||||
description: Query errors (array of error strings)
|
||||
items:
|
||||
type: string
|
||||
example:
|
||||
- Could not resolve field 'age' on type 'Person'
|
||||
error:
|
||||
type: object
|
||||
description: System-level error
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
example: QUERY_GENERATION_ERROR
|
||||
message:
|
||||
type: string
|
||||
example: Failed to generate query from question
|
||||
Loading…
Add table
Add a link
Reference in a new issue