mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-10-31 10:02:26 -05:00
146 lines
3.8 KiB
Go
146 lines
3.8 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 apps
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
apiutil "code.superseriousbusiness.org/gotosocial/internal/api/util"
|
|
"code.superseriousbusiness.org/gotosocial/internal/gtserror"
|
|
"code.superseriousbusiness.org/gotosocial/internal/paging"
|
|
"github.com/gin-gonic/gin"
|
|
)
|
|
|
|
// AppsGETHandler swagger:operation GET /api/v1/apps appsGet
|
|
//
|
|
// Get an array of applications that are managed by the requester.
|
|
//
|
|
// The next and previous queries can be parsed from the returned Link header.
|
|
//
|
|
// Example:
|
|
//
|
|
// ```
|
|
// <https://example.org/api/v1/apps?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/apps?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev"
|
|
// ````
|
|
//
|
|
// ---
|
|
// tags:
|
|
// - apps
|
|
//
|
|
// produces:
|
|
// - application/json
|
|
//
|
|
// parameters:
|
|
// -
|
|
// name: max_id
|
|
// type: string
|
|
// description: >-
|
|
// Return only items *OLDER* than the given max item ID.
|
|
// The item with the specified ID will not be included in the response.
|
|
// in: query
|
|
// required: false
|
|
// -
|
|
// name: since_id
|
|
// type: string
|
|
// description: >-
|
|
// Return only items *newer* than the given since item ID.
|
|
// The item with the specified ID will not be included in the response.
|
|
// in: query
|
|
// -
|
|
// name: min_id
|
|
// type: string
|
|
// description: >-
|
|
// Return only items *immediately newer* than the given since item ID.
|
|
// The item with the specified ID will not be included in the response.
|
|
// in: query
|
|
// required: false
|
|
// -
|
|
// name: limit
|
|
// type: integer
|
|
// description: Number of items to return.
|
|
// default: 20
|
|
// in: query
|
|
// required: false
|
|
// max: 80
|
|
// min: 0
|
|
//
|
|
// security:
|
|
// - OAuth2 Bearer:
|
|
// - read:applications
|
|
//
|
|
// responses:
|
|
// '200':
|
|
// headers:
|
|
// Link:
|
|
// type: string
|
|
// description: Links to the next and previous queries.
|
|
// schema:
|
|
// type: array
|
|
// items:
|
|
// "$ref": "#/definitions/application"
|
|
// '400':
|
|
// description: bad request
|
|
// '401':
|
|
// description: unauthorized
|
|
// '404':
|
|
// description: not found
|
|
// '406':
|
|
// description: not acceptable
|
|
// '500':
|
|
// description: internal server error
|
|
func (m *Module) AppsGETHandler(c *gin.Context) {
|
|
authed, errWithCode := apiutil.TokenAuth(c,
|
|
true, true, true, true,
|
|
apiutil.ScopeReadApplications,
|
|
)
|
|
if errWithCode != nil {
|
|
apiutil.ErrorHandler(c, errWithCode, 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
|
|
}
|
|
|
|
page, errWithCode := paging.ParseIDPage(c,
|
|
0, // min limit
|
|
80, // max limit
|
|
20, // default limit
|
|
)
|
|
if errWithCode != nil {
|
|
apiutil.ErrorHandler(c, errWithCode, m.processor.InstanceGetV1)
|
|
return
|
|
}
|
|
|
|
resp, errWithCode := m.processor.Application().GetPage(
|
|
c.Request.Context(),
|
|
authed.User.ID,
|
|
page,
|
|
)
|
|
if errWithCode != nil {
|
|
apiutil.ErrorHandler(c, errWithCode, m.processor.InstanceGetV1)
|
|
return
|
|
}
|
|
|
|
if resp.LinkHeader != "" {
|
|
c.Header("Link", resp.LinkHeader)
|
|
}
|
|
|
|
apiutil.JSON(c, http.StatusOK, resp.Items)
|
|
}
|