@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
53 lines • 2.49 kB
TypeScript
import type { P21SismClient } from '../client';
type ExecuteRequest = P21SismClient['executeRequest'];
/**
* Creates the healthCheck resource methods
* OpenAPI Path: /health-check → healthCheck.*
* @description Health check endpoint for P21 SISM service
*/
export declare function createHealthCheckResource(executeRequest: ExecuteRequest): {
/**
* Perform health check to verify P21 SISM service status and connectivity
*
* @fullPath api.p21Sism.healthCheck.get
* @service p21-sism
* @domain system-monitoring
* @dataMethod healthCheckData.get
* @discoverable true
* @searchTerms ["health check", "service status", "system monitor", "service availability", "connectivity test", "SISM health"]
* @relatedEndpoints ["api.p21Core.health.check", "api.p21Sism.import.recent.list", "system monitoring endpoints"]
* @commonPatterns ["Check service health", "Monitor system status", "Verify connectivity", "Service diagnostics"]
* @workflow ["system-monitoring", "health-verification", "service-diagnostics", "integration-testing"]
* @prerequisites ["System access", "Monitoring permissions"]
* @nextSteps ["Service remediation if unhealthy", "Integration health checks", "api.p21Sism.import.stuck.list for processing issues"]
* @businessRules ["Returns site configuration", "Includes system hash for verification", "No authentication required for health check"]
* @functionalArea "system-monitoring"
* @performance "Lightweight check, immediate response, minimal system impact"
*
* @returns Promise<BaseResponse<HealthCheckResponse>> Service health status and configuration
*/
get: () => Promise<{
params: Record<string, unknown> | unknown[];
data: {} & {
[k: string]: unknown;
};
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: () => Promise<{} & {
[k: string]: unknown;
}>;
};
export type HealthCheckResource = ReturnType<typeof createHealthCheckResource>;
export type HealthCheckDataResource = ReturnType<typeof createHealthCheckDataResource>;
export {};
//# sourceMappingURL=health-check.d.ts.map