Class HealthApi

HealthApi - object-oriented interface

Export

HealthApi

Hierarchy

BaseAPI
- HealthApi

Index

Constructors

Properties

axios basePath configuration

Methods

Constructors

constructor

new HealthApi(configuration?, basePath?, axios?): HealthApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns HealthApi
Inherited from BaseAPI.constructor
- Defined in openapi/base.ts:53

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

healthcheck

healthcheck(options?): Promise<AxiosResponse<HealthcheckResponse, any>>
Parameters
- Optional options: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<HealthcheckResponse, any>>
Summary
Describes the health of Fishjam

Throws
Memberof
HealthApi
- Defined in openapi/api.ts:1144