mirror of
https://github.com/superseriousbusiness/gotosocial
synced 2024-12-16 02:33:06 +01:00
b08c1bd0cb
Counterpart of exclude_types[]. Also updates Swagger spec for types[] to use the correct param name and enumerate possible values. Fixes #3003
62 lines
2.1 KiB
Go
62 lines
2.1 KiB
Go
// GoToSocial
|
|
// Copyright (C) GoToSocial Authors admin@gotosocial.org
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
//
|
|
// 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 notifications
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/superseriousbusiness/gotosocial/internal/processing"
|
|
)
|
|
|
|
const (
|
|
// IDKey is for notification UUIDs
|
|
IDKey = "id"
|
|
// BasePath is the base path for serving the notification API, minus the 'api' prefix.
|
|
BasePath = "/v1/notifications"
|
|
// BasePathWithID is just the base path with the ID key in it.
|
|
// Use this anywhere you need to know the ID of the notification being queried.
|
|
BasePathWithID = BasePath + "/:" + IDKey
|
|
BasePathWithClear = BasePath + "/clear"
|
|
|
|
// IncludeTypesKey names an array param specifying notification types to include.
|
|
IncludeTypesKey = "include_types[]"
|
|
// ExcludeTypesKey names an array param specifying notification types to exclude.
|
|
ExcludeTypesKey = "exclude_types[]"
|
|
MaxIDKey = "max_id"
|
|
LimitKey = "limit"
|
|
SinceIDKey = "since_id"
|
|
MinIDKey = "min_id"
|
|
)
|
|
|
|
type Module struct {
|
|
processor *processing.Processor
|
|
}
|
|
|
|
func New(processor *processing.Processor) *Module {
|
|
return &Module{
|
|
processor: processor,
|
|
}
|
|
}
|
|
|
|
func (m *Module) Route(attachHandler func(method string, path string, f ...gin.HandlerFunc) gin.IRoutes) {
|
|
attachHandler(http.MethodGet, BasePath, m.NotificationsGETHandler)
|
|
attachHandler(http.MethodGet, BasePathWithID, m.NotificationGETHandler)
|
|
attachHandler(http.MethodPost, BasePathWithClear, m.NotificationsClearPOSTHandler)
|
|
}
|