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
23
specs/api/components/responses/Error.yaml
Normal file
23
specs/api/components/responses/Error.yaml
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
description: Error response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
error:
|
||||
oneOf:
|
||||
- type: string
|
||||
description: Simple error message
|
||||
- $ref: '../schemas/errors/ErrorObject.yaml'
|
||||
description: Structured error with type and message
|
||||
examples:
|
||||
simpleError:
|
||||
summary: Simple error message
|
||||
value:
|
||||
error: Invalid flow ID
|
||||
structuredError:
|
||||
summary: Structured error
|
||||
value:
|
||||
error:
|
||||
type: gateway-error
|
||||
message: Timeout
|
||||
Loading…
Add table
Add a link
Reference in a new issue