Rust API for Gitea, automatically generated https://git.exmods.org/swagger.v1.json
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.

MiscellaneousApi.md 5.3KB

4 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. # \MiscellaneousApi
  2. All URIs are relative to *http://localhost/api/v1*
  3. Method | HTTP request | Description
  4. ------------- | ------------- | -------------
  5. [**get_signing_key**](MiscellaneousApi.md#get_signing_key) | **Get** /signing-key.gpg | Get default signing-key.gpg
  6. [**get_version**](MiscellaneousApi.md#get_version) | **Get** /version | Returns the version of the Gitea application
  7. [**render_markdown**](MiscellaneousApi.md#render_markdown) | **Post** /markdown | Render a markdown document as HTML
  8. [**render_markdown_raw**](MiscellaneousApi.md#render_markdown_raw) | **Post** /markdown/raw | Render raw markdown as HTML
  9. # **get_signing_key**
  10. > String get_signing_key(ctx, ctx, ctx, ctx, ctx, ctx, )
  11. Get default signing-key.gpg
  12. ### Required Parameters
  13. This endpoint does not need any parameter.
  14. ### Return type
  15. **String**
  16. ### Authorization
  17. [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
  18. ### HTTP request headers
  19. - **Content-Type**: application/json, text/plain
  20. - **Accept**: text/plain
  21. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  22. # **get_version**
  23. > ::models::ServerVersion get_version(ctx, ctx, ctx, ctx, ctx, ctx, )
  24. Returns the version of the Gitea application
  25. ### Required Parameters
  26. This endpoint does not need any parameter.
  27. ### Return type
  28. [**::models::ServerVersion**](ServerVersion.md)
  29. ### Authorization
  30. [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
  31. ### HTTP request headers
  32. - **Content-Type**: application/json, text/plain
  33. - **Accept**: application/json
  34. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  35. # **render_markdown**
  36. > String render_markdown(ctx, ctx, ctx, ctx, ctx, ctx, optional)
  37. Render a markdown document as HTML
  38. ### Required Parameters
  39. Name | Type | Description | Notes
  40. ------------- | ------------- | ------------- | -------------
  41. **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  42. **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  43. **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  44. **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  45. **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  46. **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  47. **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
  48. ### Optional Parameters
  49. Optional parameters are passed through a map[string]interface{}.
  50. Name | Type | Description | Notes
  51. ------------- | ------------- | ------------- | -------------
  52. **body** | [**MarkdownOption**](MarkdownOption.md)| |
  53. ### Return type
  54. **String**
  55. ### Authorization
  56. [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
  57. ### HTTP request headers
  58. - **Content-Type**: application/json
  59. - **Accept**: text/html
  60. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  61. # **render_markdown_raw**
  62. > String render_markdown_raw(ctx, ctx, ctx, ctx, ctx, ctx, body)
  63. Render raw markdown as HTML
  64. ### Required Parameters
  65. Name | Type | Description | Notes
  66. ------------- | ------------- | ------------- | -------------
  67. **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  68. **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  69. **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  70. **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  71. **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  72. **ctx** | **context.Context** | context containing the authentication | nil if no authentication
  73. **body** | **String**| Request body to render |
  74. ### Return type
  75. **String**
  76. ### Authorization
  77. [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [Token](../README.md#Token)
  78. ### HTTP request headers
  79. - **Content-Type**: text/plain
  80. - **Accept**: text/html
  81. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)