summaryrefslogtreecommitdiff
path: root/internal/api/client/admin/domainblockdelete.go
diff options
context:
space:
mode:
authorLibravatar Tobi Smethurst <31960611+tsmethurst@users.noreply.github.com>2021-07-31 23:17:39 +0200
committerLibravatar GitHub <noreply@github.com>2021-07-31 23:17:39 +0200
commit6bd26ff4c4d655e26adcf43d9331e9a3efe1329a (patch)
tree12785e672d8c4815ce54599c747fe2f3927a0c6a /internal/api/client/admin/domainblockdelete.go
parentrequirements.txt for RtD (diff)
downloadgotosocial-6bd26ff4c4d655e26adcf43d9331e9a3efe1329a.tar.xz
more swagger docs + other changes (#125)
* more swagger docs + other changes * go fmt
Diffstat (limited to 'internal/api/client/admin/domainblockdelete.go')
-rw-r--r--internal/api/client/admin/domainblockdelete.go34
1 files changed, 34 insertions, 0 deletions
diff --git a/internal/api/client/admin/domainblockdelete.go b/internal/api/client/admin/domainblockdelete.go
index d8f4586f9..8b773a5a9 100644
--- a/internal/api/client/admin/domainblockdelete.go
+++ b/internal/api/client/admin/domainblockdelete.go
@@ -9,6 +9,40 @@ import (
)
// DomainBlockDELETEHandler deals with the delete of an existing domain block.
+//
+// swagger:operation DELETE /api/v1/admin/domain_blocks/{id} domainBlockDelete
+//
+// Delete 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
+//
+// responses:
+// '200':
+// description: The domain block that was just deleted.
+// schema:
+// "$ref": "#/definitions/domainBlock"
+// '403':
+// description: forbidden
+// '400':
+// description: bad request
+// '404':
+// description: not found
func (m *Module) DomainBlockDELETEHandler(c *gin.Context) {
l := m.log.WithFields(logrus.Fields{
"func": "DomainBlockDELETEHandler",