gitea-rs/crates/gitea-client/docs/MiscellaneousApi.md

\MiscellaneousApi

All URIs are relative to /api/v1

Method	HTTP request	Description
get_gitignore_template_info	GET /gitignore/templates/{name}	Returns information about a gitignore template
get_label_template_info	GET /label/templates/{name}	Returns all labels in a template
get_license_template_info	GET /licenses/{name}	Returns information about a license template
get_node_info	GET /nodeinfo	Returns the nodeinfo of the Gitea application
get_signing_key	GET /signing-key.gpg	Get default signing-key.gpg
get_version	GET /version	Returns the version of the Gitea application
list_gitignores_templates	GET /gitignore/templates	Returns a list of all gitignore templates
list_label_templates	GET /label/templates	Returns a list of all label templates
list_license_templates	GET /licenses	Returns a list of all license templates
render_markdown	POST /markdown	Render a markdown document as HTML
render_markdown_raw	POST /markdown/raw	Render raw markdown as HTML
render_markup	POST /markup	Render a markup document as HTML

get_gitignore_template_info

models::GitignoreTemplateInfo get_gitignore_template_info(name) Returns information about a gitignore template

Parameters

Name	Type	Description	Required	Notes
name	String	name of the template	[required]

Return type

models::GitignoreTemplateInfo

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

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

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

get_label_template_info

Vecmodels::LabelTemplate get_label_template_info(name) Returns all labels in a template

Parameters

Name	Type	Description	Required	Notes
name	String	name of the template	[required]

Return type

Vecmodels::LabelTemplate

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

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

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

get_license_template_info

models::LicenseTemplateInfo get_license_template_info(name) Returns information about a license template

Parameters

Name	Type	Description	Required	Notes
name	String	name of the license	[required]

Return type

models::LicenseTemplateInfo

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

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

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

get_node_info

models::NodeInfo get_node_info() Returns the nodeinfo of the Gitea application

Parameters

This endpoint does not need any parameter.

Return type

models::NodeInfo

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

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

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

get_signing_key

String get_signing_key() Get default signing-key.gpg

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

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

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

get_version

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

Parameters

This endpoint does not need any parameter.

Return type

models::ServerVersion

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

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

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

list_gitignores_templates

Vec list_gitignores_templates() Returns a list of all gitignore templates

Parameters

This endpoint does not need any parameter.

Return type

Vec

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

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

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

list_label_templates

Vec list_label_templates() Returns a list of all label templates

Parameters

This endpoint does not need any parameter.

Return type

Vec

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

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

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

list_license_templates

Vecmodels::LicensesTemplateListEntry list_license_templates() Returns a list of all license templates

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::LicensesTemplateListEntry

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

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

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

render_markdown

String render_markdown(body) Render a markdown document as HTML

Parameters

Name	Type	Description	Required	Notes
body	Option<MarkdownOption>

Return type

String

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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(body) Render raw markdown as HTML

Parameters

Name	Type	Description	Required	Notes
body	String	Request body to render	[required]

Return type

String

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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]

render_markup

String render_markup(body) Render a markup document as HTML

Parameters

Name	Type	Description	Required	Notes
body	Option<MarkupOption>

Return type

String

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, 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]