mirror of
https://codeberg.org/forgejo/forgejo
synced 2025-09-17 05:43:00 +02:00
## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests - I added test coverage for Go changes... - [ ] in their respective `*_test.go` for unit tests. - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I added test coverage for JavaScript changes... - [ ] in `web_src/js/*.test.js` if it can be unit tested. - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [ ] I do not want this change to show in the release notes. - [x] I want the title to show in the release notes with a link to this pull request. - [ ] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title. ---- This is a fix for the Swagger annotations reported in #8918. Most of the changes are corrections to annotation comments, with some additions of wrapper struct definitions for Swagger auto‑generation. Co-authored-by: toras9000 <toras9000@example.com> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/9138 Reviewed-by: Lucas <sclu1034@noreply.codeberg.org> Co-authored-by: toras9000 <toras9000@noreply.codeberg.org> Co-committed-by: toras9000 <toras9000@noreply.codeberg.org>
120 lines
3 KiB
Go
120 lines
3 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package notify
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
|
|
activities_model "forgejo.org/models/activities"
|
|
"forgejo.org/models/db"
|
|
issues_model "forgejo.org/models/issues"
|
|
"forgejo.org/services/context"
|
|
"forgejo.org/services/convert"
|
|
)
|
|
|
|
// GetThread get notification by ID
|
|
func GetThread(ctx *context.APIContext) {
|
|
// swagger:operation GET /notifications/threads/{id} notification notifyGetThread
|
|
// ---
|
|
// summary: Get notification thread by ID
|
|
// consumes:
|
|
// - application/json
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: id
|
|
// in: path
|
|
// description: id of notification thread
|
|
// type: integer
|
|
// format: int64
|
|
// required: true
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/NotificationThread"
|
|
// "403":
|
|
// "$ref": "#/responses/forbidden"
|
|
// "404":
|
|
// "$ref": "#/responses/notFound"
|
|
|
|
n := getThread(ctx)
|
|
if n == nil {
|
|
return
|
|
}
|
|
if err := n.LoadAttributes(ctx); err != nil && !issues_model.IsErrCommentNotExist(err) {
|
|
ctx.InternalServerError(err)
|
|
return
|
|
}
|
|
|
|
ctx.JSON(http.StatusOK, convert.ToNotificationThread(ctx, n))
|
|
}
|
|
|
|
// ReadThread mark notification as read by ID
|
|
func ReadThread(ctx *context.APIContext) {
|
|
// swagger:operation PATCH /notifications/threads/{id} notification notifyReadThread
|
|
// ---
|
|
// summary: Mark notification thread as read by ID
|
|
// consumes:
|
|
// - application/json
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: id
|
|
// in: path
|
|
// description: id of notification thread
|
|
// type: integer
|
|
// format: int64
|
|
// required: true
|
|
// - name: to-status
|
|
// in: query
|
|
// description: Status to mark notifications as
|
|
// type: string
|
|
// default: read
|
|
// required: false
|
|
// responses:
|
|
// "205":
|
|
// "$ref": "#/responses/NotificationThread"
|
|
// "403":
|
|
// "$ref": "#/responses/forbidden"
|
|
// "404":
|
|
// "$ref": "#/responses/notFound"
|
|
|
|
n := getThread(ctx)
|
|
if n == nil {
|
|
return
|
|
}
|
|
|
|
targetStatus := statusStringToNotificationStatus(ctx.FormString("to-status"))
|
|
if targetStatus == 0 {
|
|
targetStatus = activities_model.NotificationStatusRead
|
|
}
|
|
|
|
notif, err := activities_model.SetNotificationStatus(ctx, n.ID, ctx.Doer, targetStatus)
|
|
if err != nil {
|
|
ctx.InternalServerError(err)
|
|
return
|
|
}
|
|
if err = notif.LoadAttributes(ctx); err != nil && !issues_model.IsErrCommentNotExist(err) {
|
|
ctx.InternalServerError(err)
|
|
return
|
|
}
|
|
ctx.JSON(http.StatusResetContent, convert.ToNotificationThread(ctx, notif))
|
|
}
|
|
|
|
func getThread(ctx *context.APIContext) *activities_model.Notification {
|
|
n, err := activities_model.GetNotificationByID(ctx, ctx.ParamsInt64(":id"))
|
|
if err != nil {
|
|
if db.IsErrNotExist(err) {
|
|
ctx.Error(http.StatusNotFound, "GetNotificationByID", err)
|
|
} else {
|
|
ctx.InternalServerError(err)
|
|
}
|
|
return nil
|
|
}
|
|
if n.UserID != ctx.Doer.ID && !ctx.Doer.IsAdmin {
|
|
ctx.Error(http.StatusForbidden, "GetNotificationByID", fmt.Errorf("only user itself and admin are allowed to read/change this thread %d", n.ID))
|
|
return nil
|
|
}
|
|
return n
|
|
}
|