From 887e41cb8b30fba711587386eb5a1ffb2b4d41a5 Mon Sep 17 00:00:00 2001 From: gitnexbot Date: Tue, 16 Jun 2026 00:02:12 +0000 Subject: [PATCH] Synchronizing API and documentation updates --- docs/RepositoryApi.md | 14 +++++++++----- .../org/gitnex/tea4j/v2/apis/RepositoryApi.java | 13 ++++++++++--- 2 files changed, 19 insertions(+), 8 deletions(-) diff --git a/docs/RepositoryApi.md b/docs/RepositoryApi.md index 43f7f65..8a7cae2 100644 --- a/docs/RepositoryApi.md +++ b/docs/RepositoryApi.md @@ -4647,10 +4647,12 @@ Name | Type | Description | Notes # **repoCompareDiff** -> Compare repoCompareDiff(owner, repo, basehead) +> Compare repoCompareDiff(owner, repo, basehead, output) Get commit comparison information +By default returns JSON commit comparison information. The raw diff or patch can be requested with the `output` query parameter set to `diff` or `patch` respectively. + ### Example ```java // Import classes: @@ -4705,9 +4707,10 @@ 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 branches or commits +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 output = "output_example"; // String | return the raw comparison as `diff` or `patch` instead of JSON try { - Compare result = apiInstance.repoCompareDiff(owner, repo, basehead); + Compare result = apiInstance.repoCompareDiff(owner, repo, basehead, output); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RepositoryApi#repoCompareDiff"); @@ -4721,7 +4724,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | - **basehead** | **String**| compare two branches or commits | + **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. | + **output** | **String**| return the raw comparison as `diff` or `patch` instead of JSON | [optional] [enum: diff, patch] ### Return type @@ -4734,7 +4738,7 @@ Name | Type | Description | Notes ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: application/json, text/plain # **repoCreateBranch** 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 f43a950..3974c03 100644 --- a/src/main/java/org/gitnex/tea4j/v2/apis/RepositoryApi.java +++ b/src/main/java/org/gitnex/tea4j/v2/apis/RepositoryApi.java @@ -883,18 +883,25 @@ public interface RepositoryApi { @retrofit2.http.Path("team") String team); /** - * Get commit comparison information + * Get commit comparison information By default returns JSON commit comparison information. The + * raw diff or patch can be requested with the `output` query parameter set to + * `diff` or `patch` respectively. * * @param owner owner of the repo (required) * @param repo name of the repo (required) - * @param basehead compare two branches or commits (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) + * @param output return the raw comparison as `diff` or `patch` instead of + * JSON (optional) * @return Call<Compare> */ @GET("repos/{owner}/{repo}/compare/{basehead}") Call repoCompareDiff( @retrofit2.http.Path("owner") String owner, @retrofit2.http.Path("repo") String repo, - @retrofit2.http.Path("basehead") String basehead); + @retrofit2.http.Path("basehead") String basehead, + @retrofit2.http.Query("output") String output); /** * Create a branch