72b2711d50
Adds an error struct to Swagger covering normal and OAuth errors for client API endpoints. Now clients using Swagger codegen can handle errors. Specifically, if you _don't_ have typed errors in your Swagger IDL and you're using `go-swagger` to generate your API client, the error message is discarded and you are only told the status code. With this change in place, clients like `slurp` can tell the user that they tried to upload an emoji that was too big or whatever. Reviewed-on: https://codeberg.org/superseriousbusiness/gotosocial/pulls/4511 Reviewed-by: tobi <kipvandenbos@noreply.codeberg.org> Co-authored-by: Vyr Cossont <vyr@noreply.codeberg.org> Co-committed-by: Vyr Cossont <vyr@noreply.codeberg.org>
80 lines
2.1 KiB
Go
80 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 admin
|
|
|
|
import (
|
|
"code.superseriousbusiness.org/gotosocial/internal/gtsmodel"
|
|
"github.com/gin-gonic/gin"
|
|
)
|
|
|
|
// DomainBlockGETHandler swagger:operation GET /api/v1/admin/domain_blocks/{id} domainBlockGet
|
|
//
|
|
// View domain block with the given ID.
|
|
//
|
|
// ---
|
|
// tags:
|
|
// - admin
|
|
//
|
|
// produces:
|
|
// - application/json
|
|
//
|
|
// parameters:
|
|
// -
|
|
// name: id
|
|
// type: string
|
|
// description: The id of the domain block.
|
|
// in: path
|
|
// required: true
|
|
//
|
|
// security:
|
|
// - OAuth2 Bearer:
|
|
// - admin:read:domain_blocks
|
|
//
|
|
// responses:
|
|
// '200':
|
|
// description: The requested domain block.
|
|
// schema:
|
|
// "$ref": "#/definitions/domainPermission"
|
|
// '400':
|
|
// schema:
|
|
// "$ref": "#/definitions/error"
|
|
// description: bad request
|
|
// '401':
|
|
// schema:
|
|
// "$ref": "#/definitions/error"
|
|
// description: unauthorized
|
|
// '403':
|
|
// schema:
|
|
// "$ref": "#/definitions/error"
|
|
// description: forbidden
|
|
// '404':
|
|
// schema:
|
|
// "$ref": "#/definitions/error"
|
|
// description: not found
|
|
// '406':
|
|
// schema:
|
|
// "$ref": "#/definitions/error"
|
|
// description: not acceptable
|
|
// '500':
|
|
// schema:
|
|
// "$ref": "#/definitions/error"
|
|
// description: internal server error
|
|
func (m *Module) DomainBlockGETHandler(c *gin.Context) {
|
|
m.getDomainPermission(c, gtsmodel.DomainPermissionBlock)
|
|
}
|