mirror of
https://github.com/Dictionarry-Hub/profilarr.git
synced 2026-01-22 19:01:02 +01:00
456ecc298b
- Implemented health check endpoint to monitor application status and components. - Added OpenAPI specification endpoint to serve the API documentation. - Introduced new TypeScript definitions for API paths and components.
36 lines
920 B
YAML
36 lines
920 B
YAML
health:
|
|
get:
|
|
operationId: getHealth
|
|
summary: Health check
|
|
description: |
|
|
Returns the health status of the application and its components.
|
|
|
|
Status values:
|
|
- `healthy`: All components functioning normally
|
|
- `degraded`: Core functionality works but some components have issues
|
|
- `unhealthy`: Core functionality is broken
|
|
tags:
|
|
- System
|
|
responses:
|
|
'200':
|
|
description: Health check response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/health.yaml#/HealthResponse'
|
|
|
|
openapi:
|
|
get:
|
|
operationId: getOpenApiSpec
|
|
summary: OpenAPI specification
|
|
description: Returns the OpenAPI specification for this API
|
|
tags:
|
|
- System
|
|
responses:
|
|
'200':
|
|
description: OpenAPI specification
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|