Synchronizing API and documentation updates

This commit is contained in:
gitnexbot
2025-10-25 00:09:58 +00:00
parent 795664fe8c
commit e7078b8844
7 changed files with 25 additions and 29 deletions
@@ -2946,7 +2946,7 @@ public interface RepositoryApi {
@retrofit2.http.Body UpdateBranchProtectionPriories body);
/**
* Update a file in a repository
* Update a file in a repository if SHA is set, or create the file if SHA is not set
*
* @param body (required)
* @param owner owner of the repo (required)
@@ -18,13 +18,13 @@ import java.io.Serializable;
import java.util.Objects;
/**
* CreateFileOptions options for creating files Note: `author` and `committer`
* CreateFileOptions options for creating a file Note: `author` and `committer`
* are optional (if only one is given, it will be used for the other, otherwise the authenticated
* user will be used)
*/
@Schema(
description =
"CreateFileOptions options for creating files Note: `author` and `committer` are optional"
"CreateFileOptions options for creating a file Note: `author` and `committer` are optional"
+ " (if only one is given, it will be used for the other, otherwise the authenticated"
+ " user will be used)")
public class CreateFileOptions implements Serializable {
@@ -18,15 +18,15 @@ import java.io.Serializable;
import java.util.Objects;
/**
* DeleteFileOptions options for deleting files (used for other File structs below) Note:
* `author` and `committer` are optional (if only one is given, it will be used
* for the other, otherwise the authenticated user will be used)
* DeleteFileOptions options for deleting a file Note: `author` and `committer`
* are optional (if only one is given, it will be used for the other, otherwise the authenticated
* user will be used)
*/
@Schema(
description =
"DeleteFileOptions options for deleting files (used for other File structs below) Note:"
+ " `author` and `committer` are optional (if only one is given, it will be used for"
+ " the other, otherwise the authenticated user will be used)")
"DeleteFileOptions options for deleting a file Note: `author` and `committer` are optional"
+ " (if only one is given, it will be used for the other, otherwise the authenticated"
+ " user will be used)")
public class DeleteFileOptions implements Serializable {
private static final long serialVersionUID = 1L;
@@ -209,15 +209,11 @@ public class DeleteFileOptions implements Serializable {
}
/**
* the blob ID (SHA) for the file that already exists, it is required for changing existing files
* the blob ID (SHA) for the file to delete
*
* @return sha
*/
@Schema(
required = true,
description =
"the blob ID (SHA) for the file that already exists, it is required for changing existing"
+ " files")
@Schema(required = true, description = "the blob ID (SHA) for the file to delete")
public String getSha() {
return sha;
}
@@ -18,15 +18,15 @@ import java.io.Serializable;
import java.util.Objects;
/**
* UpdateFileOptions options for updating files Note: `author` and `committer`
* are optional (if only one is given, it will be used for the other, otherwise the authenticated
* user will be used)
* UpdateFileOptions options for updating or creating a file Note: `author` and
* `committer` are optional (if only one is given, it will be used for the other,
* otherwise the authenticated user will be used)
*/
@Schema(
description =
"UpdateFileOptions options for updating files Note: `author` and `committer` are optional"
+ " (if only one is given, it will be used for the other, otherwise the authenticated"
+ " user will be used)")
"UpdateFileOptions options for updating or creating a file Note: `author` and `committer`"
+ " are optional (if only one is given, it will be used for the other, otherwise the"
+ " authenticated user will be used)")
public class UpdateFileOptions implements Serializable {
private static final long serialVersionUID = 1L;
@@ -257,15 +257,15 @@ public class UpdateFileOptions implements Serializable {
}
/**
* the blob ID (SHA) for the file that already exists, it is required for changing existing files
* the blob ID (SHA) for the file that already exists to update, or leave it empty to create a new
* file
*
* @return sha
*/
@Schema(
required = true,
description =
"the blob ID (SHA) for the file that already exists, it is required for changing existing"
+ " files")
"the blob ID (SHA) for the file that already exists to update, or leave it empty to"
+ " create a new file")
public String getSha() {
return sha;
}