domi/forgejo-domi
1
0
Fork 0
forked from forgejo/forgejo
Code Pull requests Activity

fix swagger documentation for multiple files API endpoint (#25110)

Browse source 
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)
This commit is contained in:
Denys Konovalov 2023-06-07 17:49:58 +02:00 • committed by GitHub
parent 027014d7de
commit eac1bddb8d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

4
routers/api/v1/repo/file.go
View file

@ -408,11 +408,11 @@ func canReadFiles(r *context.Repository) bool {
return r.Permission.CanRead(unit.TypeCode)
}
// ChangeFiles handles API call for creating or updating multiple files
// ChangeFiles handles API call for modifying multiple files
func ChangeFiles(ctx *context.APIContext) {
// swagger:operation POST /repos/{owner}/{repo}/contents repository repoChangeFiles
// ---
// summary: Create or update multiple files in a repository
// summary: Modify multiple files in a repository
// consumes:
// - application/json
// produces: