[API] GET / SET User Settings (#16169)

* API: GET/SET User Settings

* linter

* Apply suggestions from code review

* Update modules/structs/user.go

* lint

* fix swagger

* move User2UserSettings to convert

* as per @zeripath "preferences" -> "settings"

Co-authored-by: techknowlogick <matti@mdranta.net>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
This commit is contained in:
6543 2021-06-23 21:58:44 +02:00 committed by GitHub
parent 8640717f5f
commit 58501a2682
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 281 additions and 1 deletions

View file

@ -649,6 +649,10 @@ func Routes() *web.Route {
m.Group("/user", func() {
m.Get("", user.GetAuthenticatedUser)
m.Group("/settings", func() {
m.Get("", user.GetUserSettings)
m.Patch("", bind(api.UserSettingsOptions{}), user.UpdateUserSettings)
}, reqToken())
m.Combo("/emails").Get(user.ListEmails).
Post(bind(api.CreateEmailOption{}), user.AddEmail).
Delete(bind(api.DeleteEmailOption{}), user.DeleteEmail)

View file

@ -161,4 +161,7 @@ type swaggerParameterBodies struct {
// in:body
CreateTagOption api.CreateTagOption
// in:body
UserSettingsOptions api.UserSettingsOptions
}

View file

@ -42,3 +42,10 @@ type swaggerResponseUserHeatmapData struct {
// in:body
Body []models.UserHeatmapData `json:"body"`
}
// UserSettings
// swagger:response UserSettings
type swaggerResponseUserSettings struct {
// in:body
Body []api.UserSettings `json:"body"`
}

View file

@ -0,0 +1,83 @@
// Copyright 2021 The Gitea Authors. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
package user
import (
"net/http"
"code.gitea.io/gitea/models"
"code.gitea.io/gitea/modules/context"
"code.gitea.io/gitea/modules/convert"
api "code.gitea.io/gitea/modules/structs"
"code.gitea.io/gitea/modules/web"
)
// GetUserSettings returns user settings
func GetUserSettings(ctx *context.APIContext) {
// swagger:operation GET /user/settings user getUserSettings
// ---
// summary: Get user settings
// produces:
// - application/json
// responses:
// "200":
// "$ref": "#/responses/UserSettings"
ctx.JSON(http.StatusOK, convert.User2UserSettings(ctx.User))
}
// UpdateUserSettings returns user settings
func UpdateUserSettings(ctx *context.APIContext) {
// swagger:operation PATCH /user/settings user updateUserSettings
// ---
// summary: Update user settings
// parameters:
// - name: body
// in: body
// schema:
// "$ref": "#/definitions/UserSettingsOptions"
// produces:
// - application/json
// responses:
// "200":
// "$ref": "#/responses/UserSettings"
form := web.GetForm(ctx).(*api.UserSettingsOptions)
if form.FullName != nil {
ctx.User.FullName = *form.FullName
}
if form.Description != nil {
ctx.User.Description = *form.Description
}
if form.Website != nil {
ctx.User.Website = *form.Website
}
if form.Location != nil {
ctx.User.Location = *form.Location
}
if form.Language != nil {
ctx.User.Language = *form.Language
}
if form.Theme != nil {
ctx.User.Theme = *form.Theme
}
if form.DiffViewStyle != nil {
ctx.User.DiffViewStyle = *form.DiffViewStyle
}
if form.HideEmail != nil {
ctx.User.KeepEmailPrivate = *form.HideEmail
}
if form.HideActivity != nil {
ctx.User.KeepActivityPrivate = *form.HideActivity
}
if err := models.UpdateUser(ctx.User); err != nil {
ctx.InternalServerError(err)
return
}
ctx.JSON(http.StatusOK, convert.User2UserSettings(ctx.User))
}