feat: add endpoint to delete all validators from a dashboard

gobitfly · Jan 8, 2025 · a6b4236 · a6b4236
1 parent 3b2df71
commit a6b4236
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 16 deletions.
diff --git a/backend/pkg/api/data_access/vdb_management.go b/backend/pkg/api/data_access/vdb_management.go
@@ -1056,7 +1056,6 @@ func (d *DataAccessService) getAddValidatorsQuery(uniqueValidatorIndexesQuery st
 func (d *DataAccessService) RemoveValidatorDashboardValidators(ctx context.Context, dashboardId t.VDBIdPrimary, validators []t.VDBValidator) error {
 	if len(validators) == 0 {
 		// Remove all validators for the dashboard
-		// This is usually forbidden by API validation
 		_, err := d.alloyWriter.ExecContext(ctx, `
 			DELETE FROM users_val_dashboards_validators
 			WHERE dashboard_id = $1

diff --git a/backend/pkg/api/handlers/internal.go b/backend/pkg/api/handlers/internal.go
@@ -368,6 +368,10 @@ func (h *HandlerService) InternalPostValidatorDashboardValidators(w http.Respons
 	h.PublicPostValidatorDashboardValidators(w, r)
 }
 
+func (h *HandlerService) InternalDeleteValidatorDashboardValidators(w http.ResponseWriter, r *http.Request) {
+	h.PublicDeleteValidatorDashboardValidators(w, r)
+}
+
 func (h *HandlerService) InternalGetValidatorDashboardValidators(w http.ResponseWriter, r *http.Request) {
 	h.PublicGetValidatorDashboardValidators(w, r)
 }
@@ -400,8 +404,8 @@ func (h *HandlerService) InternalGetValidatorDashboardMobileValidators(w http.Re
 	returnOk(w, r, response)
 }
 
-func (h *HandlerService) InternalDeleteValidatorDashboardValidators(w http.ResponseWriter, r *http.Request) {
-	h.PublicDeleteValidatorDashboardValidators(w, r)
+func (h *HandlerService) InternalPostValidatorDashboardValidatorBulkDeletions(w http.ResponseWriter, r *http.Request) {
+	h.PublicPostValidatorDashboardValidatorBulkDeletions(w, r)
 }
 
 func (h *HandlerService) InternalPostValidatorDashboardPublicIds(w http.ResponseWriter, r *http.Request) {

diff --git a/backend/pkg/api/handlers/public.go b/backend/pkg/api/handlers/public.go
@@ -264,7 +264,7 @@ func (h *HandlerService) PublicGetValidatorDashboard(w http.ResponseWriter, r *h
 	returnOk(w, r, response)
 }
 
-// PublicPutValidatorDashboard godoc
+// PublicDeleteValidatorDashboard godoc
 //
 //	@Description	Delete a specified validator dashboard.
 //	@Security		ApiKeyInHeader || ApiKeyInQuery
@@ -450,7 +450,6 @@ func (h *HandlerService) PublicPutValidatorDashboardGroups(w http.ResponseWriter
 //	@Description	Delete a group in a specified validator dashboard.
 //	@Tags			Validator Dashboard Management
 //	@Security		ApiKeyInHeader || ApiKeyInQuery
-//	@Accept			json
 //	@Produce		json
 //	@Param			dashboard_id	path	integer	true	"The ID of the dashboard."
 //	@Param			group_id		path	integer	true	"The ID of the group."
@@ -714,17 +713,44 @@ func (h *HandlerService) PublicGetValidatorDashboardValidators(w http.ResponseWr
 
 // PublicDeleteValidatorDashboardValidators godoc
 //
-//	@Description	Remove validators from a specified dashboard.
-//	@Security		ApiKeyInHeader || ApiKeyInQuery
-//	@Tags			Validator Dashboard Management
-//	@Accept			json
-//	@Produce		json
-//	@Param			dashboard_id	path	integer														true	"The ID of the dashboard."
-//	@Param			request			body	handlers.PublicDeleteValidatorDashboardValidators.request	true	"`validators`: Provide an array of validator indices or public keys that should get removed from the dashboard."
-//	@Success		204				"Validators removed successfully."
-//	@Failure		400				{object}	types.ApiErrorResponse
-//	@Router			/validator-dashboards/{dashboard_id}/validators/bulk-deletions [post]
+// @Description	Remove all validators from a specified dashboard.
+// @Security		ApiKeyInHeader || ApiKeyInQuery
+// @Tags			Validator Dashboard Management
+// @Produce		json
+// @Param			dashboard_id	path	integer	true	"The ID of the dashboard."
+// @Success		204				"Validators removed successfully."
+// @Failure		400				{object}	types.ApiErrorResponse
+// @Router			/validator-dashboards/{dashboard_id}/validators [delete]
 func (h *HandlerService) PublicDeleteValidatorDashboardValidators(w http.ResponseWriter, r *http.Request) {
+	var v validationError
+	dashboardId := v.checkPrimaryDashboardId(mux.Vars(r)["dashboard_id"])
+	if v.hasErrors() {
+		handleErr(w, r, v)
+		return
+	}
+	ctx := r.Context()
+	err := h.getDataAccessor(r).RemoveValidatorDashboardValidators(ctx, dashboardId, []types.VDBValidator{}) // removes all validators
+	if err != nil {
+		handleErr(w, r, err)
+		return
+	}
+
+	returnNoContent(w, r)
+}
+
+// PublicPostValidatorDashboardValidatorBulkDeletions godoc
+//
+// @Description	Remove specific validators from a specified dashboard in bulk.
+// @Security		ApiKeyInHeader || ApiKeyInQuery
+// @Tags			Validator Dashboard Management
+// @Accept			json
+// @Produce		json
+// @Param			dashboard_id	path	integer														true	"The ID of the dashboard."
+// @Param			request			body	handlers.PublicPostValidatorDashboardValidatorBulkDeletions.request	true	"`validators`: Provide an array of validator indices or public keys that should get removed from the dashboard."
+// @Success		204				"Validators removed successfully."
+// @Failure		400				{object}	types.ApiErrorResponse
+// @Router			/validator-dashboards/{dashboard_id}/validators/bulk-deletions [post]
+func (h *HandlerService) PublicPostValidatorDashboardValidatorBulkDeletions(w http.ResponseWriter, r *http.Request) {
 	var v validationError
 	dashboardId := v.checkPrimaryDashboardId(mux.Vars(r)["dashboard_id"])
 	type request struct {

diff --git a/backend/pkg/api/router.go b/backend/pkg/api/router.go
@@ -293,7 +293,8 @@ func addValidatorDashboardRoutes(hs *handlers.HandlerService, publicRouter, inte
 		{http.MethodDelete, "/{dashboard_id}/groups/{group_id}/validators", hs.PublicDeleteValidatorDashboardGroupValidators, hs.InternalDeleteValidatorDashboardGroupValidators},
 		{http.MethodPost, "/{dashboard_id}/validators", hs.PublicPostValidatorDashboardValidators, hs.InternalPostValidatorDashboardValidators},
 		{http.MethodGet, "/{dashboard_id}/validators", hs.PublicGetValidatorDashboardValidators, hs.InternalGetValidatorDashboardValidators},
-		{http.MethodPost, "/{dashboard_id}/validators/bulk-deletions", hs.PublicDeleteValidatorDashboardValidators, hs.InternalDeleteValidatorDashboardValidators},
+		{http.MethodDelete, "/{dashboard_id}/validators", hs.PublicDeleteValidatorDashboardValidators, hs.InternalDeleteValidatorDashboardValidators},
+		{http.MethodPost, "/{dashboard_id}/validators/bulk-deletions", hs.PublicPostValidatorDashboardValidatorBulkDeletions, hs.InternalPostValidatorDashboardValidatorBulkDeletions},
 		{http.MethodPost, "/{dashboard_id}/public-ids", hs.PublicPostValidatorDashboardPublicIds, hs.InternalPostValidatorDashboardPublicIds},
 		{http.MethodPut, "/{dashboard_id}/public-ids/{public_id}", hs.PublicPutValidatorDashboardPublicId, hs.InternalPutValidatorDashboardPublicId},
 		{http.MethodDelete, "/{dashboard_id}/public-ids/{public_id}", hs.PublicDeleteValidatorDashboardPublicId, hs.InternalDeleteValidatorDashboardPublicId},