kevadesu/forgejo
1
0
Fork 1
mirror of https://codeberg.org/forgejo/forgejo.git synced 2025-08-14 23:26:48 +02: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
parent 98e2a64e2d
commit 022ab86988
18 changed files with 113 additions and 113 deletions
Download patch file Download diff file Expand all files Collapse all files

14
routers/api/v1/admin/user.go
View file

@ -51,11 +51,11 @@ func parseAuthSource(ctx *context.APIContext, u *user_model.User, sourceID int64
u.LoginSource = source.ID
}
// CreateUser create a user
// CreateUser create a user account
func CreateUser(ctx *context.APIContext) {
// swagger:operation POST /admin/users admin adminCreateUser
// ---
// summary: Create a user
// summary: Create a user account
// consumes:
// - application/json
// produces:
@ -274,7 +274,7 @@ func EditUser(ctx *context.APIContext) {
func DeleteUser(ctx *context.APIContext) {
// swagger:operation DELETE /admin/users/{username} admin adminDeleteUser
// ---
// summary: Delete a user
// summary: Delete user account
// produces:
// - application/json
// parameters:
@ -324,11 +324,11 @@ func DeleteUser(ctx *context.APIContext) {
ctx.Status(http.StatusNoContent)
}
// CreatePublicKey api for creating a public key to a user
// CreatePublicKey adds an SSH public key to user's account
func CreatePublicKey(ctx *context.APIContext) {
// swagger:operation POST /admin/users/{username}/keys admin adminCreatePublicKey
// ---
// summary: Add a public key on behalf of a user
// summary: Add an SSH public key to user's account
// consumes:
// - application/json
// produces:
@ -356,11 +356,11 @@ func CreatePublicKey(ctx *context.APIContext) {
user.CreateUserPublicKey(ctx, *form, ctx.ContextUser.ID)
}
// DeleteUserPublicKey api for deleting a user's public key
// DeleteUserPublicKey removes an SSH public key from user's account
func DeleteUserPublicKey(ctx *context.APIContext) {
// swagger:operation DELETE /admin/users/{username}/keys/{id} admin adminDeleteUserPublicKey
// ---
// summary: Delete a user's public key
// summary: Remove a public key from user's account
// produces:
// - application/json
// parameters: