Synchronizing API and documentation updates

This commit is contained in:
gitnexbot
2026-04-24 00:03:06 +00:00
parent 7bdb6d453d
commit a8286526e7
4 changed files with 276 additions and 3 deletions
@@ -538,6 +538,22 @@ public interface RepositoryApi {
@retrofit2.http.Path("repo") String repo,
@retrofit2.http.Path("run") Integer run);
/**
* Gets a specific workflow run attempt
*
* @param owner owner of the repo (required)
* @param repo name of the repository (required)
* @param run id of the run (required)
* @param attempt logical attempt number of the run (required)
* @return Call<ActionWorkflowRun>
*/
@GET("repos/{owner}/{repo}/actions/runs/{run}/attempts/{attempt}")
Call<ActionWorkflowRun> getWorkflowRunAttempt(
@retrofit2.http.Path("owner") String owner,
@retrofit2.http.Path("repo") String repo,
@retrofit2.http.Path("run") Integer run,
@retrofit2.http.Path("attempt") Integer attempt);
/**
* Lists all runs for a repository run
*
@@ -616,6 +632,29 @@ public interface RepositoryApi {
@retrofit2.http.Query("page") Integer page,
@retrofit2.http.Query("limit") Integer limit);
/**
* Lists all jobs for a workflow run attempt
*
* @param owner owner of the repo (required)
* @param repo name of the repository (required)
* @param run id of the workflow run (required)
* @param attempt logical attempt number of the run (required)
* @param status workflow status (pending, queued, in_progress, failure, success, skipped)
* (optional)
* @param page page number of results to return (1-based) (optional)
* @param limit page size of results (optional)
* @return Call&lt;ActionWorkflowJobsResponse&gt;
*/
@GET("repos/{owner}/{repo}/actions/runs/{run}/attempts/{attempt}/jobs")
Call<ActionWorkflowJobsResponse> listWorkflowRunAttemptJobs(
@retrofit2.http.Path("owner") String owner,
@retrofit2.http.Path("repo") String repo,
@retrofit2.http.Path("run") Integer run,
@retrofit2.http.Path("attempt") Integer attempt,
@retrofit2.http.Query("status") String status,
@retrofit2.http.Query("page") Integer page,
@retrofit2.http.Query("limit") Integer limit);
/**
* Lists all jobs for a workflow run
*
@@ -56,6 +56,9 @@ public class ActionWorkflowRun implements Serializable {
@SerializedName("path")
private String path = null;
@SerializedName("previous_attempt_url")
private String previousAttemptUrl = null;
@SerializedName("repository")
private Repository repository = null;
@@ -289,6 +292,33 @@ public class ActionWorkflowRun implements Serializable {
this.path = path;
}
public ActionWorkflowRun previousAttemptUrl(String previousAttemptUrl) {
this.previousAttemptUrl = previousAttemptUrl;
return this;
}
/**
* PreviousAttemptURL is the API URL of the previous attempt of this run, e.g.
* \&quot;.../actions/runs/{run_id}/attempts/{attempt-1}\&quot;. It is set only when the current
* attempt is &gt; 1 (i.e. a rerun). For the first attempt, or for legacy runs that pre-date
* ActionRunAttempt, it is null.
*
* @return previousAttemptUrl
*/
@Schema(
description =
"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.")
public String getPreviousAttemptUrl() {
return previousAttemptUrl;
}
public void setPreviousAttemptUrl(String previousAttemptUrl) {
this.previousAttemptUrl = previousAttemptUrl;
}
public ActionWorkflowRun repository(Repository repository) {
this.repository = repository;
return this;
@@ -333,11 +363,17 @@ public class ActionWorkflowRun implements Serializable {
}
/**
* Get runAttempt
* 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.
*
* @return runAttempt
*/
@Schema(description = "")
@Schema(
description =
"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.")
public Long getRunAttempt() {
return runAttempt;
}
@@ -461,6 +497,7 @@ public class ActionWorkflowRun implements Serializable {
&& Objects.equals(this.htmlUrl, actionWorkflowRun.htmlUrl)
&& Objects.equals(this.id, actionWorkflowRun.id)
&& Objects.equals(this.path, actionWorkflowRun.path)
&& Objects.equals(this.previousAttemptUrl, actionWorkflowRun.previousAttemptUrl)
&& Objects.equals(this.repository, actionWorkflowRun.repository)
&& Objects.equals(this.repositoryId, actionWorkflowRun.repositoryId)
&& Objects.equals(this.runAttempt, actionWorkflowRun.runAttempt)
@@ -485,6 +522,7 @@ public class ActionWorkflowRun implements Serializable {
htmlUrl,
id,
path,
previousAttemptUrl,
repository,
repositoryId,
runAttempt,
@@ -511,6 +549,7 @@ public class ActionWorkflowRun implements Serializable {
sb.append(" htmlUrl: ").append(toIndentedString(htmlUrl)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" path: ").append(toIndentedString(path)).append("\n");
sb.append(" previousAttemptUrl: ").append(toIndentedString(previousAttemptUrl)).append("\n");
sb.append(" repository: ").append(toIndentedString(repository)).append("\n");
sb.append(" repositoryId: ").append(toIndentedString(repositoryId)).append("\n");
sb.append(" runAttempt: ").append(toIndentedString(runAttempt)).append("\n");