@simpleapps-com/augur-api/dist/esm/services/orders/resources/health-check.js

TypeScript client library for Augur microservices API endpoints

import { HealthCheckResponseSchema } from '../schemas';
/**
 * Creates the healthCheck resource methods
 * OpenAPI Path: /health-check → healthCheck.*
 * @description Service health and status monitoring endpoint
 */
export 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(HealthCheckResponseSchema),
    };
}
/**
 * Creates the healthCheckData resource methods (data-only versions)
 */
export 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