@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
52 lines • 2.33 kB
JavaScript
import { HealthCheckResponseSchema } from '../schemas';
/**
* Creates the healthCheck resource methods
* OpenAPI Path: /health-check → healthCheck.*
* @description Health check endpoint for P21 APIs service
*/
export function createHealthCheckResource(executeRequest) {
return {
/**
* Perform health check to verify P21 APIs service status and connectivity
* @description Returns service health status and configuration information for monitoring and diagnostics. Essential for verifying P21 system connectivity and service availability.
*
* @fullPath api.p21Apis.healthCheck.get
* @service p21-apis
* @domain system-monitoring
* @dataMethod healthCheckData.get
* @discoverable true
* @searchTerms ["health check", "service status", "system monitor", "service availability", "connectivity test"]
* @relatedEndpoints ["api.p21Core.healthCheck.get", "system monitoring endpoints"]
* @commonPatterns ["Check service health", "Monitor system status", "Verify connectivity", "Service diagnostics"]
* @workflow ["system-monitoring", "health-verification", "service-diagnostics"]
* @prerequisites ["Site ID configuration", "System access"]
* @nextSteps ["Service remediation if unhealthy", "Integration health checks"]
* @businessRules ["Returns service configuration", "Site-specific health status", "Authentication verification"]
* @functionalArea "system-monitoring"
* @performance "Lightweight check, immediate response"
*/
get: async () => {
return executeRequest({
method: 'GET',
path: '/health-check',
responseSchema: HealthCheckResponseSchema,
}, undefined);
},
};
}
/**
* 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 status object
*/
get: async () => {
const response = await healthCheck.get();
return response.data;
},
};
}
//# sourceMappingURL=health-check.js.map