seahaven-ap/packages/api/openapi/components/schemas.yaml

84 lines
1.8 KiB
YAML
Raw Normal View History

Error:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
- correlationId
properties:
code:
type: string
description: Machine-readable error code.
example: NOT_FOUND
message:
type: string
description: Human-readable error message.
example: Not found.
correlationId:
type: string
description: Request correlation identifier echoed from x-correlation-id when present.
example: 11111111-1111-4111-8111-111111111111
HealthResponse:
type: object
required:
- stage
- sha
properties:
stage:
type: string
description: Deployment stage name.
example: local
sha:
type: string
description: Git SHA inlined at image build.
example: deadbeef
ReadyResponse:
type: object
required:
- status
- database
properties:
status:
type: string
description: Process readiness marker.
example: ok
database:
type: string
description: Database ping result.
example: up
MeResponse:
type: object
required:
- id
- email
- name
- role
properties:
id:
type: string
format: uuid
description: Internal user primary key.
example: 11111111-1111-4111-8111-111111111111
email:
type: string
format: email
description: Caller email address.
example: admin@seahavenind.com
name:
type: string
description: Display name for the caller.
example: Dev Admin
role:
type: string
description: Authorization role for RBAC checks.
enum:
- admin
- ap_processor
- approver
- viewer
example: admin