Class SchemaApi

SchemaApi - object-oriented interface

Export

SchemaApi

Hierarchy

BaseAPI
- SchemaApi

Index

Constructors

Properties

axios basePath configuration

Methods

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

schemaRetrieve

schemaRetrieve(
requestParameters?: SchemaApiSchemaRetrieveRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<object, any>>
OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
Parameters
- requestParameters: SchemaApiSchemaRetrieveRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<object, any>>
Throws
Memberof
SchemaApi
- Defined in api-client/schema-api.ts:166