@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
47 lines • 1.98 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.createHealthCheckResource = createHealthCheckResource;
exports.createHealthCheckDataResource = createHealthCheckDataResource;
const schemas_1 = require("../schemas");
/**
* Creates the healthCheck resource methods
* OpenAPI Path: /health-check → healthCheck.*
* @description Service health and status monitoring endpoint
*/
function createHealthCheckResource(createHealthCheckMethod) {
return {
/**
* Health check endpoint
* @description Service health and status monitoring endpoint for system diagnostics and uptime verification
*
* @fullPath api.orders.healthCheck.get
* @service orders
* @domain system-monitoring
* @dataMethod healthCheckData.get - returns only the health check data without metadata
* @discoverable true
* @searchTerms ["health check", "service status", "orders health", "system status"]
* @relatedEndpoints ["api.joomla.healthCheck.get", "api.nexus.healthCheck.get", "api.items.healthCheck.get"]
* @commonPatterns ["Check service health", "System monitoring", "Service status"]
* @workflow ["system-monitoring", "health-diagnostics"]
* @functionalArea "system-operations"
* @performance "Lightweight endpoint for monitoring - minimal response time"
*/
get: createHealthCheckMethod(schemas_1.HealthCheckResponseSchema),
};
}
/**
* Creates the healthCheckData resource methods (data-only versions)
*/
function createHealthCheckDataResource(healthCheck) {
return {
/**
* Get only health check data without response metadata
* @returns Promise<HealthCheckData> Direct health check data object
*/
get: async () => {
const response = await healthCheck.get();
return response.data;
},
};
}
//# sourceMappingURL=health-check.js.map