forgejo 0.1.0

data/docs/MiscellaneousApi.md

@@ -0,0 +1,833 @@
+# Forgejo::MiscellaneousApi
+
+All URIs are relative to */api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_gitignore_template_info**](MiscellaneousApi.md#get_gitignore_template_info) | **GET** /gitignore/templates/{name} | Returns information about a gitignore template |
+| [**get_label_template_info**](MiscellaneousApi.md#get_label_template_info) | **GET** /label/templates/{name} | Returns all labels in a template |
+| [**get_license_template_info**](MiscellaneousApi.md#get_license_template_info) | **GET** /licenses/{name} | Returns information about a license template |
+| [**get_node_info**](MiscellaneousApi.md#get_node_info) | **GET** /nodeinfo | Returns the nodeinfo of the Gitea application |
+| [**get_signing_key**](MiscellaneousApi.md#get_signing_key) | **GET** /signing-key.gpg | Get default signing-key.gpg |
+| [**get_version**](MiscellaneousApi.md#get_version) | **GET** /version | Returns the version of the Gitea application |
+| [**list_gitignores_templates**](MiscellaneousApi.md#list_gitignores_templates) | **GET** /gitignore/templates | Returns a list of all gitignore templates |
+| [**list_label_templates**](MiscellaneousApi.md#list_label_templates) | **GET** /label/templates | Returns a list of all label templates |
+| [**list_license_templates**](MiscellaneousApi.md#list_license_templates) | **GET** /licenses | Returns a list of all license templates |
+| [**render_markdown**](MiscellaneousApi.md#render_markdown) | **POST** /markdown | Render a markdown document as HTML |
+| [**render_markdown_raw**](MiscellaneousApi.md#render_markdown_raw) | **POST** /markdown/raw | Render raw markdown as HTML |
+| [**render_markup**](MiscellaneousApi.md#render_markup) | **POST** /markup | Render a markup document as HTML |
+
+
+## get_gitignore_template_info
+
+> <GitignoreTemplateInfo> get_gitignore_template_info(name)
+
+Returns information about a gitignore template
+
+### Examples
+
+```ruby
+require 'time'
+require 'forgejo'
+# setup authorization
+Forgejo.configure do |config|
+  # Configure API key authorization: AuthorizationHeaderToken
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Forgejo::MiscellaneousApi.new
+name = 'name_example' # String | name of the template
+
+begin
+  # Returns information about a gitignore template
+  result = api_instance.get_gitignore_template_info(name)
+  p result
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->get_gitignore_template_info: #{e}"
+end
+```
+
+#### Using the get_gitignore_template_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GitignoreTemplateInfo>, Integer, Hash)> get_gitignore_template_info_with_http_info(name)
+
+```ruby
+begin
+  # Returns information about a gitignore template
+  data, status_code, headers = api_instance.get_gitignore_template_info_with_http_info(name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GitignoreTemplateInfo>
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->get_gitignore_template_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | name of the template |  |
+
+### Return type
+
+[**GitignoreTemplateInfo**](GitignoreTemplateInfo.md)
+
+### Authorization
+
+[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_label_template_info
+
+> <Array<LabelTemplate>> get_label_template_info(name)
+
+Returns all labels in a template
+
+### Examples
+
+```ruby
+require 'time'
+require 'forgejo'
+# setup authorization
+Forgejo.configure do |config|
+  # Configure API key authorization: AuthorizationHeaderToken
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Forgejo::MiscellaneousApi.new
+name = 'name_example' # String | name of the template
+
+begin
+  # Returns all labels in a template
+  result = api_instance.get_label_template_info(name)
+  p result
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->get_label_template_info: #{e}"
+end
+```
+
+#### Using the get_label_template_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<LabelTemplate>>, Integer, Hash)> get_label_template_info_with_http_info(name)
+
+```ruby
+begin
+  # Returns all labels in a template
+  data, status_code, headers = api_instance.get_label_template_info_with_http_info(name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<LabelTemplate>>
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->get_label_template_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | name of the template |  |
+
+### Return type
+
+[**Array&lt;LabelTemplate&gt;**](LabelTemplate.md)
+
+### Authorization
+
+[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_license_template_info
+
+> <LicenseTemplateInfo> get_license_template_info(name)
+
+Returns information about a license template
+
+### Examples
+
+```ruby
+require 'time'
+require 'forgejo'
+# setup authorization
+Forgejo.configure do |config|
+  # Configure API key authorization: AuthorizationHeaderToken
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Forgejo::MiscellaneousApi.new
+name = 'name_example' # String | name of the license
+
+begin
+  # Returns information about a license template
+  result = api_instance.get_license_template_info(name)
+  p result
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->get_license_template_info: #{e}"
+end
+```
+
+#### Using the get_license_template_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LicenseTemplateInfo>, Integer, Hash)> get_license_template_info_with_http_info(name)
+
+```ruby
+begin
+  # Returns information about a license template
+  data, status_code, headers = api_instance.get_license_template_info_with_http_info(name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LicenseTemplateInfo>
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->get_license_template_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | name of the license |  |
+
+### Return type
+
+[**LicenseTemplateInfo**](LicenseTemplateInfo.md)
+
+### Authorization
+
+[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_node_info
+
+> <NodeInfo> get_node_info
+
+Returns the nodeinfo of the Gitea application
+
+### Examples
+
+```ruby
+require 'time'
+require 'forgejo'
+# setup authorization
+Forgejo.configure do |config|
+  # Configure API key authorization: AuthorizationHeaderToken
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Forgejo::MiscellaneousApi.new
+
+begin
+  # Returns the nodeinfo of the Gitea application
+  result = api_instance.get_node_info
+  p result
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->get_node_info: #{e}"
+end
+```
+
+#### Using the get_node_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<NodeInfo>, Integer, Hash)> get_node_info_with_http_info
+
+```ruby
+begin
+  # Returns the nodeinfo of the Gitea application
+  data, status_code, headers = api_instance.get_node_info_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NodeInfo>
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->get_node_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**NodeInfo**](NodeInfo.md)
+
+### Authorization
+
+[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_signing_key
+
+> String get_signing_key
+
+Get default signing-key.gpg
+
+### Examples
+
+```ruby
+require 'time'
+require 'forgejo'
+# setup authorization
+Forgejo.configure do |config|
+  # Configure API key authorization: AuthorizationHeaderToken
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Forgejo::MiscellaneousApi.new
+
+begin
+  # Get default signing-key.gpg
+  result = api_instance.get_signing_key
+  p result
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->get_signing_key: #{e}"
+end
+```
+
+#### Using the get_signing_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> get_signing_key_with_http_info
+
+```ruby
+begin
+  # Get default signing-key.gpg
+  data, status_code, headers = api_instance.get_signing_key_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->get_signing_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**String**
+
+### Authorization
+
+[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain
+
+
+## get_version
+
+> <ServerVersion> get_version
+
+Returns the version of the Gitea application
+
+### Examples
+
+```ruby
+require 'time'
+require 'forgejo'
+# setup authorization
+Forgejo.configure do |config|
+  # Configure API key authorization: AuthorizationHeaderToken
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Forgejo::MiscellaneousApi.new
+
+begin
+  # Returns the version of the Gitea application
+  result = api_instance.get_version
+  p result
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->get_version: #{e}"
+end
+```
+
+#### Using the get_version_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ServerVersion>, Integer, Hash)> get_version_with_http_info
+
+```ruby
+begin
+  # Returns the version of the Gitea application
+  data, status_code, headers = api_instance.get_version_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ServerVersion>
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->get_version_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ServerVersion**](ServerVersion.md)
+
+### Authorization
+
+[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_gitignores_templates
+
+> Array&lt;String&gt; list_gitignores_templates
+
+Returns a list of all gitignore templates
+
+### Examples
+
+```ruby
+require 'time'
+require 'forgejo'
+# setup authorization
+Forgejo.configure do |config|
+  # Configure API key authorization: AuthorizationHeaderToken
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Forgejo::MiscellaneousApi.new
+
+begin
+  # Returns a list of all gitignore templates
+  result = api_instance.list_gitignores_templates
+  p result
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->list_gitignores_templates: #{e}"
+end
+```
+
+#### Using the list_gitignores_templates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Array&lt;String&gt;, Integer, Hash)> list_gitignores_templates_with_http_info
+
+```ruby
+begin
+  # Returns a list of all gitignore templates
+  data, status_code, headers = api_instance.list_gitignores_templates_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array&lt;String&gt;
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->list_gitignores_templates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Array&lt;String&gt;**
+
+### Authorization
+
+[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_label_templates
+
+> Array&lt;String&gt; list_label_templates
+
+Returns a list of all label templates
+
+### Examples
+
+```ruby
+require 'time'
+require 'forgejo'
+# setup authorization
+Forgejo.configure do |config|
+  # Configure API key authorization: AuthorizationHeaderToken
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Forgejo::MiscellaneousApi.new
+
+begin
+  # Returns a list of all label templates
+  result = api_instance.list_label_templates
+  p result
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->list_label_templates: #{e}"
+end
+```
+
+#### Using the list_label_templates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Array&lt;String&gt;, Integer, Hash)> list_label_templates_with_http_info
+
+```ruby
+begin
+  # Returns a list of all label templates
+  data, status_code, headers = api_instance.list_label_templates_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array&lt;String&gt;
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->list_label_templates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Array&lt;String&gt;**
+
+### Authorization
+
+[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_license_templates
+
+> <Array<LicensesTemplateListEntry>> list_license_templates
+
+Returns a list of all license templates
+
+### Examples
+
+```ruby
+require 'time'
+require 'forgejo'
+# setup authorization
+Forgejo.configure do |config|
+  # Configure API key authorization: AuthorizationHeaderToken
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Forgejo::MiscellaneousApi.new
+
+begin
+  # Returns a list of all license templates
+  result = api_instance.list_license_templates
+  p result
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->list_license_templates: #{e}"
+end
+```
+
+#### Using the list_license_templates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<LicensesTemplateListEntry>>, Integer, Hash)> list_license_templates_with_http_info
+
+```ruby
+begin
+  # Returns a list of all license templates
+  data, status_code, headers = api_instance.list_license_templates_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<LicensesTemplateListEntry>>
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->list_license_templates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;LicensesTemplateListEntry&gt;**](LicensesTemplateListEntry.md)
+
+### Authorization
+
+[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## render_markdown
+
+> String render_markdown(opts)
+
+Render a markdown document as HTML
+
+### Examples
+
+```ruby
+require 'time'
+require 'forgejo'
+# setup authorization
+Forgejo.configure do |config|
+  # Configure API key authorization: AuthorizationHeaderToken
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Forgejo::MiscellaneousApi.new
+opts = {
+  body: Forgejo::MarkdownOption.new # MarkdownOption | 
+}
+
+begin
+  # Render a markdown document as HTML
+  result = api_instance.render_markdown(opts)
+  p result
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->render_markdown: #{e}"
+end
+```
+
+#### Using the render_markdown_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> render_markdown_with_http_info(opts)
+
+```ruby
+begin
+  # Render a markdown document as HTML
+  data, status_code, headers = api_instance.render_markdown_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->render_markdown_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**MarkdownOption**](MarkdownOption.md) |  | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: text/html
+
+
+## render_markdown_raw
+
+> String render_markdown_raw(body)
+
+Render raw markdown as HTML
+
+### Examples
+
+```ruby
+require 'time'
+require 'forgejo'
+# setup authorization
+Forgejo.configure do |config|
+  # Configure API key authorization: AuthorizationHeaderToken
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Forgejo::MiscellaneousApi.new
+body = 'body_example' # String | Request body to render
+
+begin
+  # Render raw markdown as HTML
+  result = api_instance.render_markdown_raw(body)
+  p result
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->render_markdown_raw: #{e}"
+end
+```
+
+#### Using the render_markdown_raw_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> render_markdown_raw_with_http_info(body)
+
+```ruby
+begin
+  # Render raw markdown as HTML
+  data, status_code, headers = api_instance.render_markdown_raw_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->render_markdown_raw_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** | Request body to render |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
+
+### HTTP request headers
+
+- **Content-Type**: text/plain
+- **Accept**: text/html
+
+
+## render_markup
+
+> String render_markup(opts)
+
+Render a markup document as HTML
+
+### Examples
+
+```ruby
+require 'time'
+require 'forgejo'
+# setup authorization
+Forgejo.configure do |config|
+  # Configure API key authorization: AuthorizationHeaderToken
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Forgejo::MiscellaneousApi.new
+opts = {
+  body: Forgejo::MarkupOption.new # MarkupOption | 
+}
+
+begin
+  # Render a markup document as HTML
+  result = api_instance.render_markup(opts)
+  p result
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->render_markup: #{e}"
+end
+```
+
+#### Using the render_markup_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> render_markup_with_http_info(opts)
+
+```ruby
+begin
+  # Render a markup document as HTML
+  data, status_code, headers = api_instance.render_markup_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue Forgejo::ApiError => e
+  puts "Error when calling MiscellaneousApi->render_markup_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**MarkupOption**](MarkupOption.md) |  | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: text/html
+