mirrors/forgejo
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2025-08-31 14:36:47 +00:00
Code Issues Projects Releases Packages Wiki Activity

chore(api): update swagger method descripitons (#8728)

Browse source 
Speaking from personal experience, when exploring the API I find myself trying to parse the exact meaning of many descriptions for a while, and I also have to get used to many different kinds of inconsistencies and grammar issues.

This PR improves a few of these. Some I tried to reword to make them easier to understand, for others I just improved consistency a little, like capitalization. This area needs more work, this PR just makes some progress. Anything that is improved in this one can be improved further in later PRs, so in review please focus on regressions if you find any.

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/8728
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: 0ko <0ko@noreply.codeberg.org>
Co-committed-by: 0ko <0ko@noreply.codeberg.org>
This commit is contained in:
0ko 2025-07-30 18:08:28 +02:00 • committed by Gusted
commit 022ab86988
18 changed files with 113 additions and 113 deletions
Download patch file Download diff file Expand all files Collapse all files

8
routers/api/v1/user/avatar.go
View file

@ -13,11 +13,11 @@ import (
user_service "forgejo.org/services/user"
)
// UpdateAvatar updates the Avatar of an User
// UpdateAvatar updates doer's avatar
func UpdateAvatar(ctx *context.APIContext) {
// swagger:operation POST /user/avatar user userUpdateAvatar
// ---
// summary: Update Avatar
// summary: Update avatar of the current user
// produces:
// - application/json
// parameters:
@ -49,11 +49,11 @@ func UpdateAvatar(ctx *context.APIContext) {
ctx.Status(http.StatusNoContent)
}
// DeleteAvatar deletes the Avatar of an User
// DeleteAvatar deletes doer's avatar
func DeleteAvatar(ctx *context.APIContext) {
// swagger:operation DELETE /user/avatar user userDeleteAvatar
// ---
// summary: Delete Avatar
// summary: Delete avatar of the current user. It will be replaced by a default one
// produces:
// - application/json
// responses: