Skip to content

Latest commit

 

History

History
90 lines (52 loc) · 1.58 KB

HealthcheckApi.md

File metadata and controls

90 lines (52 loc) · 1.58 KB

GripmockSdk.HealthcheckApi

All URIs are relative to https://raw.githubusercontent.com/api

Method HTTP request Description
liveness GET /health/liveness Liveness check
readiness GET /health/readiness Readiness check

liveness

MessageOK liveness()

Liveness check

The test says that the service is alive and yet

Example

import GripmockSdk from '@bavix/gripmock-sdk';

let apiInstance = new GripmockSdk.HealthcheckApi();
apiInstance.liveness().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

MessageOK

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

readiness

MessageOK readiness()

Readiness check

The test indicates readiness to receive traffic

Example

import GripmockSdk from '@bavix/gripmock-sdk';

let apiInstance = new GripmockSdk.HealthcheckApi();
apiInstance.readiness().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

MessageOK

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json