@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
43 lines • 1.27 kB
JavaScript
import { PingResponseSchema } from '../schemas';
/**
* Creates the ping resource methods
* OpenAPI Path: /ping → ping.*
* @description Simple ping endpoint for connectivity testing
*/
export function createPingResource(executeRequest) {
return {
/**
* Simple ping endpoint that doesn't require authentication
* @description Returns "pong" response for basic connectivity testing - OpenAPI path /ping
* @fullPath api.nexus.ping.get
* @service nexus
* @domain service-monitoring
* @discoverable true
* @dataMethod pingData.get
* @example
* ```typescript
* const pong = await client.ping.get();
* console.log(pong.data); // "pong"
* ```
*/
get: async () => {
return executeRequest({
method: 'GET',
path: '/ping',
responseSchema: PingResponseSchema,
});
},
};
}
/**
* Creates the pingData resource methods (data-only versions)
*/
export function createPingDataResource(ping) {
return {
get: async () => {
const response = await ping.get();
return response.data;
},
};
}
//# sourceMappingURL=ping.js.map