Synchronizing API and documentation updates

This commit is contained in:
gitnexbot
2026-06-12 00:02:09 +00:00
parent 05d795aac5
commit 79c3e09d3d
10 changed files with 655 additions and 2 deletions
+1
View File
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
**id** | **Long** | | [optional]
**path** | **String** | | [optional]
**previousAttemptUrl** | **String** | PreviousAttemptURL is the API URL of the previous attempt of this run, e.g. \".../actions/runs/{run_id}/attempts/{attempt-1}\". It is set only when the current attempt is > 1 (i.e. a rerun). For the first attempt, or for legacy runs that pre-date ActionRunAttempt, it is null. | [optional]
**pullRequests** | [**List<PullRequestMinimal>**](PullRequestMinimal.md) | | [optional]
**repository** | [**Repository**](Repository.md) | | [optional]
**repositoryId** | **Long** | | [optional]
**runAttempt** | **Long** | RunAttempt is 1-based for runs created after ActionRunAttempt was introduced. A value of 0 is a legacy-only sentinel for runs created before attempts existed and indicates no corresponding /attempts/{n} resource is available. | [optional]
+10
View File
@@ -0,0 +1,10 @@
# PullRequestMinimal
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**base** | [**PullRequestMinimalHead**](PullRequestMinimalHead.md) | | [optional]
**head** | [**PullRequestMinimalHead**](PullRequestMinimalHead.md) | | [optional]
**id** | **Long** | | [optional]
**number** | **Long** | | [optional]
**url** | **String** | | [optional]
+8
View File
@@ -0,0 +1,8 @@
# PullRequestMinimalHead
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ref** | **String** | | [optional]
**repo** | [**PullRequestMinimalHeadRepo**](PullRequestMinimalHeadRepo.md) | | [optional]
**sha** | **String** | | [optional]
+8
View File
@@ -0,0 +1,8 @@
# PullRequestMinimalHeadRepo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Long** | | [optional]
**name** | **String** | | [optional]
**url** | **String** | | [optional]
+112 -2
View File
@@ -10,6 +10,7 @@ Method | HTTP request | Description
[**actionsEnableWorkflow**](RepositoryApi.md#actionsEnableWorkflow) | **PUT** repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable | Enable a workflow
[**actionsGetWorkflow**](RepositoryApi.md#actionsGetWorkflow) | **GET** repos/{owner}/{repo}/actions/workflows/{workflow_id} | Get a workflow
[**actionsListRepositoryWorkflows**](RepositoryApi.md#actionsListRepositoryWorkflows) | **GET** repos/{owner}/{repo}/actions/workflows | List repository workflows
[**actionsListWorkflowRuns**](RepositoryApi.md#actionsListWorkflowRuns) | **GET** repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs | List runs for a workflow
[**createCurrentUserRepo**](RepositoryApi.md#createCurrentUserRepo) | **POST** user/repos | Create a repository
[**createFork**](RepositoryApi.md#createFork) | **POST** repos/{owner}/{repo}/forks | Fork a repository
[**createRepoVariable**](RepositoryApi.md#createRepoVariable) | **POST** repos/{owner}/{repo}/actions/variables/{variablename} | Create a repo-level variable
@@ -747,6 +748,113 @@ 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**: application/json
<a name="actionsListWorkflowRuns"></a>
# **actionsListWorkflowRuns**
> ActionWorkflowRunsResponse actionsListWorkflowRuns(owner, repo, workflowId, event, branch, status, actor, headSha, excludePullRequests, page, limit)
List runs for a workflow
### 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 workflowId = "workflowId_example"; // String | id of the workflow, must be the workflow file name (e.g. `build.yml`)
String event = "event_example"; // String | workflow event name
String branch = "branch_example"; // String | workflow branch
String status = "status_example"; // String | workflow status (pending, queued, in_progress, failure, success, skipped)
String actor = "actor_example"; // String | triggered by user
String headSha = "headSha_example"; // String | triggering sha of the workflow run
Boolean excludePullRequests = true; // Boolean | if true, the `pull_requests` field on each returned run is emptied
Integer page = 56; // Integer | page number of results to return (1-based)
Integer limit = 56; // Integer | page size of results
try {
ActionWorkflowRunsResponse result = apiInstance.actionsListWorkflowRuns(owner, repo, workflowId, event, branch, status, actor, headSha, excludePullRequests, page, limit);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RepositoryApi#actionsListWorkflowRuns");
e.printStackTrace();
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**owner** | **String**| owner of the repo |
**repo** | **String**| name of the repo |
**workflowId** | **String**| id of the workflow, must be the workflow file name (e.g. &#x60;build.yml&#x60;) |
**event** | **String**| workflow event name | [optional]
**branch** | **String**| workflow branch | [optional]
**status** | **String**| workflow status (pending, queued, in_progress, failure, success, skipped) | [optional]
**actor** | **String**| triggered by user | [optional]
**headSha** | **String**| triggering sha of the workflow run | [optional]
**excludePullRequests** | **Boolean**| if true, the &#x60;pull_requests&#x60; field on each returned run is emptied | [optional]
**page** | **Integer**| page number of results to return (1-based) | [optional]
**limit** | **Integer**| page size of results | [optional]
### Return type
[**ActionWorkflowRunsResponse**](ActionWorkflowRunsResponse.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
@@ -2948,7 +3056,7 @@ Name | Type | Description | Notes
<a name="getWorkflowRuns"></a>
# **getWorkflowRuns**
> ActionWorkflowRunsResponse getWorkflowRuns(owner, repo, event, branch, status, actor, headSha, page, limit)
> ActionWorkflowRunsResponse getWorkflowRuns(owner, repo, event, branch, status, actor, headSha, excludePullRequests, page, limit)
Lists all runs for a repository run
@@ -3011,10 +3119,11 @@ String branch = "branch_example"; // String | workflow branch
String status = "status_example"; // String | workflow status (pending, queued, in_progress, failure, success, skipped)
String actor = "actor_example"; // String | triggered by user
String headSha = "headSha_example"; // String | triggering sha of the workflow run
Boolean excludePullRequests = true; // Boolean | if true, the `pull_requests` field on each returned run is emptied
Integer page = 56; // Integer | page number of results to return (1-based)
Integer limit = 56; // Integer | page size of results
try {
ActionWorkflowRunsResponse result = apiInstance.getWorkflowRuns(owner, repo, event, branch, status, actor, headSha, page, limit);
ActionWorkflowRunsResponse result = apiInstance.getWorkflowRuns(owner, repo, event, branch, status, actor, headSha, excludePullRequests, page, limit);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RepositoryApi#getWorkflowRuns");
@@ -3033,6 +3142,7 @@ Name | Type | Description | Notes
**status** | **String**| workflow status (pending, queued, in_progress, failure, success, skipped) | [optional]
**actor** | **String**| triggered by user | [optional]
**headSha** | **String**| triggering sha of the workflow run | [optional]
**excludePullRequests** | **Boolean**| if true, the &#x60;pull_requests&#x60; field on each returned run is emptied | [optional]
**page** | **Integer**| page number of results to return (1-based) | [optional]
**limit** | **Integer**| page size of results | [optional]