# MiscellaneousApi All URIs are relative to *https://{{.SwaggerAppSubUrl}}/api/v1* Method | HTTP request | Description ------------- | ------------- | ------------- [**getGitignoreTemplateInfo**](MiscellaneousApi.md#getGitignoreTemplateInfo) | **GET** gitignore/templates/{name} | Returns information about a gitignore template [**getLabelTemplateInfo**](MiscellaneousApi.md#getLabelTemplateInfo) | **GET** label/templates/{name} | Returns all labels in a template [**getLicenseTemplateInfo**](MiscellaneousApi.md#getLicenseTemplateInfo) | **GET** licenses/{name} | Returns information about a license template [**getSigningKey**](MiscellaneousApi.md#getSigningKey) | **GET** signing-key.gpg | Get default signing-key.gpg [**getSigningKeySSH**](MiscellaneousApi.md#getSigningKeySSH) | **GET** signing-key.pub | Get default signing-key.pub [**getVersion**](MiscellaneousApi.md#getVersion) | **GET** version | Returns the version of the Gitea application [**listGitignoresTemplates**](MiscellaneousApi.md#listGitignoresTemplates) | **GET** gitignore/templates | Returns a list of all gitignore templates [**listLabelTemplates**](MiscellaneousApi.md#listLabelTemplates) | **GET** label/templates | Returns a list of all label templates [**listLicenseTemplates**](MiscellaneousApi.md#listLicenseTemplates) | **GET** licenses | Returns a list of all license templates [**renderMarkdown**](MiscellaneousApi.md#renderMarkdown) | **POST** markdown | Render a markdown document as HTML [**renderMarkdownRaw**](MiscellaneousApi.md#renderMarkdownRaw) | **POST** markdown/raw | Render raw markdown as HTML [**renderMarkup**](MiscellaneousApi.md#renderMarkup) | **POST** markup | Render a markup document as HTML # **getGitignoreTemplateInfo** > GitignoreTemplateInfo getGitignoreTemplateInfo(name) Returns information about a gitignore template ### Example ```java // Import classes: //import org.gitnex.tea4j.v2.ApiClient; //import org.gitnex.tea4j.v2.ApiException; //import org.gitnex.tea4j.v2.Configuration; //import org.gitnex.tea4j.v2.auth.*; //import org.gitnex.tea4j.v2.apis.MiscellaneousApi; ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); MiscellaneousApi apiInstance = new MiscellaneousApi(); String name = "name_example"; // String | name of the template try { GitignoreTemplateInfo result = apiInstance.getGitignoreTemplateInfo(name); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MiscellaneousApi#getGitignoreTemplateInfo"); e.printStackTrace(); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **String**| 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**: Not defined - **Accept**: application/json # **getLabelTemplateInfo** > List<LabelTemplate> getLabelTemplateInfo(name) Returns all labels in a template ### Example ```java // Import classes: //import org.gitnex.tea4j.v2.ApiClient; //import org.gitnex.tea4j.v2.ApiException; //import org.gitnex.tea4j.v2.Configuration; //import org.gitnex.tea4j.v2.auth.*; //import org.gitnex.tea4j.v2.apis.MiscellaneousApi; ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); MiscellaneousApi apiInstance = new MiscellaneousApi(); String name = "name_example"; // String | name of the template try { List result = apiInstance.getLabelTemplateInfo(name); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MiscellaneousApi#getLabelTemplateInfo"); e.printStackTrace(); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **String**| 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**: Not defined - **Accept**: application/json # **getLicenseTemplateInfo** > LicenseTemplateInfo getLicenseTemplateInfo(name) Returns information about a license template ### Example ```java // Import classes: //import org.gitnex.tea4j.v2.ApiClient; //import org.gitnex.tea4j.v2.ApiException; //import org.gitnex.tea4j.v2.Configuration; //import org.gitnex.tea4j.v2.auth.*; //import org.gitnex.tea4j.v2.apis.MiscellaneousApi; ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); MiscellaneousApi apiInstance = new MiscellaneousApi(); String name = "name_example"; // String | name of the license try { LicenseTemplateInfo result = apiInstance.getLicenseTemplateInfo(name); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MiscellaneousApi#getLicenseTemplateInfo"); e.printStackTrace(); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **String**| 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**: Not defined - **Accept**: application/json # **getSigningKey** > String getSigningKey() Get default signing-key.gpg ### Example ```java // Import classes: //import org.gitnex.tea4j.v2.ApiClient; //import org.gitnex.tea4j.v2.ApiException; //import org.gitnex.tea4j.v2.Configuration; //import org.gitnex.tea4j.v2.auth.*; //import org.gitnex.tea4j.v2.apis.MiscellaneousApi; ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); MiscellaneousApi apiInstance = new MiscellaneousApi(); try { String result = apiInstance.getSigningKey(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MiscellaneousApi#getSigningKey"); e.printStackTrace(); } ``` ### Parameters This endpoint does not need any parameter. ### Return type **String** ### 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**: Not defined - **Accept**: text/plain # **getSigningKeySSH** > String getSigningKeySSH() Get default signing-key.pub ### Example ```java // Import classes: //import org.gitnex.tea4j.v2.ApiClient; //import org.gitnex.tea4j.v2.ApiException; //import org.gitnex.tea4j.v2.Configuration; //import org.gitnex.tea4j.v2.auth.*; //import org.gitnex.tea4j.v2.apis.MiscellaneousApi; ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); MiscellaneousApi apiInstance = new MiscellaneousApi(); try { String result = apiInstance.getSigningKeySSH(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MiscellaneousApi#getSigningKeySSH"); e.printStackTrace(); } ``` ### Parameters This endpoint does not need any parameter. ### Return type **String** ### 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**: Not defined - **Accept**: text/plain # **getVersion** > ServerVersion getVersion() Returns the version of the Gitea application ### Example ```java // Import classes: //import org.gitnex.tea4j.v2.ApiClient; //import org.gitnex.tea4j.v2.ApiException; //import org.gitnex.tea4j.v2.Configuration; //import org.gitnex.tea4j.v2.auth.*; //import org.gitnex.tea4j.v2.apis.MiscellaneousApi; ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); MiscellaneousApi apiInstance = new MiscellaneousApi(); try { ServerVersion result = apiInstance.getVersion(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MiscellaneousApi#getVersion"); e.printStackTrace(); } ``` ### 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**: Not defined - **Accept**: application/json # **listGitignoresTemplates** > List<String> listGitignoresTemplates() Returns a list of all gitignore templates ### Example ```java // Import classes: //import org.gitnex.tea4j.v2.ApiClient; //import org.gitnex.tea4j.v2.ApiException; //import org.gitnex.tea4j.v2.Configuration; //import org.gitnex.tea4j.v2.auth.*; //import org.gitnex.tea4j.v2.apis.MiscellaneousApi; ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); MiscellaneousApi apiInstance = new MiscellaneousApi(); try { List result = apiInstance.listGitignoresTemplates(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MiscellaneousApi#listGitignoresTemplates"); e.printStackTrace(); } ``` ### Parameters This endpoint does not need any parameter. ### Return type **List<String>** ### 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**: Not defined - **Accept**: application/json # **listLabelTemplates** > List<String> listLabelTemplates() Returns a list of all label templates ### Example ```java // Import classes: //import org.gitnex.tea4j.v2.ApiClient; //import org.gitnex.tea4j.v2.ApiException; //import org.gitnex.tea4j.v2.Configuration; //import org.gitnex.tea4j.v2.auth.*; //import org.gitnex.tea4j.v2.apis.MiscellaneousApi; ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); MiscellaneousApi apiInstance = new MiscellaneousApi(); try { List result = apiInstance.listLabelTemplates(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MiscellaneousApi#listLabelTemplates"); e.printStackTrace(); } ``` ### Parameters This endpoint does not need any parameter. ### Return type **List<String>** ### 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**: Not defined - **Accept**: application/json # **listLicenseTemplates** > List<LicensesTemplateListEntry> listLicenseTemplates() Returns a list of all license templates ### Example ```java // Import classes: //import org.gitnex.tea4j.v2.ApiClient; //import org.gitnex.tea4j.v2.ApiException; //import org.gitnex.tea4j.v2.Configuration; //import org.gitnex.tea4j.v2.auth.*; //import org.gitnex.tea4j.v2.apis.MiscellaneousApi; ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); MiscellaneousApi apiInstance = new MiscellaneousApi(); try { List result = apiInstance.listLicenseTemplates(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MiscellaneousApi#listLicenseTemplates"); e.printStackTrace(); } ``` ### 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**: Not defined - **Accept**: application/json # **renderMarkdown** > String renderMarkdown(body) Render a markdown document as HTML ### Example ```java // Import classes: //import org.gitnex.tea4j.v2.ApiClient; //import org.gitnex.tea4j.v2.ApiException; //import org.gitnex.tea4j.v2.Configuration; //import org.gitnex.tea4j.v2.auth.*; //import org.gitnex.tea4j.v2.apis.MiscellaneousApi; ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); MiscellaneousApi apiInstance = new MiscellaneousApi(); MarkdownOption body = new MarkdownOption(); // MarkdownOption | try { String result = apiInstance.renderMarkdown(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MiscellaneousApi#renderMarkdown"); e.printStackTrace(); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**MarkdownOption**](MarkdownOption.md)| | [optional] ### Return type **String** ### 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 # **renderMarkdownRaw** > String renderMarkdownRaw(body) Render raw markdown as HTML ### Example ```java // Import classes: //import org.gitnex.tea4j.v2.ApiClient; //import org.gitnex.tea4j.v2.ApiException; //import org.gitnex.tea4j.v2.Configuration; //import org.gitnex.tea4j.v2.auth.*; //import org.gitnex.tea4j.v2.apis.MiscellaneousApi; ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); MiscellaneousApi apiInstance = new MiscellaneousApi(); String body = "body_example"; // String | Request body to render try { String result = apiInstance.renderMarkdownRaw(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MiscellaneousApi#renderMarkdownRaw"); e.printStackTrace(); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**String**](String.md)| Request body to render | ### Return type **String** ### 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 # **renderMarkup** > String renderMarkup(body) Render a markup document as HTML ### Example ```java // Import classes: //import org.gitnex.tea4j.v2.ApiClient; //import org.gitnex.tea4j.v2.ApiException; //import org.gitnex.tea4j.v2.Configuration; //import org.gitnex.tea4j.v2.auth.*; //import org.gitnex.tea4j.v2.apis.MiscellaneousApi; ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); MiscellaneousApi apiInstance = new MiscellaneousApi(); MarkupOption body = new MarkupOption(); // MarkupOption | try { String result = apiInstance.renderMarkup(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MiscellaneousApi#renderMarkup"); e.printStackTrace(); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**MarkupOption**](MarkupOption.md)| | [optional] ### Return type **String** ### 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