Devdraft::HealthResponseDto
Properties
| Name |
Type |
Description |
Notes |
| status |
String |
Overall health status of the service. Returns \“ok\” when healthy, \“error\” when issues detected. |
|
| timestamp |
Time |
ISO 8601 timestamp when the health check was performed. |
|
| version |
String |
Current version of the API service. Useful for debugging and compatibility checks. |
|
| database |
String |
Database connectivity status. Shows \“connected\” when database is accessible, \“error\” when connection fails. |
|
| message |
String |
Human-readable message describing the current health status and any issues. |
|
| authenticated |
Boolean |
Indicates whether the request was properly authenticated. Always true for this endpoint since authentication is required. |
|
Example
require 'devdraft'
instance = Devdraft::HealthResponseDto.new(
status: ok,
timestamp: 2023-07-01T12:00Z,
version: 1.0.0,
database: connected,
message: Service is up and running,
authenticated: true
)