diff --git a/docs/RepositoryApi.md b/docs/RepositoryApi.md index d399897..c1e90c5 100644 --- a/docs/RepositoryApi.md +++ b/docs/RepositoryApi.md @@ -9414,8 +9414,8 @@ Token.setApiKey("YOUR API KEY"); 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) +String filepath = "filepath_example"; // String | path of the file to get, it should be \"{ref}/{filepath}\". If there is no ref could be inferred, it will be treated as the default branch +String ref = "ref_example"; // String | The name of the commit/branch/tag. Default the repository’s default branch try { File result = apiInstance.repoGetRawFile(owner, repo, filepath, ref); System.out.println(result); @@ -9431,8 +9431,8 @@ 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] + **filepath** | **String**| path of the file to get, it should be \"{ref}/{filepath}\". If there is no ref could be inferred, it will be treated as the default branch | + **ref** | **String**| The name of the commit/branch/tag. Default the repository’s default branch | [optional] ### Return type @@ -9507,8 +9507,8 @@ Token.setApiKey("YOUR API KEY"); 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) +String filepath = "filepath_example"; // String | path of the file to get, it should be \"{ref}/{filepath}\". If there is no ref could be inferred, it will be treated as the default branch +String ref = "ref_example"; // String | The name of the commit/branch/tag. Default the repository’s default branch try { File result = apiInstance.repoGetRawFileOrLFS(owner, repo, filepath, ref); System.out.println(result); @@ -9524,8 +9524,8 @@ 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] + **filepath** | **String**| path of the file to get, it should be \"{ref}/{filepath}\". If there is no ref could be inferred, it will be treated as the default branch | + **ref** | **String**| The name of the commit/branch/tag. Default the repository’s default branch | [optional] ### Return type 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 6240349..8c444c0 100644 --- a/src/main/java/org/gitnex/tea4j/v2/apis/RepositoryApi.java +++ b/src/main/java/org/gitnex/tea4j/v2/apis/RepositoryApi.java @@ -1627,9 +1627,10 @@ public interface RepositoryApi { * * @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) + * @param filepath path of the file to get, it should be \"{ref}/{filepath}\". If there + * is no ref could be inferred, it will be treated as the default branch (required) + * @param ref The name of the commit/branch/tag. Default the repository’s default branch + * (optional) * @return Call<File> */ @GET("repos/{owner}/{repo}/raw/{filepath}") @@ -1644,9 +1645,10 @@ public interface RepositoryApi { * * @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) + * @param filepath path of the file to get, it should be \"{ref}/{filepath}\". If there + * is no ref could be inferred, it will be treated as the default branch (required) + * @param ref The name of the commit/branch/tag. Default the repository’s default branch + * (optional) * @return Call<File> */ @GET("repos/{owner}/{repo}/media/{filepath}")