Synchronizing API and documentation updates

src/main/java/org/gitnex/tea4j/v2/apis/RepositoryApi.java

@@ -222,7 +222,7 @@ public interface RepositoryApi {
   /**
    * Create a repo-level variable
    *
-   * @param owner name of the owner (required)
+   * @param owner owner of the repo (required)
    * @param repo name of the repository (required)
    * @param variablename name of the variable (required)
    * @param body (optional)
@@ -239,7 +239,7 @@ public interface RepositoryApi {
   /**
    * Delete a workflow run
    *
-   * @param owner name of the owner (required)
+   * @param owner owner of the repo (required)
    * @param repo name of the repository (required)
    * @param run runid of the workflow run (required)
    * @return Call<Void>
@@ -253,7 +253,7 @@ public interface RepositoryApi {
   /**
    * Deletes a specific artifact for a workflow run
    *
-   * @param owner name of the owner (required)
+   * @param owner owner of the repo (required)
    * @param repo name of the repository (required)
    * @param artifactId id of the artifact (required)
    * @return Call<Void>
@@ -295,7 +295,7 @@ public interface RepositoryApi {
   /**
    * Delete a repo-level variable
    *
-   * @param owner name of the owner (required)
+   * @param owner owner of the repo (required)
    * @param repo name of the repository (required)
    * @param variablename name of the variable (required)
    * @return Call<ActionVariable>
@@ -309,7 +309,7 @@ public interface RepositoryApi {
   /**
    * Downloads the job logs for a workflow run
    *
-   * @param owner name of the owner (required)
+   * @param owner owner of the repo (required)
    * @param repo name of the repository (required)
    * @param jobId id of the job (required)
    * @return Call<Void>
@@ -323,7 +323,7 @@ public interface RepositoryApi {
   /**
    * Downloads a specific artifact for a workflow run redirects to blob url
    *
-   * @param owner name of the owner (required)
+   * @param owner owner of the repo (required)
    * @param repo name of the repository (required)
    * @param artifactId id of the artifact (required)
    * @return Call<Void>
@@ -337,7 +337,7 @@ public interface RepositoryApi {
   /**
    * Create a repository using a template
    *
-   * @param templateOwner name of the template repository owner (required)
+   * @param templateOwner owner of the template repository (required)
    * @param templateRepo name of the template repository (required)
    * @param body (optional)
    * @return Call<Repository>
@@ -367,7 +367,7 @@ public interface RepositoryApi {
   /**
    * Gets a specific artifact for a workflow run
    *
-   * @param owner name of the owner (required)
+   * @param owner owner of the repo (required)
    * @param repo name of the repository (required)
    * @param artifactId id of the artifact (required)
    * @return Call<ActionArtifact>
@@ -381,7 +381,7 @@ public interface RepositoryApi {
   /**
    * Lists all artifacts for a repository
    *
-   * @param owner name of the owner (required)
+   * @param owner owner of the repo (required)
    * @param repo name of the repository (required)
    * @param name name of the artifact (optional)
    * @return Call<ActionArtifactsResponse>
@@ -395,7 +395,7 @@ public interface RepositoryApi {
   /**
    * Lists all artifacts for a repository run
    *
-   * @param owner name of the owner (required)
+   * @param owner owner of the repo (required)
    * @param repo name of the repository (required)
    * @param run runid of the workflow run (required)
    * @param name name of the artifact (optional)
@@ -450,7 +450,7 @@ public interface RepositoryApi {
   /**
    * Get a repo-level variable
    *
-   * @param owner name of the owner (required)
+   * @param owner owner of the repo (required)
    * @param repo name of the repository (required)
    * @param variablename name of the variable (required)
    * @return Call<ActionVariable>
@@ -464,7 +464,7 @@ public interface RepositoryApi {
   /**
    * Get repo-level variables list
    *
-   * @param owner name of the owner (required)
+   * @param owner owner of the repo (required)
    * @param repo name of the repository (required)
    * @param page page number of results to return (1-based) (optional)
    * @param limit page size of results (optional)
@@ -501,7 +501,7 @@ public interface RepositoryApi {
   /**
    * Gets a specific workflow job for a workflow run
    *
-   * @param owner name of the owner (required)
+   * @param owner owner of the repo (required)
    * @param repo name of the repository (required)
    * @param jobId id of the job (required)
    * @return Call<ActionWorkflowJob>
@@ -515,7 +515,7 @@ public interface RepositoryApi {
   /**
    * Gets a specific workflow run
    *
-   * @param owner name of the owner (required)
+   * @param owner owner of the repo (required)
    * @param repo name of the repository (required)
    * @param run id of the run (required)
    * @return Call<ActionWorkflowRun>
@@ -529,7 +529,7 @@ public interface RepositoryApi {
   /**
    * Lists all runs for a repository run
    *
-   * @param owner name of the owner (required)
+   * @param owner owner of the repo (required)
    * @param repo name of the repository (required)
    * @param event workflow event name (optional)
    * @param branch workflow branch (optional)
@@ -588,7 +588,7 @@ public interface RepositoryApi {
   /**
    * Lists all jobs for a repository
    *
-   * @param owner name of the owner (required)
+   * @param owner owner of the repo (required)
    * @param repo name of the repository (required)
    * @param status workflow status (pending, queued, in_progress, failure, success, skipped)
    *     (optional)
@@ -607,7 +607,7 @@ public interface RepositoryApi {
   /**
    * Lists all jobs for a workflow run
    *
-   * @param owner name of the owner (required)
+   * @param owner owner of the repo (required)
    * @param repo name of the repository (required)
    * @param run runid of the workflow run (required)
    * @param status workflow status (pending, queued, in_progress, failure, success, skipped)
@@ -2247,7 +2247,7 @@ public interface RepositoryApi {
   /**
    * List an repo's actions secrets
    *
-   * @param owner owner of the repository (required)
+   * @param owner owner of the repo (required)
    * @param repo name of the repository (required)
    * @param page page number of results to return (1-based) (optional)
    * @param limit page size of results (optional)
@@ -2418,7 +2418,7 @@ public interface RepositoryApi {
   /**
    * List a repo's pull requests
    *
-   * @param owner Owner of the repo (required)
+   * @param owner owner of the repo (required)
    * @param repo Name of the repo (required)
    * @param baseBranch Filter by target base branch of the pull request (optional)
    * @param state State of pull request (optional, default to open)
@@ -3037,7 +3037,7 @@ public interface RepositoryApi {
   /**
    * Update a repo-level variable
    *
-   * @param owner name of the owner (required)
+   * @param owner owner of the repo (required)
    * @param repo name of the repository (required)
    * @param variablename name of the variable (required)
    * @param body (optional)

src/main/java/org/gitnex/tea4j/v2/models/GenerateRepoOption.java

@@ -17,8 +17,8 @@ import io.swagger.v3.oas.annotations.media.Schema;
 import java.io.Serializable;
 import java.util.Objects;
 
-/** GenerateRepoOption options when creating repository using a template */
-@Schema(description = "GenerateRepoOption options when creating repository using a template")
+/** GenerateRepoOption options when creating a repository using a template */
+@Schema(description = "GenerateRepoOption options when creating a repository using a template")
 public class GenerateRepoOption implements Serializable {
   private static final long serialVersionUID = 1L;
 
@@ -178,11 +178,11 @@ public class GenerateRepoOption implements Serializable {
   }
 
   /**
-   * Name of the repository to create
+   * Get name
    *
    * @return name
    */
-  @Schema(required = true, description = "Name of the repository to create")
+  @Schema(required = true, description = "")
   public String getName() {
     return name;
   }
@@ -197,13 +197,14 @@ public class GenerateRepoOption implements Serializable {
   }
 
   /**
-   * The organization or person who will own the new repository
+   * the organization's name or individual user's name who will own the new repository
    *
    * @return owner
    */
   @Schema(
       required = true,
-      description = "The organization or person who will own the new repository")
+      description =
+          "the organization's name or individual user's name who will own the new repository")
   public String getOwner() {
     return owner;
   }

src/main/java/org/gitnex/tea4j/v2/models/IssueMeta.java

@@ -56,11 +56,11 @@ public class IssueMeta implements Serializable {
   }
 
   /**
-   * Get owner
+   * owner of the issue's repo
    *
    * @return owner
    */
-  @Schema(description = "")
+  @Schema(description = "owner of the issue's repo")
   public String getOwner() {
     return owner;
   }

src/main/java/org/gitnex/tea4j/v2/models/MigrateRepoOptions.java

@@ -498,11 +498,14 @@ public class MigrateRepoOptions implements Serializable {
   }
 
   /**
-   * Name of User or Organisation who will own Repo after migration
+   * the organization's name or individual user's name who will own the migrated
+   * repository
    *
    * @return repoOwner
    */
-  @Schema(description = "Name of User or Organisation who will own Repo after migration")
+  @Schema(
+      description =
+          "the organization's name or individual user's name who will own the migrated repository")
   public String getRepoOwner() {
     return repoOwner;
   }
@@ -536,11 +539,11 @@ public class MigrateRepoOptions implements Serializable {
   }
 
   /**
-   * deprecated (only for backwards compatibility)
+   * deprecated (only for backwards compatibility, use repo_owner instead)
    *
    * @return uid
    */
-  @Schema(description = "deprecated (only for backwards compatibility)")
+  @Schema(description = "deprecated (only for backwards compatibility, use repo_owner instead)")
   public Long getUid() {
     return uid;
   }