| GET | /status |
|---|
const std = @import("std");
pub const HealthStatus = enum {
Unhealthy,
Degraded,
Healthy,
};
pub const HealthCheckReportEntry = struct {
key: ?[]const u8 = null,
description: ?[]const u8 = null,
duration: ?[]const u8 = null,
status: ?HealthStatus = null,
@"error": ?[]const u8 = null,
};
pub const HealthCheckReport = struct {
status: ?HealthStatus = null,
duration: ?[]const u8 = null,
version: ?[]const u8 = null,
buildDate: ?[]const u8 = null,
entries: ?[]HealthCheckReportEntry = null,
};
pub const HealthResponse = struct {
result: ?HealthCheckReport = null,
};
pub const HealthRequest = struct {};
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /status HTTP/1.1 Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
result:
{
status: Unhealthy,
duration: PT0S,
version: String,
buildDate: String
}
}