Synchronizing API and documentation updates

This commit is contained in:
gitnexbot
2026-06-16 00:02:12 +00:00
parent 60e927ee6c
commit 887e41cb8b
2 changed files with 19 additions and 8 deletions
+9 -5
View File
@@ -4647,10 +4647,12 @@ Name | Type | Description | Notes
<a name="repoCompareDiff"></a>
# **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 &#x60;output&#x60; query parameter set to &#x60;diff&#x60; or &#x60;patch&#x60; 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 &#x60;base...head&#x60; (or &#x60;base..head&#x60;); refs may be branches, tags, full or short SHAs, including branch names that contain slashes. |
**output** | **String**| return the raw comparison as &#x60;diff&#x60; or &#x60;patch&#x60; 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
<a name="repoCreateBranch"></a>
# **repoCreateBranch**
@@ -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 &#x60;output&#x60; query parameter set to
* &#x60;diff&#x60; or &#x60;patch&#x60; 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 &#x60;base...head&#x60; (or &#x60;base..head&#x60;); refs
* may be branches, tags, full or short SHAs, including branch names that contain slashes.
* (required)
* @param output return the raw comparison as &#x60;diff&#x60; or &#x60;patch&#x60; instead of
* JSON (optional)
* @return Call&lt;Compare&gt;
*/
@GET("repos/{owner}/{repo}/compare/{basehead}")
Call<Compare> 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