@simpleapps-com/augur-api/dist/cjs/services/open-search/resources/health-check.js

TypeScript client library for Augur microservices API endpoints

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.createPingResource = createPingResource;
exports.createHealthCheckResource = createHealthCheckResource;
exports.createPingDataResource = createPingDataResource;
exports.createHealthCheckDataResource = createHealthCheckDataResource;
const schemas_1 = require("../schemas");
/**
 * Creates the ping resource methods
 * OpenAPI Path: /ping → ping.*
 * @description Simple ping endpoint for connectivity testing
 */
function createPingResource(executeRequest) {
    return {
        /**
         * Simple ping endpoint - mirrors OpenAPI path /ping
         *
         * @fullPath api.openSearch.ping.get
         * @service open-search
         * @domain health-monitoring
         * @dataMethod pingData.get
         * @discoverable true
         * @searchTerms ["ping", "health", "connectivity", "status"]
         * @relatedEndpoints ["healthCheck.get"]
         * @commonPatterns ["ping service", "test connectivity"]
         *
         * @returns Promise<PingResponse> Complete response with metadata
         *
         * @example
         * ```typescript
         * const response = await api.openSearch.ping.get();
         * console.log(response.data); // "pong"
         * ```
         */
        get: async () => {
            return executeRequest({
                method: 'GET',
                path: '/ping',
                responseSchema: schemas_1.PathPingResponseSchema,
            }, undefined);
        },
    };
}
/**
 * Creates the healthCheck resource methods
 * OpenAPI Path: /health-check → healthCheck.*
 * @description Health check endpoint for service status monitoring
 */
function createHealthCheckResource(executeRequest) {
    return {
        /**
         * Health check endpoint - mirrors OpenAPI path /health-check
         *
         * @fullPath api.openSearch.healthCheck.get
         * @service open-search
         * @domain health-monitoring
         * @dataMethod healthCheckData.get
         * @discoverable true
         * @searchTerms ["health", "status", "monitoring", "check"]
         * @relatedEndpoints ["ping.get"]
         * @commonPatterns ["check service health", "service status"]
         *
         * @returns Promise<HealthCheckResponse> Complete response with health data
         *
         * @example
         * ```typescript
         * const response = await api.openSearch.healthCheck.get();
         * console.log(`Site: ${response.data.siteId}, Hash: ${response.data.siteHash}`);
         * ```
         */
        get: async () => {
            return executeRequest({
                method: 'GET',
                path: '/health-check',
                responseSchema: schemas_1.PathHealthCheckResponseSchema,
            }, undefined);
        },
    };
}
/**
 * Creates the pingData resource methods (data-only versions)
 */
function createPingDataResource(ping) {
    return {
        /**
         * Get ping data without response metadata
         * @returns Promise<unknown> Ping response data directly
         */
        get: async () => {
            const response = await ping.get();
            return response.data;
        },
    };
}
/**
 * Creates the healthCheckData resource methods (data-only versions)
 */
function createHealthCheckDataResource(healthCheck) {
    return {
        /**
         * Get health check data without response metadata
         * @returns Promise<unknown> Health status data directly
         */
        get: async () => {
            const response = await healthCheck.get();
            return response.data;
        },
    };
}
//# sourceMappingURL=health-check.js.map