@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
54 lines • 2.16 kB
TypeScript
import type { AgrInfoClient } from '../client';
type ExecuteRequest = AgrInfoClient['executeRequest'];
/**
* Creates the healthCheck resource methods
* OpenAPI Path: /health-check → healthCheck.*
* @description Health check endpoint for AGR Info service
*/
export declare function createHealthCheckResource(executeRequest: ExecuteRequest): {
/**
* Check service health and availability
*
* @fullPath api.agrInfo.healthCheck.get
* @service agr-info
* @domain system-health
* @dataMethod healthCheckData.get
* @discoverable true
* @searchTerms ["health", "status", "availability", "ping", "check"]
* @relatedEndpoints ["api.customers.healthCheck.get", "api.commerce.healthCheck.get", "api.items.healthCheck.get"]
* @commonPatterns ["Health check", "Service status", "API availability"]
* @workflow ["system-monitoring", "health-checks", "service-discovery"]
* @prerequisites ["Service is running"]
* @nextSteps ["Use other endpoints if healthy"]
* @businessRules ["Returns service status and basic info"]
* @functionalArea "system-monitoring"
* @caching "No caching - real-time status"
* @performance "Fast response, minimal processing"
*
* @returns Promise<HealthCheckResponse> Service health status
*/
get: () => Promise<{
params: Record<string, unknown> | unknown[];
data: string;
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
};
/**
* Creates the healthCheckData resource methods (data-only versions)
*/
export declare function createHealthCheckDataResource(healthCheck: ReturnType<typeof createHealthCheckResource>): {
/**
* Get health check status data only
* @returns Promise<string> Health status string
*/
get: () => Promise<string>;
};
export type HealthCheckResource = ReturnType<typeof createHealthCheckResource>;
export type HealthCheckDataResource = ReturnType<typeof createHealthCheckDataResource>;
export {};
//# sourceMappingURL=health-check.d.ts.map