diff --git a/docs/RepositoryApi.md b/docs/RepositoryApi.md index 2aefc58..06a8ef2 100644 --- a/docs/RepositoryApi.md +++ b/docs/RepositoryApi.md @@ -83,6 +83,7 @@ Method | HTTP request | Description [**repoGetPullReview**](RepositoryApi.md#repoGetPullReview) | **GET** repos/{owner}/{repo}/pulls/{index}/reviews/{id} | Get a specific review for a pull request [**repoGetPullReviewComments**](RepositoryApi.md#repoGetPullReviewComments) | **GET** repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments | Get a specific review for a pull request [**repoGetRawFile**](RepositoryApi.md#repoGetRawFile) | **GET** repos/{owner}/{repo}/raw/{filepath} | Get a file from a repository +[**repoGetRawFileOrLFS**](RepositoryApi.md#repoGetRawFileOrLFS) | **GET** repos/{owner}/{repo}/media/{filepath} | Get a file or it's LFS object from a repository [**repoGetRelease**](RepositoryApi.md#repoGetRelease) | **GET** repos/{owner}/{repo}/releases/{id} | Get a release [**repoGetReleaseAttachment**](RepositoryApi.md#repoGetReleaseAttachment) | **GET** repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} | Get a release attachment [**repoGetReleaseByTag**](RepositoryApi.md#repoGetReleaseByTag) | **GET** repos/{owner}/{repo}/releases/tags/{tag} | Get a release by tag name @@ -7374,6 +7375,99 @@ Name | Type | Description | Notes [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**: Not defined + + +# **repoGetRawFileOrLFS** +> Void repoGetRawFileOrLFS(owner, repo, filepath, ref) + +Get a file or it's LFS object from a repository + +### 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.RepositoryApi; + +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"); + +RepositoryApi apiInstance = new RepositoryApi(); +String owner = "owner_example"; // String | owner of the repo +String repo = "repo_example"; // String | name of the repo +String filepath = "filepath_example"; // String | filepath of the file to get +String ref = "ref_example"; // String | The name of the commit/branch/tag. Default the repository’s default branch (usually master) +try { + Void result = apiInstance.repoGetRawFileOrLFS(owner, repo, filepath, ref); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling RepositoryApi#repoGetRawFileOrLFS"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **owner** | **String**| owner of the repo | + **repo** | **String**| name of the repo | + **filepath** | **String**| filepath of the file to get | + **ref** | **String**| The name of the commit/branch/tag. Default the repository’s default branch (usually master) | [optional] + +### Return type + +[**Void**](.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 diff --git a/src/main/java/org/gitnex/tea4j/v2/apis/RepositoryApi.java b/src/main/java/org/gitnex/tea4j/v2/apis/RepositoryApi.java index 61ed776..26fcadf 100644 --- a/src/main/java/org/gitnex/tea4j/v2/apis/RepositoryApi.java +++ b/src/main/java/org/gitnex/tea4j/v2/apis/RepositoryApi.java @@ -1269,6 +1269,23 @@ public interface RepositoryApi { @retrofit2.http.Path("filepath") String filepath, @retrofit2.http.Query("ref") String ref); + /** + * Get a file or it's LFS object from a repository + * + * @param owner owner of the repo (required) + * @param repo name of the repo (required) + * @param filepath filepath of the file to get (required) + * @param ref The name of the commit/branch/tag. Default the repository’s default branch (usually + * master) (optional) + * @return Call<Void> + */ + @GET("repos/{owner}/{repo}/media/{filepath}") + Call repoGetRawFileOrLFS( + @retrofit2.http.Path("owner") String owner, + @retrofit2.http.Path("repo") String repo, + @retrofit2.http.Path("filepath") String filepath, + @retrofit2.http.Query("ref") String ref); + /** * Get a release *