octopush/crates/gitea_raw_client/docs/MiscellaneousApi.md
Kasper Juul Hermansen 991861db99
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/pr Build is passing
Rewrite rust (#38)
Co-authored-by: kjuulh <contact@kjuulh.io>
Reviewed-on: #38
2022-11-27 11:21:35 +00:00

4.8 KiB

\MiscellaneousApi

All URIs are relative to /api/v1

Method HTTP request Description
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
render_markdown POST /markdown Render a markdown document as HTML
render_markdown_raw POST /markdown/raw Render raw markdown as HTML

get_node_info

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

Parameters

This endpoint does not need any parameter.

Return type

crate::models::NodeInfo

Authorization

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

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

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

Parameters

This endpoint does not need any parameter.

Return type

crate::models::ServerVersion

Authorization

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

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

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