# DiscoveryApi

All URIs are relative to *http://localhost*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getExampleConfig**](#getexampleconfig) | **GET** /api/discovery/example-config | Get Endpoint|
|[**getFilterTypes**](#getfiltertypes) | **GET** /api/discovery/filter-types | Get Endpoint|
|[**getHookTypes**](#gethooktypes) | **GET** /api/discovery/hook-types | Get Endpoint|
|[**getPluginSummary**](#getpluginsummary) | **GET** /api/discovery/plugins | Get Endpoint|
|[**listComponents**](#listcomponents) | **GET** /api/discovery/components | Get Endpoint|
|[**listDataLoaders**](#listdataloaders) | **GET** /api/discovery/data-loaders | Get Endpoint|
|[**listExampleConfigs**](#listexampleconfigs) | **GET** /api/discovery/example-configs | Get Endpoint|
|[**listFilters**](#listfilters) | **GET** /api/discovery/filters | Get Endpoint|
|[**listHooks**](#listhooks) | **GET** /api/discovery/hooks | Get Endpoint|
|[**listModelLoaders**](#listmodelloaders) | **GET** /api/discovery/model-loaders | Get Endpoint|
|[**listPostprocessors**](#listpostprocessors) | **GET** /api/discovery/postprocessors | Get Endpoint|
|[**listPredictors**](#listpredictors) | **GET** /api/discovery/predictors | Get Endpoint|

# **getExampleConfig**
> ExampleConfigDetail getExampleConfig()

Gets one usable example config by id.

### Example

```typescript
import {
    DiscoveryApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new DiscoveryApi(configuration);

let id: string; //Example config id (default to undefined)

const { status, data } = await apiInstance.getExampleConfig(
    id
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**string**] | Example config id | defaults to undefined|


### Return type

**ExampleConfigDetail**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getFilterTypes**
> Array<string> getFilterTypes()

Lists all available filter types.

### Example

```typescript
import {
    DiscoveryApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new DiscoveryApi(configuration);

const { status, data } = await apiInstance.getFilterTypes();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**Array<string>**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getHookTypes**
> Array<string> getHookTypes()

Lists all available hook types.

### Example

```typescript
import {
    DiscoveryApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new DiscoveryApi(configuration);

const { status, data } = await apiInstance.getHookTypes();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**Array<string>**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getPluginSummary**
> PluginSummaryResponse getPluginSummary()

Lists all available plugins by type.

### Example

```typescript
import {
    DiscoveryApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new DiscoveryApi(configuration);

let plugin: string; //Filter components by plugin name (optional) (default to undefined)

const { status, data } = await apiInstance.getPluginSummary(
    plugin
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **plugin** | [**string**] | Filter components by plugin name | (optional) defaults to undefined|


### Return type

**PluginSummaryResponse**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **listComponents**
> ComponentsResponse listComponents()

Lists all available components. No input required for this GET endpoint.

### Example

```typescript
import {
    DiscoveryApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new DiscoveryApi(configuration);

let plugin: string; //Filter by plugin name (optional) (default to undefined)

const { status, data } = await apiInstance.listComponents(
    plugin
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **plugin** | [**string**] | Filter by plugin name | (optional) defaults to undefined|


### Return type

**ComponentsResponse**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **listDataLoaders**
> Array<HandlerEntry> listDataLoaders()

Lists all available data loaders.

### Example

```typescript
import {
    DiscoveryApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new DiscoveryApi(configuration);

let plugin: string; //Filter by plugin name (optional) (default to undefined)

const { status, data } = await apiInstance.listDataLoaders(
    plugin
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **plugin** | [**string**] | Filter by plugin name | (optional) defaults to undefined|


### Return type

**Array<HandlerEntry>**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **listExampleConfigs**
> Array<ExampleConfigEntry> listExampleConfigs()

Lists usable example configs discovered from installed plugins.

### Example

```typescript
import {
    DiscoveryApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new DiscoveryApi(configuration);

let plugin: string; //Filter example configs by plugin name (optional) (default to undefined)

const { status, data } = await apiInstance.listExampleConfigs(
    plugin
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **plugin** | [**string**] | Filter example configs by plugin name | (optional) defaults to undefined|


### Return type

**Array<ExampleConfigEntry>**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **listFilters**
> { [key: string]: Array<CallbackEntry>; } listFilters()

Lists all available filters.

### Example

```typescript
import {
    DiscoveryApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new DiscoveryApi(configuration);

let filterType: string; //Filter by filter type (optional) (default to undefined)
let plugin: string; //Filter by plugin name (optional) (default to undefined)

const { status, data } = await apiInstance.listFilters(
    filterType,
    plugin
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **filterType** | [**string**] | Filter by filter type | (optional) defaults to undefined|
| **plugin** | [**string**] | Filter by plugin name | (optional) defaults to undefined|


### Return type

**{ [key: string]: Array<CallbackEntry>; }**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **listHooks**
> { [key: string]: Array<CallbackEntry>; } listHooks()

Lists all available hooks.

### Example

```typescript
import {
    DiscoveryApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new DiscoveryApi(configuration);

let hookType: string; //Filter by hook type (optional) (default to undefined)
let plugin: string; //Filter by plugin name (optional) (default to undefined)

const { status, data } = await apiInstance.listHooks(
    hookType,
    plugin
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **hookType** | [**string**] | Filter by hook type | (optional) defaults to undefined|
| **plugin** | [**string**] | Filter by plugin name | (optional) defaults to undefined|


### Return type

**{ [key: string]: Array<CallbackEntry>; }**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **listModelLoaders**
> Array<HandlerEntry> listModelLoaders()

Lists all available model loaders.

### Example

```typescript
import {
    DiscoveryApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new DiscoveryApi(configuration);

let plugin: string; //Filter by plugin name (optional) (default to undefined)

const { status, data } = await apiInstance.listModelLoaders(
    plugin
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **plugin** | [**string**] | Filter by plugin name | (optional) defaults to undefined|


### Return type

**Array<HandlerEntry>**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **listPostprocessors**
> Array<HandlerEntry> listPostprocessors()

Lists all available postprocessing handlers.

### Example

```typescript
import {
    DiscoveryApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new DiscoveryApi(configuration);

let plugin: string; //Filter by plugin name (optional) (default to undefined)

const { status, data } = await apiInstance.listPostprocessors(
    plugin
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **plugin** | [**string**] | Filter by plugin name | (optional) defaults to undefined|


### Return type

**Array<HandlerEntry>**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **listPredictors**
> Array<HandlerEntry> listPredictors()

Lists all available prediction handlers.

### Example

```typescript
import {
    DiscoveryApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new DiscoveryApi(configuration);

let plugin: string; //Filter by plugin name (optional) (default to undefined)

const { status, data } = await apiInstance.listPredictors(
    plugin
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **plugin** | [**string**] | Filter by plugin name | (optional) defaults to undefined|


### Return type

**Array<HandlerEntry>**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

