diff options
| author | Denys Konovalov <kontakt@denyskon.de> | 2023-06-07 17:49:58 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-06-07 23:49:58 +0800 |
| commit | eac1bddb8da2e26a3f6d6678b9888c65418cf318 (patch) | |
| tree | 7e004c97853bc03c780cdf511ff58ec58498d690 /templates/swagger/v1_json.tmpl | |
| parent | 027014d7de19a566cde306c868a31895903d00d5 (diff) | |
| download | gitea-eac1bddb8da2e26a3f6d6678b9888c65418cf318.tar.gz gitea-eac1bddb8da2e26a3f6d6678b9888c65418cf318.zip | |
fix swagger documentation for multiple files API endpoint (#25110)v1.20.0-rc0
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)
Diffstat (limited to 'templates/swagger/v1_json.tmpl')
| -rw-r--r-- | templates/swagger/v1_json.tmpl | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index 75492ab631..e78c077fc3 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -4074,7 +4074,7 @@ "tags": [ "repository" ], - "summary": "Create or update multiple files in a repository", + "summary": "Modify multiple files in a repository", "operationId": "repoChangeFiles", "parameters": [ { @@ -15947,11 +15947,11 @@ "type": "object", "required": [ "operation", - "content" + "path" ], "properties": { "content": { - "description": "content must be base64 encoded", + "description": "new or updated file content, must be base64 encoded", "type": "string", "x-go-name": "Content" }, @@ -15976,7 +15976,7 @@ "x-go-name": "Path" }, "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", "x-go-name": "SHA" } @@ -15986,6 +15986,9 @@ "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)", "type": "object", + "required": [ + "files" + ], "properties": { "author": { "$ref": "#/definitions/Identity" @@ -16002,6 +16005,7 @@ "$ref": "#/definitions/CommitDateOptions" }, "files": { + "description": "list of file operations", "type": "array", "items": { "$ref": "#/definitions/ChangeFileOperation" |