Class CatalogApi

CatalogApi - object-oriented interface

export

Hierarchy

BaseAPI
- CatalogApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CatalogApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): CatalogApi

Inherited from BaseAPI.constructor
- Defined in base.ts:52
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns CatalogApi

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: Configuration

Methods

catalogGetEntry

catalogGetEntry(requestParameters: CatalogApiCatalogGetEntryRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CatalogEntry>>

- Defined in apis/catalog-api.ts:1278
summary
Catalog entry

throws
{RequiredError}

memberof
CatalogApi

Parameters
- requestParameters: CatalogApiCatalogGetEntryRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<CatalogEntry>>

catalogGetMetadata

catalogGetMetadata(requestParameters: CatalogApiCatalogGetMetadataRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<{}>>

- Defined in apis/catalog-api.ts:1290
summary
Catalog entry metadata (manifest.yaml in JSON format)

throws
{RequiredError}

memberof
CatalogApi

Parameters
- requestParameters: CatalogApiCatalogGetMetadataRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<{}>>

catalogSearch

catalogSearch(requestParameters?: CatalogApiCatalogSearchRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CatalogSearchResults>>

- Defined in apis/catalog-api.ts:1302
summary
Catalog search

throws
{RequiredError}

memberof
CatalogApi

Parameters
- requestParameters: CatalogApiCatalogSearchRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<CatalogSearchResults>>

catalogSearchOwner

catalogSearchOwner(requestParameters: CatalogApiCatalogSearchOwnerRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CatalogSearchResults>>

- Defined in apis/catalog-api.ts:1314
summary
Catalog search by owner

throws
{RequiredError}

memberof
CatalogApi

Parameters
- requestParameters: CatalogApiCatalogSearchOwnerRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<CatalogSearchResults>>

catalogSearchRepo

catalogSearchRepo(requestParameters: CatalogApiCatalogSearchRepoRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CatalogSearchResults>>

- Defined in apis/catalog-api.ts:1326
summary
Catalog search by repo

throws
{RequiredError}

memberof
CatalogApi

Parameters
- requestParameters: CatalogApiCatalogSearchRepoRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<CatalogSearchResults>>

Generated using TypeDoc