mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-05-19 00:38:08 +00:00
183eaa5b29
* love like winter! wohoah, wohoah * domain allow side effects * tests! logging! unallow! * document federation modes * linty linterson * test * further adventures in documentation * finish up domain block documentation (i think) * change wording a wee little bit * docs, example * consolidate shared domainPermission code * call mode once * fetch federation mode within domain blocked func * read domain perm import in streaming manner * don't use pointer to slice for domain perms * don't bother copying blocks + allows before deleting * admonish! * change wording just a scooch * update docs
129 lines
4 KiB
Go
129 lines
4 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 (
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
|
)
|
|
|
|
// DomainAllowsPOSTHandler swagger:operation POST /api/v1/admin/domain_allows domainAllowCreate
|
|
//
|
|
// Create one or more domain allows, from a string or a file.
|
|
//
|
|
// You have two options when using this endpoint: either you can set `import` to `true` and
|
|
// upload a file containing multiple domain allows, JSON-formatted, or you can leave import as
|
|
// `false`, and just add one domain allow.
|
|
//
|
|
// The format of the json file should be something like: `[{"domain":"example.org"},{"domain":"whatever.com","public_comment":"they smell"}]`
|
|
//
|
|
// ---
|
|
// tags:
|
|
// - admin
|
|
//
|
|
// consumes:
|
|
// - multipart/form-data
|
|
//
|
|
// produces:
|
|
// - application/json
|
|
//
|
|
// parameters:
|
|
// -
|
|
// name: import
|
|
// in: query
|
|
// description: >-
|
|
// Signal that a list of domain allows is being imported as a file.
|
|
// If set to `true`, then 'domains' must be present as a JSON-formatted file.
|
|
// If set to `false`, then `domains` will be ignored, and `domain` must be present.
|
|
// type: boolean
|
|
// default: false
|
|
// -
|
|
// name: domains
|
|
// in: formData
|
|
// description: >-
|
|
// JSON-formatted list of domain allows to import.
|
|
// This is only used if `import` is set to `true`.
|
|
// type: file
|
|
// -
|
|
// name: domain
|
|
// in: formData
|
|
// description: >-
|
|
// Single domain to allow.
|
|
// Used only if `import` is not `true`.
|
|
// type: string
|
|
// -
|
|
// name: obfuscate
|
|
// in: formData
|
|
// description: >-
|
|
// Obfuscate the name of the domain when serving it publicly.
|
|
// Eg., `example.org` becomes something like `ex***e.org`.
|
|
// Used only if `import` is not `true`.
|
|
// type: boolean
|
|
// -
|
|
// name: public_comment
|
|
// in: formData
|
|
// description: >-
|
|
// Public comment about this domain allow.
|
|
// This will be displayed alongside the domain allow if you choose to share allows.
|
|
// Used only if `import` is not `true`.
|
|
// type: string
|
|
// -
|
|
// name: private_comment
|
|
// in: formData
|
|
// description: >-
|
|
// Private comment about this domain allow. Will only be shown to other admins, so this
|
|
// is a useful way of internally keeping track of why a certain domain ended up allowed.
|
|
// Used only if `import` is not `true`.
|
|
// type: string
|
|
//
|
|
// security:
|
|
// - OAuth2 Bearer:
|
|
// - admin
|
|
//
|
|
// responses:
|
|
// '200':
|
|
// description: >-
|
|
// The newly created domain allow, if `import` != `true`.
|
|
// If a list has been imported, then an `array` of newly created domain allows will be returned instead.
|
|
// schema:
|
|
// "$ref": "#/definitions/domainPermission"
|
|
// '400':
|
|
// description: bad request
|
|
// '401':
|
|
// description: unauthorized
|
|
// '403':
|
|
// description: forbidden
|
|
// '404':
|
|
// description: not found
|
|
// '406':
|
|
// description: not acceptable
|
|
// '409':
|
|
// description: >-
|
|
// Conflict: There is already an admin action running that conflicts with this action.
|
|
// Check the error message in the response body for more information. This is a temporary
|
|
// error; it should be possible to process this action if you try again in a bit.
|
|
// '500':
|
|
// description: internal server error
|
|
func (m *Module) DomainAllowsPOSTHandler(c *gin.Context) {
|
|
m.createDomainPermissions(c,
|
|
gtsmodel.DomainPermissionAllow,
|
|
m.processor.Admin().DomainPermissionCreate,
|
|
m.processor.Admin().DomainPermissionsImport,
|
|
)
|
|
}
|