mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-25 08:26:21 +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
55
specs/websocket/components/messages/ServiceRequest.yaml
Normal file
55
specs/websocket/components/messages/ServiceRequest.yaml
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
name: ServiceRequest
|
||||
title: Service Request Message
|
||||
summary: Request message for any TrustGraph service
|
||||
description: |
|
||||
Generic request message that can invoke any TrustGraph service.
|
||||
|
||||
The `request` field payload varies by service and matches the REST API request body schema.
|
||||
|
||||
payload:
|
||||
description: Service request envelope with id, service, optional flow, and service-specific request payload
|
||||
oneOf:
|
||||
# Global services (no flow parameter)
|
||||
- $ref: './requests/ConfigRequest.yaml'
|
||||
- $ref: './requests/FlowRequest.yaml'
|
||||
- $ref: './requests/LibrarianRequest.yaml'
|
||||
- $ref: './requests/KnowledgeRequest.yaml'
|
||||
- $ref: './requests/CollectionManagementRequest.yaml'
|
||||
|
||||
# Flow-hosted services (require flow parameter)
|
||||
- $ref: './requests/AgentRequest.yaml'
|
||||
- $ref: './requests/DocumentRagRequest.yaml'
|
||||
- $ref: './requests/GraphRagRequest.yaml'
|
||||
- $ref: './requests/TextCompletionRequest.yaml'
|
||||
- $ref: './requests/PromptRequest.yaml'
|
||||
- $ref: './requests/EmbeddingsRequest.yaml'
|
||||
- $ref: './requests/McpToolRequest.yaml'
|
||||
- $ref: './requests/TriplesRequest.yaml'
|
||||
- $ref: './requests/ObjectsRequest.yaml'
|
||||
- $ref: './requests/NlpQueryRequest.yaml'
|
||||
- $ref: './requests/StructuredQueryRequest.yaml'
|
||||
- $ref: './requests/StructuredDiagRequest.yaml'
|
||||
- $ref: './requests/GraphEmbeddingsRequest.yaml'
|
||||
- $ref: './requests/DocumentEmbeddingsRequest.yaml'
|
||||
- $ref: './requests/TextLoadRequest.yaml'
|
||||
- $ref: './requests/DocumentLoadRequest.yaml'
|
||||
|
||||
examples:
|
||||
- name: Config service request
|
||||
summary: List all flow configurations
|
||||
payload:
|
||||
id: req-1
|
||||
service: config
|
||||
request:
|
||||
operation: list
|
||||
type: flow
|
||||
|
||||
- name: Agent service request
|
||||
summary: Ask question to agent
|
||||
payload:
|
||||
id: req-2
|
||||
service: agent
|
||||
flow: my-flow
|
||||
request:
|
||||
question: What is quantum computing?
|
||||
streaming: true
|
||||
Loading…
Add table
Add a link
Reference in a new issue