Class SpecificationApi

SpecificationApi - object-oriented interface

Export

SpecificationApi

Hierarchy

BaseAPI
- SpecificationApi

Index

Constructors

Properties

axios basePath configuration

Methods

getDocs getSwagger

Constructors

constructor

new SpecificationApi(configuration?, basePath?, axios?): SpecificationApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns SpecificationApi
Inherited from BaseAPI.constructor
- Defined in xchainjs-lib/packages/xchain-midgard/src/generated/midgardApi/base.ts:52

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

getDocs

getDocs(options?): Promise<AxiosResponse<void, any>>
Swagger/OpenAPI 3.0 specification generated documents.
Parameters
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Documentation

Throws
Memberof
SpecificationApi
- Defined in xchainjs-lib/packages/xchain-midgard/src/generated/midgardApi/api.ts:4569

getSwagger

getSwagger(options?): Promise<AxiosResponse<void, any>>
Returns human and machine readable swagger/openapi specification
Parameters
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Swagger File

Throws
Memberof
SpecificationApi
- Defined in xchainjs-lib/packages/xchain-midgard/src/generated/midgardApi/api.ts:4580

Generated using TypeDoc