# gitea.MiscellaneousApi All URIs are relative to *https://localhost/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 ### Example ```python from __future__ import print_function import time import gitea from gitea.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = gitea.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = gitea.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = gitea.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = gitea.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = gitea.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: TOTPHeader configuration = gitea.Configuration() configuration.api_key['X-GITEA-OTP'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['X-GITEA-OTP'] = 'Bearer' # Configure API key authorization: Token configuration = gitea.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = gitea.MiscellaneousApi(gitea.ApiClient(configuration)) name = 'name_example' # str | name of the template try: # Returns information about a gitignore template api_response = api_instance.get_gitignore_template_info(name) pprint(api_response) except ApiException as e: print("Exception when calling MiscellaneousApi->get_gitignore_template_info: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **str**| name of the template | ### Return type [**GitignoreTemplateInfo**](GitignoreTemplateInfo.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[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) # **get_label_template_info** > list[LabelTemplate] get_label_template_info(name) Returns all labels in a template ### Example ```python from __future__ import print_function import time import gitea from gitea.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = gitea.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = gitea.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = gitea.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = gitea.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = gitea.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: TOTPHeader configuration = gitea.Configuration() configuration.api_key['X-GITEA-OTP'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['X-GITEA-OTP'] = 'Bearer' # Configure API key authorization: Token configuration = gitea.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = gitea.MiscellaneousApi(gitea.ApiClient(configuration)) name = 'name_example' # str | name of the template try: # Returns all labels in a template api_response = api_instance.get_label_template_info(name) pprint(api_response) except ApiException as e: print("Exception when calling MiscellaneousApi->get_label_template_info: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **str**| name of the template | ### Return type [**list[LabelTemplate]**](LabelTemplate.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[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) # **get_license_template_info** > LicenseTemplateInfo get_license_template_info(name) Returns information about a license template ### Example ```python from __future__ import print_function import time import gitea from gitea.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = gitea.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = gitea.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = gitea.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = gitea.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = gitea.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: TOTPHeader configuration = gitea.Configuration() configuration.api_key['X-GITEA-OTP'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['X-GITEA-OTP'] = 'Bearer' # Configure API key authorization: Token configuration = gitea.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = gitea.MiscellaneousApi(gitea.ApiClient(configuration)) name = 'name_example' # str | name of the license try: # Returns information about a license template api_response = api_instance.get_license_template_info(name) pprint(api_response) except ApiException as e: print("Exception when calling MiscellaneousApi->get_license_template_info: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **str**| name of the license | ### Return type [**LicenseTemplateInfo**](LicenseTemplateInfo.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[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) # **get_node_info** > NodeInfo get_node_info() Returns the nodeinfo of the Gitea application ### Example ```python from __future__ import print_function import time import gitea from gitea.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = gitea.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = gitea.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = gitea.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = gitea.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = gitea.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: TOTPHeader configuration = gitea.Configuration() configuration.api_key['X-GITEA-OTP'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['X-GITEA-OTP'] = 'Bearer' # Configure API key authorization: Token configuration = gitea.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = gitea.MiscellaneousApi(gitea.ApiClient(configuration)) try: # Returns the nodeinfo of the Gitea application api_response = api_instance.get_node_info() pprint(api_response) except ApiException as e: print("Exception when calling MiscellaneousApi->get_node_info: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type [**NodeInfo**](NodeInfo.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[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) # **get_signing_key** > str get_signing_key() Get default signing-key.gpg ### Example ```python from __future__ import print_function import time import gitea from gitea.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = gitea.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = gitea.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = gitea.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = gitea.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = gitea.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: TOTPHeader configuration = gitea.Configuration() configuration.api_key['X-GITEA-OTP'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['X-GITEA-OTP'] = 'Bearer' # Configure API key authorization: Token configuration = gitea.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = gitea.MiscellaneousApi(gitea.ApiClient(configuration)) try: # Get default signing-key.gpg api_response = api_instance.get_signing_key() pprint(api_response) except ApiException as e: print("Exception when calling MiscellaneousApi->get_signing_key: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type **str** ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: text/plain [[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) # **get_version** > ServerVersion get_version() Returns the version of the Gitea application ### Example ```python from __future__ import print_function import time import gitea from gitea.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = gitea.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = gitea.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = gitea.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = gitea.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = gitea.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: TOTPHeader configuration = gitea.Configuration() configuration.api_key['X-GITEA-OTP'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['X-GITEA-OTP'] = 'Bearer' # Configure API key authorization: Token configuration = gitea.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = gitea.MiscellaneousApi(gitea.ApiClient(configuration)) try: # Returns the version of the Gitea application api_response = api_instance.get_version() pprint(api_response) except ApiException as e: print("Exception when calling MiscellaneousApi->get_version: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type [**ServerVersion**](ServerVersion.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[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) # **list_gitignores_templates** > list[str] list_gitignores_templates() Returns a list of all gitignore templates ### Example ```python from __future__ import print_function import time import gitea from gitea.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = gitea.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = gitea.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = gitea.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = gitea.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = gitea.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: TOTPHeader configuration = gitea.Configuration() configuration.api_key['X-GITEA-OTP'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['X-GITEA-OTP'] = 'Bearer' # Configure API key authorization: Token configuration = gitea.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = gitea.MiscellaneousApi(gitea.ApiClient(configuration)) try: # Returns a list of all gitignore templates api_response = api_instance.list_gitignores_templates() pprint(api_response) except ApiException as e: print("Exception when calling MiscellaneousApi->list_gitignores_templates: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type **list[str]** ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[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) # **list_label_templates** > list[str] list_label_templates() Returns a list of all label templates ### Example ```python from __future__ import print_function import time import gitea from gitea.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = gitea.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = gitea.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = gitea.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = gitea.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = gitea.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: TOTPHeader configuration = gitea.Configuration() configuration.api_key['X-GITEA-OTP'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['X-GITEA-OTP'] = 'Bearer' # Configure API key authorization: Token configuration = gitea.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = gitea.MiscellaneousApi(gitea.ApiClient(configuration)) try: # Returns a list of all label templates api_response = api_instance.list_label_templates() pprint(api_response) except ApiException as e: print("Exception when calling MiscellaneousApi->list_label_templates: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type **list[str]** ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[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) # **list_license_templates** > list[LicensesTemplateListEntry] list_license_templates() Returns a list of all license templates ### Example ```python from __future__ import print_function import time import gitea from gitea.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = gitea.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = gitea.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = gitea.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = gitea.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = gitea.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: TOTPHeader configuration = gitea.Configuration() configuration.api_key['X-GITEA-OTP'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['X-GITEA-OTP'] = 'Bearer' # Configure API key authorization: Token configuration = gitea.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = gitea.MiscellaneousApi(gitea.ApiClient(configuration)) try: # Returns a list of all license templates api_response = api_instance.list_license_templates() pprint(api_response) except ApiException as e: print("Exception when calling MiscellaneousApi->list_license_templates: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type [**list[LicensesTemplateListEntry]**](LicensesTemplateListEntry.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json, text/plain - **Accept**: application/json [[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) # **render_markdown** > str render_markdown(body=body) Render a markdown document as HTML ### Example ```python from __future__ import print_function import time import gitea from gitea.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = gitea.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = gitea.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = gitea.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = gitea.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = gitea.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: TOTPHeader configuration = gitea.Configuration() configuration.api_key['X-GITEA-OTP'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['X-GITEA-OTP'] = 'Bearer' # Configure API key authorization: Token configuration = gitea.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = gitea.MiscellaneousApi(gitea.ApiClient(configuration)) body = gitea.MarkdownOption() # MarkdownOption | (optional) try: # Render a markdown document as HTML api_response = api_instance.render_markdown(body=body) pprint(api_response) except ApiException as e: print("Exception when calling MiscellaneousApi->render_markdown: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**MarkdownOption**](MarkdownOption.md)| | [optional] ### Return type **str** ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: text/html [[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) # **render_markdown_raw** > str render_markdown_raw(body) Render raw markdown as HTML ### Example ```python from __future__ import print_function import time import gitea from gitea.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = gitea.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = gitea.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = gitea.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = gitea.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = gitea.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: TOTPHeader configuration = gitea.Configuration() configuration.api_key['X-GITEA-OTP'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['X-GITEA-OTP'] = 'Bearer' # Configure API key authorization: Token configuration = gitea.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = gitea.MiscellaneousApi(gitea.ApiClient(configuration)) body = 'body_example' # str | Request body to render try: # Render raw markdown as HTML api_response = api_instance.render_markdown_raw(body) pprint(api_response) except ApiException as e: print("Exception when calling MiscellaneousApi->render_markdown_raw: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **str**| Request body to render | ### Return type **str** ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: text/plain - **Accept**: text/html [[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) # **render_markup** > str render_markup(body=body) Render a markup document as HTML ### Example ```python from __future__ import print_function import time import gitea from gitea.rest import ApiException from pprint import pprint # Configure API key authorization: AccessToken configuration = gitea.Configuration() configuration.api_key['access_token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['access_token'] = 'Bearer' # Configure API key authorization: AuthorizationHeaderToken configuration = gitea.Configuration() configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' # Configure HTTP basic authorization: BasicAuth configuration = gitea.Configuration() configuration.username = 'YOUR_USERNAME' configuration.password = 'YOUR_PASSWORD' # Configure API key authorization: SudoHeader configuration = gitea.Configuration() configuration.api_key['Sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Sudo'] = 'Bearer' # Configure API key authorization: SudoParam configuration = gitea.Configuration() configuration.api_key['sudo'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['sudo'] = 'Bearer' # Configure API key authorization: TOTPHeader configuration = gitea.Configuration() configuration.api_key['X-GITEA-OTP'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['X-GITEA-OTP'] = 'Bearer' # Configure API key authorization: Token configuration = gitea.Configuration() configuration.api_key['token'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['token'] = 'Bearer' # create an instance of the API class api_instance = gitea.MiscellaneousApi(gitea.ApiClient(configuration)) body = gitea.MarkupOption() # MarkupOption | (optional) try: # Render a markup document as HTML api_response = api_instance.render_markup(body=body) pprint(api_response) except ApiException as e: print("Exception when calling MiscellaneousApi->render_markup: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**MarkupOption**](MarkupOption.md)| | [optional] ### Return type **str** ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: text/html [[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)