mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-05-16 03:22:41 +00:00
fc3741365c
* Add Swagger spec test script * Fix Swagger spec errors not related to statuses with polls * Add API tests that post a status with a poll * Fix creating a status with a poll from form params * Fix Swagger spec errors related to statuses with polls (this is the last error) * Fix Swagger spec warnings not related to unused definitions * Suppress a duplicate list update params definition that was somehow causing wrong param names * Add Swagger test to CI - updates Drone config - vendorizes go-swagger - fixes a file extension issue that caused the test script to generate JSON instead of YAML with the vendorized version * Put `Sample: ` on its own line everywhere * Remove unused id param from emojiCategoriesGet * Add 5 more pairs of profile fields to account update API Swagger * Remove Swagger prefix from dummy fields It makes the generated code look weird * Manually annotate params for statusCreate operation * Fix all remaining Swagger spec warnings - Change some models into operation parameters - Ignore models that already correspond to manually documented operation parameters but can't be trivially changed (those with file fields) * Documented that creating a status with scheduled_at isn't implemented yet * sign drone.yml * Fix filter API Swagger errors * fixup! Fix filter API Swagger errors --------- Co-authored-by: tobi <tobi.smethurst@protonmail.com>
98 lines
2.9 KiB
Go
98 lines
2.9 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 users
|
|
|
|
import (
|
|
"errors"
|
|
"net/http"
|
|
"strings"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
apiutil "github.com/superseriousbusiness/gotosocial/internal/api/util"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtserror"
|
|
)
|
|
|
|
// FeaturedCollectionGETHandler swagger:operation GET /users/{username}/collections/featured s2sFeaturedCollectionGet
|
|
//
|
|
// Get the featured collection (pinned posts) for a user.
|
|
//
|
|
// The response will contain an ordered collection of Note URIs in the `items` property.
|
|
//
|
|
// It is up to the caller to dereference the provided Note URIs (or not, if they already have them cached).
|
|
//
|
|
// HTTP signature is required on the request.
|
|
//
|
|
// ---
|
|
// tags:
|
|
// - s2s/federation
|
|
//
|
|
// produces:
|
|
// - application/activity+json
|
|
//
|
|
// parameters:
|
|
// -
|
|
// name: username
|
|
// type: string
|
|
// description: Account name of the user
|
|
// in: path
|
|
// required: true
|
|
//
|
|
// responses:
|
|
// '200':
|
|
// in: body
|
|
// schema:
|
|
// "$ref": "#/definitions/swaggerFeaturedCollection"
|
|
// '400':
|
|
// description: bad request
|
|
// '401':
|
|
// description: unauthorized
|
|
// '403':
|
|
// description: forbidden
|
|
// '404':
|
|
// description: not found
|
|
func (m *Module) FeaturedCollectionGETHandler(c *gin.Context) {
|
|
// usernames on our instance are always lowercase
|
|
requestedUsername := strings.ToLower(c.Param(UsernameKey))
|
|
if requestedUsername == "" {
|
|
err := errors.New("no username specified in request")
|
|
apiutil.ErrorHandler(c, gtserror.NewErrorBadRequest(err, err.Error()), m.processor.InstanceGetV1)
|
|
return
|
|
}
|
|
|
|
contentType, err := apiutil.NegotiateAccept(c, apiutil.ActivityPubOrHTMLHeaders...)
|
|
if err != nil {
|
|
apiutil.ErrorHandler(c, gtserror.NewErrorNotAcceptable(err, err.Error()), m.processor.InstanceGetV1)
|
|
return
|
|
}
|
|
|
|
if contentType == string(apiutil.TextHTML) {
|
|
// This isn't an ActivityPub request;
|
|
// redirect to the user's profile.
|
|
c.Redirect(http.StatusSeeOther, "/@"+requestedUsername)
|
|
return
|
|
}
|
|
|
|
resp, errWithCode := m.processor.Fedi().FeaturedCollectionGet(c.Request.Context(), requestedUsername)
|
|
if errWithCode != nil {
|
|
apiutil.ErrorHandler(c, errWithCode, m.processor.InstanceGetV1)
|
|
return
|
|
}
|
|
|
|
apiutil.JSONType(c, http.StatusOK, contentType, resp)
|
|
}
|