mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-10-31 02:22:26 -05:00
ecb97f4e0b* Add support for the exclude_types[] parameter on the notifications endpoint * Add swagger docs to notifications
144 lines
4 KiB
Go
144 lines
4 KiB
Go
/*
|
|
GoToSocial
|
|
Copyright (C) 2021-2022 GoToSocial Authors admin@gotosocial.org
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU Affero General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Affero General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Affero General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
package notification
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"strconv"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/superseriousbusiness/gotosocial/internal/api"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtserror"
|
|
"github.com/superseriousbusiness/gotosocial/internal/oauth"
|
|
)
|
|
|
|
// NotificationsGETHandler swagger:operation GET /api/v1/notifications notifications
|
|
//
|
|
// Get notifications for currently authorized user.
|
|
//
|
|
// The notifications will be returned in descending chronological order (newest first), with sequential IDs (bigger = newer).
|
|
//
|
|
// ---
|
|
// tags:
|
|
// - notifications
|
|
//
|
|
// produces:
|
|
// - application/json
|
|
//
|
|
// parameters:
|
|
// - name: limit
|
|
// type: integer
|
|
// description: Number of notifications to return.
|
|
// default: 20
|
|
// in: query
|
|
// required: false
|
|
// - name: exclude_types
|
|
// type: array
|
|
// items:
|
|
// type: string
|
|
// description: Array of types of notifications to exclude (follow, favourite, reblog, mention, poll, follow_request)
|
|
// in: query
|
|
// required: false
|
|
// - name: max_id
|
|
// type: string
|
|
// description: |-
|
|
// Return only notifications *OLDER* than the given max status ID.
|
|
// The status with the specified ID will not be included in the response.
|
|
// in: query
|
|
// required: false
|
|
// - name: since_id
|
|
// type: string
|
|
// description: |-
|
|
// Return only notifications *NEWER* than the given since status ID.
|
|
// The status with the specified ID will not be included in the response.
|
|
// in: query
|
|
// required: false
|
|
//
|
|
// security:
|
|
// - OAuth2 Bearer:
|
|
// - read:notifications
|
|
//
|
|
// responses:
|
|
// '200':
|
|
// name: notifications
|
|
// description: Array of notifications.
|
|
// schema:
|
|
// type: array
|
|
// items:
|
|
// "$ref": "#/definitions/notification"
|
|
// '400':
|
|
// description: bad request
|
|
// '401':
|
|
// description: unauthorized
|
|
// '404':
|
|
// description: not found
|
|
// '406':
|
|
// description: not acceptable
|
|
// '500':
|
|
// description: internal server error
|
|
func (m *Module) NotificationsGETHandler(c *gin.Context) {
|
|
authed, err := oauth.Authed(c, true, true, true, true)
|
|
if err != nil {
|
|
api.ErrorHandler(c, gtserror.NewErrorUnauthorized(err, err.Error()), m.processor.InstanceGet)
|
|
return
|
|
}
|
|
|
|
if _, err := api.NegotiateAccept(c, api.JSONAcceptHeaders...); err != nil {
|
|
api.ErrorHandler(c, gtserror.NewErrorNotAcceptable(err, err.Error()), m.processor.InstanceGet)
|
|
return
|
|
}
|
|
|
|
limit := 20
|
|
limitString := c.Query(LimitKey)
|
|
if limitString != "" {
|
|
i, err := strconv.ParseInt(limitString, 10, 64)
|
|
if err != nil {
|
|
err := fmt.Errorf("error parsing %s: %s", LimitKey, err)
|
|
api.ErrorHandler(c, gtserror.NewErrorBadRequest(err, err.Error()), m.processor.InstanceGet)
|
|
return
|
|
}
|
|
limit = int(i)
|
|
}
|
|
|
|
maxID := ""
|
|
maxIDString := c.Query(MaxIDKey)
|
|
if maxIDString != "" {
|
|
maxID = maxIDString
|
|
}
|
|
|
|
sinceID := ""
|
|
sinceIDString := c.Query(SinceIDKey)
|
|
if sinceIDString != "" {
|
|
sinceID = sinceIDString
|
|
}
|
|
|
|
excludeTypes := c.QueryArray(ExcludeTypesKey)
|
|
|
|
resp, errWithCode := m.processor.NotificationsGet(c.Request.Context(), authed, excludeTypes, limit, maxID, sinceID)
|
|
if errWithCode != nil {
|
|
api.ErrorHandler(c, errWithCode, m.processor.InstanceGet)
|
|
return
|
|
}
|
|
|
|
if resp.LinkHeader != "" {
|
|
c.Header("Link", resp.LinkHeader)
|
|
}
|
|
c.JSON(http.StatusOK, resp.Items)
|
|
}
|