cberg/src/docs/MiscellaneousApi.md

Node.js Client for the Codeberg API

# MiscellaneousApi

All URIs are relative to */api/v1*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getGitignoreTemplateInfo**](#getgitignoretemplateinfo) | **GET** /gitignore/templates/{name} | Returns information about a gitignore template|
|[**getLabelTemplateInfo**](#getlabeltemplateinfo) | **GET** /label/templates/{name} | Returns all labels in a template|
|[**getLicenseTemplateInfo**](#getlicensetemplateinfo) | **GET** /licenses/{name} | Returns information about a license template|
|[**getNodeInfo**](#getnodeinfo) | **GET** /nodeinfo | Returns the nodeinfo of the Forgejo application|
|[**getSSHSigningKey**](#getsshsigningkey) | **GET** /signing-key.ssh | Get default signing-key.ssh|
|[**getSigningKey**](#getsigningkey) | **GET** /signing-key.gpg | Get default signing-key.gpg|
|[**getVersion**](#getversion) | **GET** /version | Returns the version of the running application|
|[**listGitignoresTemplates**](#listgitignorestemplates) | **GET** /gitignore/templates | Returns a list of all gitignore templates|
|[**listLabelTemplates**](#listlabeltemplates) | **GET** /label/templates | Returns a list of all label templates|
|[**listLicenseTemplates**](#listlicensetemplates) | **GET** /licenses | Returns a list of all license templates|
|[**renderMarkdown**](#rendermarkdown) | **POST** /markdown | Render a markdown document as HTML|
|[**renderMarkdownRaw**](#rendermarkdownraw) | **POST** /markdown/raw | Render raw markdown as HTML|
|[**renderMarkup**](#rendermarkup) | **POST** /markup | Render a markup document as HTML|

# **getGitignoreTemplateInfo**
> GitignoreTemplateInfo getGitignoreTemplateInfo()


### Example

```typescript
import {
    MiscellaneousApi,
    Configuration
} from 'berg';

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

let name: string; //name of the template (default to undefined)

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **name** | [**string**] | name of the template | defaults to undefined|


### Return type

**GitignoreTemplateInfo**

### Authorization

[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | GitignoreTemplateInfo |  -  |
|**404** | APINotFound is a not found error 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)

# **getLabelTemplateInfo**
> Array<LabelTemplate> getLabelTemplateInfo()


### Example

```typescript
import {
    MiscellaneousApi,
    Configuration
} from 'berg';

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

let name: string; //name of the template (default to undefined)

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **name** | [**string**] | name of the template | defaults to undefined|


### Return type

**Array<LabelTemplate>**

### Authorization

[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | LabelTemplateInfo |  -  |
|**404** | APINotFound is a not found error 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)

# **getLicenseTemplateInfo**
> LicenseTemplateInfo getLicenseTemplateInfo()


### Example

```typescript
import {
    MiscellaneousApi,
    Configuration
} from 'berg';

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

let name: string; //name of the license (default to undefined)

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **name** | [**string**] | name of the license | defaults to undefined|


### Return type

**LicenseTemplateInfo**

### Authorization

[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | LicenseTemplateInfo |  -  |
|**404** | APINotFound is a not found error 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)

# **getNodeInfo**
> NodeInfo getNodeInfo()


### Example

```typescript
import {
    MiscellaneousApi,
    Configuration
} from 'berg';

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

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

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


### Return type

**NodeInfo**

### Authorization

[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)

### HTTP request headers

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


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

[[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)

# **getSSHSigningKey**
> string getSSHSigningKey()


### Example

```typescript
import {
    MiscellaneousApi,
    Configuration
} from 'berg';

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

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

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


### Return type

**string**

### Authorization

[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: text/plain


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | SSH public key in OpenSSH authorized key format |  -  |
|**404** | APINotFound is a not found error 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)

# **getSigningKey**
> string getSigningKey()


### Example

```typescript
import {
    MiscellaneousApi,
    Configuration
} from 'berg';

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

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

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


### Return type

**string**

### Authorization

[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: text/plain


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | GPG armored public key |  -  |

[[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)

# **getVersion**
> ServerVersion getVersion()


### Example

```typescript
import {
    MiscellaneousApi,
    Configuration
} from 'berg';

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

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

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


### Return type

**ServerVersion**

### Authorization

[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)

### HTTP request headers

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


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

[[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)

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


### Example

```typescript
import {
    MiscellaneousApi,
    Configuration
} from 'berg';

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

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

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


### Return type

**Array<string>**

### Authorization

[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)

### HTTP request headers

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


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

[[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)

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


### Example

```typescript
import {
    MiscellaneousApi,
    Configuration
} from 'berg';

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

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

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


### Return type

**Array<string>**

### Authorization

[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)

### HTTP request headers

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


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

[[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)

# **listLicenseTemplates**
> Array<LicensesTemplateListEntry> listLicenseTemplates()


### Example

```typescript
import {
    MiscellaneousApi,
    Configuration
} from 'berg';

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

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

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


### Return type

**Array<LicensesTemplateListEntry>**

### Authorization

[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)

### HTTP request headers

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


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

[[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)

# **renderMarkdown**
> string renderMarkdown()


### Example

```typescript
import {
    MiscellaneousApi,
    Configuration,
    MarkdownOption
} from 'berg';

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

let body: MarkdownOption; // (optional)

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **MarkdownOption**|  | |


### Return type

**string**

### Authorization

[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: text/html


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | MarkdownRender is a rendered markdown document |  -  |
|**422** | APIValidationError is error format response related to input validation |  -  |

[[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)

# **renderMarkdownRaw**
> string renderMarkdownRaw(body)


### Example

```typescript
import {
    MiscellaneousApi,
    Configuration
} from 'berg';

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

let body: string; //Request body to render

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **string**| Request body to render | |


### Return type

**string**

### Authorization

[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)

### HTTP request headers

 - **Content-Type**: text/plain
 - **Accept**: text/html


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | MarkdownRender is a rendered markdown document |  -  |
|**422** | APIValidationError is error format response related to input validation |  -  |

[[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)

# **renderMarkup**
> string renderMarkup()


### Example

```typescript
import {
    MiscellaneousApi,
    Configuration,
    MarkupOption
} from 'berg';

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

let body: MarkupOption; // (optional)

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **MarkupOption**|  | |


### Return type

**string**

### Authorization

[TOTPHeader](../README.md#TOTPHeader), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [SudoHeader](../README.md#SudoHeader), [BasicAuth](../README.md#BasicAuth), [AccessToken](../README.md#AccessToken), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: text/html


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | MarkupRender is a rendered markup document |  -  |
|**422** | APIValidationError is error format response related to input validation |  -  |

[[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)