rusty-gitea/docs/MiscellaneousApi.md

\MiscellaneousApi

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

Method	HTTP request	Description
get_signing_key	Get /signing-key.gpg	Get default signing-key.gpg
get_version	Get /version	Returns the version of the Gitea application
render_markdown	Post /markdown	Render a markdown document as HTML
render_markdown_raw	Post /markdown/raw	Render raw markdown as HTML

get_signing_key

String get_signing_key(ctx, ctx, ctx, ctx, ctx, 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]

get_version

::models::ServerVersion get_version(ctx, ctx, ctx, ctx, ctx, ctx, ) Returns the version of the Gitea application

Required Parameters

This endpoint does not need any parameter.

Return type

::models::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]

render_markdown

String render_markdown(ctx, ctx, ctx, ctx, ctx, ctx, optional) Render a markdown document as HTML

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
body	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]

render_markdown_raw

String render_markdown_raw(ctx, ctx, ctx, ctx, ctx, ctx, body) Render raw markdown as HTML

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
ctx	context.Context	context containing the authentication	nil if no authentication
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]