120 lines
5.4 KiB
JSON
120 lines
5.4 KiB
JSON
{
|
|
"summary": "Health service",
|
|
"description": "This service end point is to discover the health of the\nservice. The information provides an overall health\nand also health individual upstream dependencies.\n\n# Security\n\nThe service is secured to stop abuse.",
|
|
"get": {
|
|
"tags": [
|
|
"Draft"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/health-model"
|
|
},
|
|
"examples": {
|
|
"Simple-health": {
|
|
"value": {
|
|
"status": "PASS",
|
|
"version": "some text",
|
|
"notes": [
|
|
"some text",
|
|
"some text"
|
|
],
|
|
"output": "some text",
|
|
"description": "some text",
|
|
"checks": {},
|
|
"release_id": "some text",
|
|
"service_id": "some text",
|
|
"links": [
|
|
{
|
|
"href": "some text",
|
|
"rel": "some text",
|
|
"operation": "PUT",
|
|
"caption": "some text",
|
|
"media_type": "some text"
|
|
},
|
|
{
|
|
"href": "some text",
|
|
"rel": "some text",
|
|
"operation": "POST",
|
|
"caption": "some text",
|
|
"media_type": "some text"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "The service is healthy"
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error-model"
|
|
},
|
|
"examples": {
|
|
"health500error": {
|
|
"value": {
|
|
"status": "some text",
|
|
"message": "some text",
|
|
"resolution": "some text",
|
|
"technical": "some text"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "Internal error with service, with minimal\ninformation available"
|
|
},
|
|
"503": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/health-model"
|
|
},
|
|
"examples": {
|
|
"ealth503error": {
|
|
"value": {
|
|
"status": "FAIL",
|
|
"version": "some text",
|
|
"notes": [
|
|
"some text",
|
|
"some text"
|
|
],
|
|
"output": "some text",
|
|
"description": "some text",
|
|
"checks": {},
|
|
"release_id": "some text",
|
|
"service_id": "some text",
|
|
"links": [
|
|
{
|
|
"href": "some text",
|
|
"rel": "some text",
|
|
"operation": "GET",
|
|
"caption": "some text",
|
|
"media_type": "some text"
|
|
},
|
|
{
|
|
"href": "some text",
|
|
"rel": "some text",
|
|
"operation": "DELETE",
|
|
"caption": "some text",
|
|
"media_type": "some text"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "The service is unavailable"
|
|
}
|
|
},
|
|
"operationId": "health-get",
|
|
"summary": "Retrieve the health of the Investment Product service",
|
|
"description": "Gets the health of the service"
|
|
}
|
|
} |