GET | /status |
---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
class HealthStatus(str, Enum):
UNHEALTHY = 'Unhealthy'
DEGRADED = 'Degraded'
HEALTHY = 'Healthy'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HealthCheckReportEntry:
key: Optional[str] = None
description: Optional[str] = None
duration: datetime.timedelta = datetime.timedelta()
status: Optional[HealthStatus] = None
error: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HealthCheckReport:
status: Optional[HealthStatus] = None
duration: datetime.timedelta = datetime.timedelta()
version: Optional[str] = None
build_date: Optional[str] = None
entries: Optional[List[HealthCheckReportEntry]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HealthResponse:
result: Optional[HealthCheckReport] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HealthRequest(IGet):
pass
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"result":{"status":"Unhealthy","duration":"PT0S","version":"String","buildDate":"String"}}