From 6bd26ff4c4d655e26adcf43d9331e9a3efe1329a Mon Sep 17 00:00:00 2001
From: Tobi Smethurst <31960611+tsmethurst@users.noreply.github.com>
Date: Sat, 31 Jul 2021 23:17:39 +0200
Subject: more swagger docs + other changes (#125)

* more swagger docs + other changes

* go fmt
---
 internal/api/client/admin/domainblockdelete.go | 34 ++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

(limited to 'internal/api/client/admin/domainblockdelete.go')

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",
-- 
cgit v1.2.3