mirror of
https://github.com/Dictionarry-Hub/profilarr.git
synced 2026-01-27 05:00:53 +01:00
45 lines
1.1 KiB
YAML
45 lines
1.1 KiB
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
|
|
|
|
Use `?verbose=true` for detailed component information.
|
|
tags:
|
|
- System
|
|
parameters:
|
|
- name: verbose
|
|
in: query
|
|
description: Include detailed component information
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
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
|