diff options
author | 2023-02-25 13:16:30 +0100 | |
---|---|---|
committer | 2023-02-25 12:16:30 +0000 | |
commit | c27b4d7ed02cdabac00c3ddedb8201b74f745ec6 (patch) | |
tree | d80f621241fd67a4e5de2d21a8c24776552175f5 /internal/api/client/statuses/statuspin.go | |
parent | [chore] Update gin to v1.9.0 (#1553) (diff) | |
download | gotosocial-c27b4d7ed02cdabac00c3ddedb8201b74f745ec6.tar.xz |
[feature] Client API endpoints + v. basic web view for pinned posts (#1547)
* implement status pin client api + web handler
* make test names + comments more descriptive
* don't use separate table for status pins
* remove unused add + remove checking
* tidy up + add some more tests
Diffstat (limited to 'internal/api/client/statuses/statuspin.go')
-rw-r--r-- | internal/api/client/statuses/statuspin.go | 103 |
1 files changed, 103 insertions, 0 deletions
diff --git a/internal/api/client/statuses/statuspin.go b/internal/api/client/statuses/statuspin.go new file mode 100644 index 000000000..54508f51a --- /dev/null +++ b/internal/api/client/statuses/statuspin.go @@ -0,0 +1,103 @@ +/* + GoToSocial + Copyright (C) 2021-2023 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 statuses + +import ( + "errors" + "net/http" + + "github.com/gin-gonic/gin" + apiutil "github.com/superseriousbusiness/gotosocial/internal/api/util" + "github.com/superseriousbusiness/gotosocial/internal/gtserror" + "github.com/superseriousbusiness/gotosocial/internal/oauth" +) + +// StatusPinPOSTHandler swagger:operation POST /api/v1/statuses/{id}/pin statusPin +// +// Pin a status to the top of your profile, and add it to your Featured ActivityPub collection. +// +// You can only pin original posts (not reblogs) that you authored yourself. +// +// Supported privacy levels for pinned posts are public, unlisted, and private/followers-only, +// but only public posts will appear on the web version of your profile. +// +// --- +// tags: +// - statuses +// +// produces: +// - application/json +// +// parameters: +// - +// name: id +// type: string +// description: Target status ID. +// in: path +// required: true +// +// security: +// - OAuth2 Bearer: +// - write:accounts +// +// responses: +// '200': +// name: status +// description: The status. +// schema: +// "$ref": "#/definitions/status" +// '400': +// description: bad request +// '401': +// description: unauthorized +// '403': +// description: forbidden +// '404': +// description: not found +// '406': +// description: not acceptable +// '500': +// description: internal server error +func (m *Module) StatusPinPOSTHandler(c *gin.Context) { + authed, err := oauth.Authed(c, true, true, true, true) + if err != nil { + apiutil.ErrorHandler(c, gtserror.NewErrorUnauthorized(err, err.Error()), m.processor.InstanceGetV1) + return + } + + if _, err := apiutil.NegotiateAccept(c, apiutil.JSONAcceptHeaders...); err != nil { + apiutil.ErrorHandler(c, gtserror.NewErrorNotAcceptable(err, err.Error()), m.processor.InstanceGetV1) + return + } + + targetStatusID := c.Param(IDKey) + if targetStatusID == "" { + err := errors.New("no status id specified") + apiutil.ErrorHandler(c, gtserror.NewErrorBadRequest(err, err.Error()), m.processor.InstanceGetV1) + return + } + + apiStatus, errWithCode := m.processor.Status().PinCreate(c.Request.Context(), authed.Account, targetStatusID) + if errWithCode != nil { + apiutil.ErrorHandler(c, errWithCode, m.processor.InstanceGetV1) + return + } + + c.JSON(http.StatusOK, apiStatus) +} |