Synchronizing API and documentation updates

This commit is contained in:
gitnexbot
2023-06-09 00:14:18 +00:00
parent 046b53c029
commit bf189a2a40
6 changed files with 16 additions and 18 deletions
+3 -3
View File
@@ -3,11 +3,11 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**content** | **String** | content must be base64 encoded |
**content** | **String** | new or updated file content, must be base64 encoded | [optional]
**fromPath** | **String** | old path of the file to move | [optional]
**operation** | [**OperationEnum**](#OperationEnum) | indicates what to do with the file |
**path** | **String** | path to the existing or new file | [optional]
**sha** | **String** | sha is the SHA for the file that already exists, required for update, delete | [optional]
**path** | **String** | path to the existing or new file |
**sha** | **String** | sha is the SHA for the file that already exists, required for update or delete | [optional]
<a name="OperationEnum"></a>
## Enum: OperationEnum
+1 -1
View File
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
**branch** | **String** | branch (optional) to base this file from. if not given, the default branch is used | [optional]
**committer** | [**Identity**](Identity.md) | | [optional]
**dates** | [**CommitDateOptions**](CommitDateOptions.md) | | [optional]
**files** | [**List&lt;ChangeFileOperation&gt;**](ChangeFileOperation.md) | | [optional]
**files** | [**List&lt;ChangeFileOperation&gt;**](ChangeFileOperation.md) | list of file operations |
**message** | **String** | message (optional) for the commit of this file. if not supplied, a default message will be used | [optional]
**newBranch** | **String** | new_branch (optional) will make a new branch from &#x60;branch&#x60; before creating the file | [optional]
**signoff** | **Boolean** | Add a Signed-off-by trailer by the committer at the end of the commit log message. | [optional]
+2 -2
View File
@@ -19,7 +19,7 @@ Method | HTTP request | Description
[**repoAddTopic**](RepositoryApi.md#repoAddTopic) | **PUT** repos/{owner}/{repo}/topics/{topic} | Add a topic to a repository
[**repoApplyDiffPatch**](RepositoryApi.md#repoApplyDiffPatch) | **POST** repos/{owner}/{repo}/diffpatch | Apply diff patch to repository
[**repoCancelScheduledAutoMerge**](RepositoryApi.md#repoCancelScheduledAutoMerge) | **DELETE** repos/{owner}/{repo}/pulls/{index}/merge | Cancel the scheduled auto merge for the given pull request
[**repoChangeFiles**](RepositoryApi.md#repoChangeFiles) | **POST** repos/{owner}/{repo}/contents | Create or update multiple files in a repository
[**repoChangeFiles**](RepositoryApi.md#repoChangeFiles) | **POST** repos/{owner}/{repo}/contents | Modify multiple files in a repository
[**repoCheckCollaborator**](RepositoryApi.md#repoCheckCollaborator) | **GET** repos/{owner}/{repo}/collaborators/{collaborator} | Check if a user is a collaborator of a repository
[**repoCheckTeam**](RepositoryApi.md#repoCheckTeam) | **GET** repos/{owner}/{repo}/teams/{team} | Check if a team is assigned to a repository
[**repoCreateBranch**](RepositoryApi.md#repoCreateBranch) | **POST** repos/{owner}/{repo}/branches | Create a branch
@@ -1518,7 +1518,7 @@ Name | Type | Description | Notes
# **repoChangeFiles**
> FilesResponse repoChangeFiles(body, owner, repo)
Create or update multiple files in a repository
Modify multiple files in a repository
### Example
```java
@@ -303,7 +303,7 @@ public interface RepositoryApi {
@retrofit2.http.Path("index") Long index);
/**
* Create or update multiple files in a repository
* Modify multiple files in a repository
*
* @param body (required)
* @param owner owner of the repo (required)
@@ -94,11 +94,11 @@ public class ChangeFileOperation implements Serializable {
}
/**
* content must be base64 encoded
* new or updated file content, must be base64 encoded
*
* @return content
*/
@Schema(required = true, description = "content must be base64 encoded")
@Schema(description = "new or updated file content, must be base64 encoded")
public String getContent() {
return content;
}
@@ -155,7 +155,7 @@ public class ChangeFileOperation implements Serializable {
*
* @return path
*/
@Schema(description = "path to the existing or new file")
@Schema(required = true, description = "path to the existing or new file")
public String getPath() {
return path;
}
@@ -170,12 +170,13 @@ public class ChangeFileOperation implements Serializable {
}
/**
* sha is the SHA for the file that already exists, required for update, delete
* sha is the SHA for the file that already exists, required for update or delete
*
* @return sha
*/
@Schema(
description = "sha is the SHA for the file that already exists, required for update, delete")
description =
"sha is the SHA for the file that already exists, required for update or delete")
public String getSha() {
return sha;
}
@@ -45,7 +45,7 @@ public class ChangeFilesOptions implements Serializable {
private CommitDateOptions dates = null;
@SerializedName("files")
private List<ChangeFileOperation> files = null;
private List<ChangeFileOperation> files = new ArrayList<>();
@SerializedName("message")
private String message = null;
@@ -140,19 +140,16 @@ public class ChangeFilesOptions implements Serializable {
}
public ChangeFilesOptions addFilesItem(ChangeFileOperation filesItem) {
if (this.files == null) {
this.files = new ArrayList<>();
}
this.files.add(filesItem);
return this;
}
/**
* Get files
* list of file operations
*
* @return files
*/
@Schema(description = "")
@Schema(required = true, description = "list of file operations")
public List<ChangeFileOperation> getFiles() {
return files;
}