mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-06-08 08:19:23 +00:00
6d138588d8
This adds the preferences endpoint to our Mastodon Client API implementation. It's a read-only endpoint that returns a number of user preferences. Applications can query these settings when logging in a user (for the first time) to configure themselves.
92 lines
2.5 KiB
Go
92 lines
2.5 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 preferences
|
|
|
|
import (
|
|
"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"
|
|
)
|
|
|
|
// PreferencesGETHandler swagger:operation GET /api/v1/preferences preferencesGet
|
|
//
|
|
// Return an object of user preferences.
|
|
//
|
|
// Example:
|
|
//
|
|
// ```
|
|
//
|
|
// {
|
|
// "posting:default:visibility": "public",
|
|
// "posting:default:sensitive": false,
|
|
// "posting:default:language": "en",
|
|
// "reading:expand:media": "default",
|
|
// "reading:expand:spoilers": false,
|
|
// "reading:autoplay:gifs": false
|
|
// }
|
|
//
|
|
// ````
|
|
//
|
|
// ---
|
|
// tags:
|
|
// - preferences
|
|
//
|
|
// produces:
|
|
// - application/json
|
|
//
|
|
// security:
|
|
// - OAuth2 Bearer:
|
|
// - read:accounts
|
|
//
|
|
// responses:
|
|
// '200':
|
|
// schema:
|
|
// type: object
|
|
// '400':
|
|
// description: bad request
|
|
// '401':
|
|
// description: unauthorized
|
|
// '404':
|
|
// description: not found
|
|
// '406':
|
|
// description: not acceptable
|
|
// '500':
|
|
// description: internal server error
|
|
func (m *Module) PreferencesGETHandler(c *gin.Context) {
|
|
authed, err := oauth.Authed(c, false, false, false, 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
|
|
}
|
|
|
|
resp, errWithCode := m.processor.PreferencesGet(c.Request.Context(), authed.Account.ID)
|
|
if errWithCode != nil {
|
|
apiutil.ErrorHandler(c, errWithCode, m.processor.InstanceGetV1)
|
|
return
|
|
}
|
|
c.JSON(http.StatusOK, resp)
|
|
}
|