REST API OpenAPI spec (#612)

* OpenAPI spec in specs/api.  Checked lint with redoc.
This commit is contained in:
cybermaggedon 2026-01-15 11:04:37 +00:00 committed by GitHub
parent 62b754d788
commit fce43ae035
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
84 changed files with 5638 additions and 0 deletions

View file

@ -0,0 +1,54 @@
type: object
description: Objects query response (GraphQL format)
properties:
data:
description: GraphQL response data (JSON object or null)
oneOf:
- type: object
additionalProperties: {}
- type: "null"
example:
person:
name: Alice
email: alice@example.com
knows:
- name: Bob
- name: Carol
errors:
type: array
description: GraphQL field-level errors
items:
type: object
properties:
message:
type: string
description: Error message
example: Cannot query field 'age' on type 'Person'
path:
type: array
description: Path to error location
items:
type: string
example: ["person", "age"]
extensions:
type: object
description: Additional error metadata
additionalProperties:
type: string
extensions:
type: object
description: Query metadata (execution time, etc.)
additionalProperties:
type: string
example:
execution_time_ms: "42"
error:
type: object
description: System-level error (connection, timeout, etc.)
properties:
type:
type: string
example: TIMEOUT_ERROR
message:
type: string
example: Query execution timeout