@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
70 lines • 3.15 kB
TypeScript
import type { AgrSiteClient } from '../client';
type ExecuteRequest = AgrSiteClient['executeRequest'];
/**
* Creates the healthCheck resource methods
* OpenAPI Path: /health-check → healthCheck.*
* @description Health check endpoint for AGR-Site service
*/
export declare function createHealthCheckResource(executeRequest: ExecuteRequest): {
/**
* Check service health and availability
* @description Service health check endpoint that validates AGR-Site API availability and operational status
* @fullPath api.agrSite.healthCheck.get
* @service agr-site
* @domain service-monitoring
* @dataMethod healthCheckData.get - returns only the health status data without metadata
* @discoverable true
* @searchTerms ["health check", "service status", "API health", "monitoring", "uptime", "service availability"]
* @relatedEndpoints ["api.agrSite.settings.list", "api.agrSite.fyxerTranscript.list", "api.agrSite.openSearch.embedding.get"]
* @commonPatterns ["Check service health", "Monitor API status", "Validate service availability", "Health monitoring"]
* @workflow ["service-monitoring", "health-checks", "system-diagnostics"]
* @prerequisites ["Network connectivity to AGR-Site service"]
* @nextSteps ["Service-specific operations if healthy", "Error handling if unhealthy"]
* @businessRules ["No authentication required", "Returns standardized health status", "Includes dependency checks"]
* @functionalArea "service-monitoring"
* @caching "No caching for real-time health status"
* @performance "Fast response for monitoring systems, typically <100ms"
* @returns Promise<BaseResponse<HealthCheckData>> Complete response with health status and service diagnostics
* @example
* ```typescript
* const health = await client.healthCheck.get();
* const healthData = await client.healthCheckData.get();
*
* if (health.status === 200) {
* console.log('AGR-Site service is healthy');
* console.log('Site ID:', health.data.siteId);
* console.log('Site Hash:', health.data.siteHash);
* }
* ```
*/
get: () => Promise<{
params: Record<string, unknown> | unknown[];
data: {
siteHash: string;
siteId: 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 data without response metadata
* @returns Promise<HealthCheckData> Health status data directly
*/
get: () => Promise<{
siteHash: string;
siteId: string;
}>;
};
export type HealthCheckResource = ReturnType<typeof createHealthCheckResource>;
export type HealthCheckDataResource = ReturnType<typeof createHealthCheckDataResource>;
export {};
//# sourceMappingURL=health-check.d.ts.map