@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
58 lines • 2.06 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.createHealthCheckResource = createHealthCheckResource;
exports.createHealthCheckDataResource = createHealthCheckDataResource;
const schemas_1 = require("../schemas");
/**
* Creates the healthCheck resource methods
* OpenAPI Path: /health-check → healthCheck.*
* @description Health check endpoint for Basecamp2 service
*/
function createHealthCheckResource(executeRequest) {
return {
/**
* Check Basecamp2 service health and connectivity
*
* @fullPath api.basecamp2.healthCheck.get
* @service basecamp2
* @domain system-health
* @dataMethod healthCheckData.get
* @discoverable true
* @searchTerms ["health", "status", "availability", "ping", "check", "basecamp2 service"]
*
* @param params Health check parameters with site ID
* @returns Promise<HealthCheckResponse> Service health status
*/
get: async (params) => {
return executeRequest({
method: 'GET',
path: '/health-check',
paramsSchema: schemas_1.HealthCheckParamsSchema,
responseSchema: schemas_1.HealthCheckResponseSchema,
}, params);
},
};
}
/**
* Creates the healthCheckData resource methods (data-only versions)
*/
function createHealthCheckDataResource(healthCheck) {
return {
/**
* Get Basecamp2 service health data without full response metadata
*
* @fullPath api.basecamp2.healthCheckData.get
* @service basecamp2
* @domain system-health
* @discoverable true
*
* @param params Health check parameters with site ID
* @returns Promise<HealthCheckData> Direct health status data object
*/
get: async (params) => {
const response = await healthCheck.get(params);
return response.data;
},
};
}
//# sourceMappingURL=health-check.js.map