gitea-sdk/docs/MiscellaneousApi.md

\MiscellaneousApi

All URIs are relative to http://localhost/api/v1

Method	HTTP request	Description
GetSigningKey	Get /signing-key.gpg	Get default signing-key.gpg
GetVersion	Get /version	Returns the version of the Gitea application
RenderMarkdown	Post /markdown	Render a markdown document as HTML
RenderMarkdownRaw	Post /markdown/raw	Render raw markdown as HTML

GetSigningKey

string GetSigningKey(ctx, ) Get default signing-key.gpg

Required Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token

HTTP request headers

• Content-Type: application/json, text/plain
• Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetVersion

ServerVersion GetVersion(ctx, ) Returns the version of the Gitea application

Required Parameters

This endpoint does not need any parameter.

Return type

ServerVersion

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token

HTTP request headers

• Content-Type: application/json, text/plain
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RenderMarkdown

string RenderMarkdown(ctx, optional) Render a markdown document as HTML

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*RenderMarkdownOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RenderMarkdownOpts struct

Name	Type	Description	Notes
body	optional.Interface of MarkdownOption

Return type

string

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RenderMarkdownRaw

string RenderMarkdownRaw(ctx, body) Render raw markdown as HTML

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	string	Request body to render

Return type

string

Authorization

AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, Token

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]