Fixes some issues with the swagger documentation for the new multiple
files API endpoint (#24887) which were overlooked when submitting the
original PR:
1. add some missing parameter descriptions
2. set correct `required` option for required parameters
3. change endpoint description to match it full functionality (every
kind of file modification is supported, not just creating and updating)
"summary": "Create or update multiple files in a repository",
"summary": "Modify multiple files in a repository",
"operationId": "repoChangeFiles",
"operationId": "repoChangeFiles",
"parameters": [
"parameters": [
{
{
@ -15947,11 +15947,11 @@
"type": "object",
"type": "object",
"required": [
"required": [
"operation",
"operation",
"content"
"path"
],
],
"properties": {
"properties": {
"content": {
"content": {
"description": "content must be base64 encoded",
"description": "new or updated file content, must be base64 encoded",
"type": "string",
"type": "string",
"x-go-name": "Content"
"x-go-name": "Content"
},
},
@ -15976,7 +15976,7 @@
"x-go-name": "Path"
"x-go-name": "Path"
},
},
"sha": {
"sha": {
"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",
"type": "string",
"type": "string",
"x-go-name": "SHA"
"x-go-name": "SHA"
}
}
@ -15986,6 +15986,9 @@
"ChangeFilesOptions": {
"ChangeFilesOptions": {
"description": "ChangeFilesOptions options for creating, updating or deleting multiple files\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
"description": "ChangeFilesOptions options for creating, updating or deleting multiple files\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",