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
24
specs/api/components/schemas/rag/GraphRagResponse.yaml
Normal file
24
specs/api/components/schemas/rag/GraphRagResponse.yaml
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
type: object
|
||||
description: Graph RAG response
|
||||
properties:
|
||||
response:
|
||||
type: string
|
||||
description: Generated response based on retrieved knowledge graph
|
||||
example: Quantum physics and computer science intersect in quantum computing...
|
||||
end-of-stream:
|
||||
type: boolean
|
||||
description: Indicates streaming is complete (streaming mode)
|
||||
default: false
|
||||
example: true
|
||||
error:
|
||||
type: object
|
||||
description: Error details if request failed
|
||||
properties:
|
||||
message:
|
||||
type: string
|
||||
description: Error message
|
||||
example: Failed to retrieve graph data
|
||||
type:
|
||||
type: string
|
||||
description: Error type
|
||||
example: GRAPH_ERROR
|
||||
Loading…
Add table
Add a link
Reference in a new issue