mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-25 00:16:23 +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
56
specs/websocket/components/schemas/RequestEnvelope.yaml
Normal file
56
specs/websocket/components/schemas/RequestEnvelope.yaml
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
type: object
|
||||
description: |
|
||||
WebSocket request message envelope.
|
||||
|
||||
Wraps service-specific request payloads with routing and correlation metadata.
|
||||
required:
|
||||
- id
|
||||
- service
|
||||
- request
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: |
|
||||
Client-generated unique identifier for this request within the WebSocket session.
|
||||
Used to correlate responses with requests in multiplexed async communication.
|
||||
Can be any string, but must be unique per active request.
|
||||
examples:
|
||||
- req-123
|
||||
- request-abc-456
|
||||
- b5f8d9a2-4c3e-11ef-9c8a-0242ac120002
|
||||
service:
|
||||
type: string
|
||||
description: |
|
||||
Service identifier. Same as {kind} in REST API URLs.
|
||||
|
||||
Global services: config, flow, librarian, knowledge, collection-management
|
||||
Flow-hosted services: agent, text-completion, prompt, document-rag, graph-rag,
|
||||
embeddings, graph-embeddings, document-embeddings, triples, objects,
|
||||
nlp-query, structured-query, structured-diag, text-load, document-load, mcp-tool
|
||||
examples:
|
||||
- config
|
||||
- agent
|
||||
- document-rag
|
||||
flow:
|
||||
type: string
|
||||
description: |
|
||||
Flow ID for flow-hosted services. Required for services accessed via
|
||||
/api/v1/flow/{flow}/service/{kind} in REST API.
|
||||
|
||||
Omit this field for global services (config, flow, librarian, knowledge, collection-management).
|
||||
examples:
|
||||
- my-flow
|
||||
- production-flow
|
||||
request:
|
||||
type: object
|
||||
description: |
|
||||
Service-specific request payload. Structure is identical to the request body
|
||||
in the corresponding REST API endpoint.
|
||||
|
||||
See OpenAPI specification for detailed schemas per service.
|
||||
examples:
|
||||
- operation: list
|
||||
type: flow
|
||||
- question: What is quantum computing?
|
||||
streaming: true
|
||||
system-prompt: You are a helpful assistant
|
||||
Loading…
Add table
Add a link
Reference in a new issue