Class MiscellaneousApi

MiscellaneousApi - object-oriented interface

export

Hierarchy

BaseAPI
- MiscellaneousApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: Configuration

Methods

getNodeInfo

getNodeInfo(options?: AxiosRequestConfig): Promise<AxiosResponse<NodeInfo>>

- Defined in apis/miscellaneous-api.ts:469
summary
Returns the nodeinfo of the Gitea application

throws
{RequiredError}

memberof
MiscellaneousApi

Parameters
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<NodeInfo>>

getSigningKey

getSigningKey(options?: AxiosRequestConfig): Promise<AxiosResponse<string>>

- Defined in apis/miscellaneous-api.ts:480
summary
Get default signing-key.gpg

throws
{RequiredError}

memberof
MiscellaneousApi

Parameters
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<string>>

getVersion

getVersion(options?: AxiosRequestConfig): Promise<AxiosResponse<ServerVersion>>

- Defined in apis/miscellaneous-api.ts:491
summary
Returns the version of the Gitea application

throws
{RequiredError}

memberof
MiscellaneousApi

Parameters
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<ServerVersion>>

renderMarkdown

renderMarkdown(requestParameters?: MiscellaneousApiRenderMarkdownRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<string>>

- Defined in apis/miscellaneous-api.ts:503
summary
Render a markdown document as HTML

throws
{RequiredError}

memberof
MiscellaneousApi

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

renderMarkdownRaw

renderMarkdownRaw(requestParameters: MiscellaneousApiRenderMarkdownRawRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<string>>

- Defined in apis/miscellaneous-api.ts:515
summary
Render raw markdown as HTML

throws
{RequiredError}

memberof
MiscellaneousApi

Parameters
- requestParameters: MiscellaneousApiRenderMarkdownRawRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<string>>

Generated using TypeDoc