Synchronizing API and documentation updates

This commit is contained in:
gitnexbot
2026-06-29 00:02:41 +00:00
parent 25dd7e882c
commit 36a23fe294
2 changed files with 15 additions and 5 deletions
+8 -4
View File
@@ -389,7 +389,7 @@ Name | Type | Description | Notes
<a name="actionsDispatchWorkflow"></a>
# **actionsDispatchWorkflow**
> RunDetails actionsDispatchWorkflow(owner, repo, workflowId, body, returnRunDetails)
> RunDetails actionsDispatchWorkflow(owner, repo, workflowId, body, returnRunDetails, scopedWorkflowSourceRepoId)
Create a workflow dispatch event
@@ -450,8 +450,9 @@ String repo = "repo_example"; // String | name of the repo
String workflowId = "workflowId_example"; // String | id of the workflow
CreateActionWorkflowDispatch body = new CreateActionWorkflowDispatch(); // CreateActionWorkflowDispatch |
Boolean returnRunDetails = true; // Boolean | Whether the response should include the workflow run ID and URLs.
Long scopedWorkflowSourceRepoId = 789L; // Long | For a scoped workflow, the ID of the source repository providing it; omit or 0 for a repo-level workflow.
try {
RunDetails result = apiInstance.actionsDispatchWorkflow(owner, repo, workflowId, body, returnRunDetails);
RunDetails result = apiInstance.actionsDispatchWorkflow(owner, repo, workflowId, body, returnRunDetails, scopedWorkflowSourceRepoId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RepositoryApi#actionsDispatchWorkflow");
@@ -468,6 +469,7 @@ Name | Type | Description | Notes
**workflowId** | **String**| id of the workflow |
**body** | [**CreateActionWorkflowDispatch**](CreateActionWorkflowDispatch.md)| | [optional]
**returnRunDetails** | **Boolean**| Whether the response should include the workflow run ID and URLs. | [optional]
**scopedWorkflowSourceRepoId** | **Long**| For a scoped workflow, the ID of the source repository providing it; omit or 0 for a repo-level workflow. | [optional]
### Return type
@@ -755,7 +757,7 @@ Name | Type | Description | Notes
<a name="actionsListWorkflowRuns"></a>
# **actionsListWorkflowRuns**
> ActionWorkflowRunsResponse actionsListWorkflowRuns(owner, repo, workflowId, event, branch, status, actor, headSha, excludePullRequests, page, limit)
> ActionWorkflowRunsResponse actionsListWorkflowRuns(owner, repo, workflowId, event, branch, status, actor, headSha, excludePullRequests, scopedWorkflowSourceRepoId, page, limit)
List runs for a workflow
@@ -820,10 +822,11 @@ String status = "status_example"; // String | workflow status (pending, queued,
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
Long scopedWorkflowSourceRepoId = 789L; // Long | For a scoped workflow, the ID of the source repository providing it; omit or 0 for a repo-level workflow.
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);
ActionWorkflowRunsResponse result = apiInstance.actionsListWorkflowRuns(owner, repo, workflowId, event, branch, status, actor, headSha, excludePullRequests, scopedWorkflowSourceRepoId, page, limit);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RepositoryApi#actionsListWorkflowRuns");
@@ -844,6 +847,7 @@ Name | Type | Description | Notes
**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]
**scopedWorkflowSourceRepoId** | **Long**| For a scoped workflow, the ID of the source repository providing it; omit or 0 for a repo-level workflow. | [optional]
**page** | **Integer**| page number of results to return (1-based) | [optional]
**limit** | **Integer**| page size of results | [optional]
@@ -154,6 +154,8 @@ public interface RepositoryApi {
* @param body (optional)
* @param returnRunDetails Whether the response should include the workflow run ID and URLs.
* (optional)
* @param scopedWorkflowSourceRepoId For a scoped workflow, the ID of the source repository
* providing it; omit or 0 for a repo-level workflow. (optional)
* @return Call&lt;RunDetails&gt;
*/
@Headers({"Content-Type:application/json"})
@@ -163,7 +165,8 @@ public interface RepositoryApi {
@retrofit2.http.Path("repo") String repo,
@retrofit2.http.Path("workflow_id") String workflowId,
@retrofit2.http.Body CreateActionWorkflowDispatch body,
@retrofit2.http.Query("return_run_details") Boolean returnRunDetails);
@retrofit2.http.Query("return_run_details") Boolean returnRunDetails,
@retrofit2.http.Query("scoped_workflow_source_repo_id") Long scopedWorkflowSourceRepoId);
/**
* Enable a workflow
@@ -219,6 +222,8 @@ public interface RepositoryApi {
* @param headSha triggering sha of the workflow run (optional)
* @param excludePullRequests if true, the &#x60;pull_requests&#x60; field on each returned run is
* emptied (optional)
* @param scopedWorkflowSourceRepoId For a scoped workflow, the ID of the source repository
* providing it; omit or 0 for a repo-level workflow. (optional)
* @param page page number of results to return (1-based) (optional)
* @param limit page size of results (optional)
* @return Call&lt;ActionWorkflowRunsResponse&gt;
@@ -234,6 +239,7 @@ public interface RepositoryApi {
@retrofit2.http.Query("actor") String actor,
@retrofit2.http.Query("head_sha") String headSha,
@retrofit2.http.Query("exclude_pull_requests") Boolean excludePullRequests,
@retrofit2.http.Query("scoped_workflow_source_repo_id") Long scopedWorkflowSourceRepoId,
@retrofit2.http.Query("page") Integer page,
@retrofit2.http.Query("limit") Integer limit);