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
37
specs/websocket/components/schemas/ErrorEnvelope.yaml
Normal file
37
specs/websocket/components/schemas/ErrorEnvelope.yaml
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
type: object
|
||||
description: |
|
||||
WebSocket error message envelope.
|
||||
|
||||
Sent when a request fails. Contains the request ID and error details.
|
||||
required:
|
||||
- id
|
||||
- error
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: |
|
||||
Request identifier from the original request that failed.
|
||||
examples:
|
||||
- req-123
|
||||
- request-abc-456
|
||||
error:
|
||||
type: object
|
||||
description: Error information
|
||||
required:
|
||||
- type
|
||||
- message
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
description: Error type/category
|
||||
examples:
|
||||
- gateway-error
|
||||
- service-error
|
||||
- timeout
|
||||
message:
|
||||
type: string
|
||||
description: Human-readable error message
|
||||
examples:
|
||||
- Flow not found
|
||||
- Service timeout
|
||||
- Invalid request format
|
||||
Loading…
Add table
Add a link
Reference in a new issue