diff --git a/docs/RepositoryApi.md b/docs/RepositoryApi.md index 8a7cae2..d589833 100644 --- a/docs/RepositoryApi.md +++ b/docs/RepositoryApi.md @@ -4707,7 +4707,7 @@ 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 basehead = "basehead_example"; // String | compare two refs as `base...head` (or `base..head`); refs may be branches, tags, full or short SHAs, including branch names that contain slashes. +String basehead = "basehead_example"; // String | compare two refs as `base...head` (or `base..head`); refs may be branches, tags, full or short SHAs (including branch names that contain slashes), optionally with a `^` or `~N` revision suffix. String output = "output_example"; // String | return the raw comparison as `diff` or `patch` instead of JSON try { Compare result = apiInstance.repoCompareDiff(owner, repo, basehead, output); @@ -4724,7 +4724,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | - **basehead** | **String**| compare two refs as `base...head` (or `base..head`); refs may be branches, tags, full or short SHAs, including branch names that contain slashes. | + **basehead** | **String**| compare two refs as `base...head` (or `base..head`); refs may be branches, tags, full or short SHAs (including branch names that contain slashes), optionally with a `^` or `~N` revision suffix. | **output** | **String**| return the raw comparison as `diff` or `patch` instead of JSON | [optional] [enum: diff, patch] ### 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 3974c03..15e9b25 100644 --- a/src/main/java/org/gitnex/tea4j/v2/apis/RepositoryApi.java +++ b/src/main/java/org/gitnex/tea4j/v2/apis/RepositoryApi.java @@ -890,8 +890,8 @@ public interface RepositoryApi { * @param owner owner of the repo (required) * @param repo name of the repo (required) * @param basehead compare two refs as `base...head` (or `base..head`); refs - * may be branches, tags, full or short SHAs, including branch names that contain slashes. - * (required) + * may be branches, tags, full or short SHAs (including branch names that contain slashes), + * optionally with a `^` or `~N` revision suffix. (required) * @param output return the raw comparison as `diff` or `patch` instead of * JSON (optional) * @return Call<Compare>