mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-26 00:46:22 +02:00
Add AsyncAPI spec for websocket (#613)
* AsyncAPI for websocket docs * Delete old docs * Update docs/README.md to point to docs site * Add generated API docs
This commit is contained in:
parent
fce43ae035
commit
8a17375603
110 changed files with 8325 additions and 23324 deletions
32
specs/websocket/components/messages/ServiceResponse.yaml
Normal file
32
specs/websocket/components/messages/ServiceResponse.yaml
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
name: ServiceResponse
|
||||
title: Service Response Message
|
||||
summary: Successful response from any TrustGraph service
|
||||
description: |
|
||||
Generic response message from any TrustGraph service.
|
||||
|
||||
The `response` field payload varies by service and matches the REST API response body schema.
|
||||
|
||||
For streaming services, multiple messages with the same `id` may be sent.
|
||||
|
||||
payload:
|
||||
$ref: '../schemas/ResponseEnvelope.yaml'
|
||||
|
||||
examples:
|
||||
- name: Config service response
|
||||
summary: List of flow configurations
|
||||
payload:
|
||||
id: req-1
|
||||
response:
|
||||
type: flow
|
||||
keys:
|
||||
- my-flow
|
||||
- production-flow
|
||||
|
||||
- name: Agent streaming response
|
||||
summary: Agent answer chunk
|
||||
payload:
|
||||
id: req-2
|
||||
response:
|
||||
chunk-type: answer
|
||||
content: Quantum computing uses quantum mechanical phenomena...
|
||||
end-of-stream: false
|
||||
Loading…
Add table
Add a link
Reference in a new issue