| GET | /status |
|---|
package dtos
import (
"time"
)
type HealthStatus string
const (
HealthStatusUnhealthy HealthStatus = "Unhealthy"
HealthStatusDegraded = "Degraded"
HealthStatusHealthy = "Healthy"
)
type HealthCheckReportEntry struct {
Key *string `json:"key,omitempty"`
Description *string `json:"description,omitempty"`
Duration time.Duration `json:"duration,omitempty"`
Status HealthStatus `json:"status,omitempty"`
Error *string `json:"error,omitempty"`
}
type HealthCheckReport struct {
Status HealthStatus `json:"status,omitempty"`
Duration time.Duration `json:"duration,omitempty"`
Version string `json:"version"`
BuildDate *string `json:"buildDate,omitempty"`
Entries []HealthCheckReportEntry `json:"entries,omitempty"`
}
type HealthResponse struct {
Result *HealthCheckReport `json:"result,omitempty"`
}
type HealthRequest struct {
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"result":{"status":"Unhealthy","duration":"PT0S","version":"String","buildDate":"String"}}