DELETE Graffiti API

Author: courtneyeh

Diff for: validator/client/src/main/java/tech/pegasys/teku/validator/client/restapi/ValidatorRestApi.java

@@ -38,6 +38,7 @@
 import tech.pegasys.teku.validator.client.doppelganger.DoppelgangerDetector;
 import tech.pegasys.teku.validator.client.restapi.apis.DeleteFeeRecipient;
 import tech.pegasys.teku.validator.client.restapi.apis.DeleteGasLimit;
+import tech.pegasys.teku.validator.client.restapi.apis.DeleteGraffiti;
 import tech.pegasys.teku.validator.client.restapi.apis.DeleteKeys;
 import tech.pegasys.teku.validator.client.restapi.apis.DeleteRemoteKeys;
 import tech.pegasys.teku.validator.client.restapi.apis.GetFeeRecipient;
@@ -57,6 +58,7 @@ public class ValidatorRestApi {
   public static final String TAG_KEY_MANAGEMENT = "Key Management";
   public static final String TAG_FEE_RECIPIENT = "Fee Recipient";
   public static final String TAG_GAS_LIMIT = "Gas Limit";
+  public static final String TAG_GRAFFITI = "Graffiti";
 
   public static RestApi create(
       final Spec spec,
@@ -128,6 +130,7 @@ public static RestApi create(
         .endpoint(new DeleteFeeRecipient(proposerConfigManager))
         .endpoint(new DeleteGasLimit(proposerConfigManager))
         .endpoint(new PostVoluntaryExit(voluntaryExitDataProvider))
+        .endpoint(new DeleteGraffiti())
         .sslCertificate(config.getRestApiKeystoreFile(), config.getRestApiKeystorePasswordFile())
         .passwordFilePath(validatorApiBearerFile)
         .build();

Diff for: validator/client/src/main/java/tech/pegasys/teku/validator/client/restapi/apis/DeleteGraffiti.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright Consensys Software Inc., 2024
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+
+package tech.pegasys.teku.validator.client.restapi.apis;
+
+import static tech.pegasys.teku.infrastructure.http.HttpStatusCodes.SC_NO_CONTENT;
+import static tech.pegasys.teku.validator.client.restapi.ValidatorRestApi.TAG_GRAFFITI;
+import static tech.pegasys.teku.validator.client.restapi.ValidatorTypes.PARAM_PUBKEY_TYPE;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import org.apache.commons.lang3.NotImplementedException;
+import tech.pegasys.teku.infrastructure.restapi.endpoints.EndpointMetadata;
+import tech.pegasys.teku.infrastructure.restapi.endpoints.RestApiEndpoint;
+import tech.pegasys.teku.infrastructure.restapi.endpoints.RestApiRequest;
+
+public class DeleteGraffiti extends RestApiEndpoint {
+  public static final String ROUTE = "/eth/v1/validator/{pubkey}/graffiti";
+
+  public DeleteGraffiti() {
+    super(
+        EndpointMetadata.delete(ROUTE)
+            .operationId("deleteGraffiti")
+            .summary("Delete Configured Graffiti")
+            .description("Delete the configured graffiti for the specified public key.")
+            .tags(TAG_GRAFFITI)
+            .withBearerAuthSecurity()
+            .pathParam(PARAM_PUBKEY_TYPE)
+            .response(
+                SC_NO_CONTENT,
+                "Successfully removed the graffiti, or there was no graffiti set for the requested public key.")
+            .withAuthenticationResponses()
+            .withNotFoundResponse()
+            .build());
+  }
+
+  @Override
+  public void handleRequest(RestApiRequest request) throws JsonProcessingException {
+    throw new NotImplementedException("Not Implemented");
+  }
+}

Diff for: validator/client/src/test/resources/tech/pegasys/teku/validator/client/restapi/paths/_eth_v1_validator_{pubkey}_graffiti.json

@@ -0,0 +1,77 @@
+{
+  "delete" : {
+    "tags" : [ "Graffiti" ],
+    "operationId" : "deleteGraffiti",
+    "summary" : "Delete Configured Graffiti",
+    "description" : "Delete the configured graffiti for the specified public key.",
+    "parameters" : [ {
+      "name" : "pubkey",
+      "required" : true,
+      "in" : "path",
+      "schema" : {
+        "type" : "string",
+        "pattern" : "^0x[a-fA-F0-9]{96}$",
+        "example" : "0x93247f2209abcacf57b75a51dafae777f9dd38bc7053d1af526f220a7489a6d3a2753e5f3e8b1cfe39b56f43611df74a"
+      }
+    } ],
+    "security" : [ {
+      "bearerAuth" : [ ]
+    } ],
+    "responses" : {
+      "204" : {
+        "description" : "Successfully removed the graffiti, or there was no graffiti set for the requested public key.",
+        "content" : { }
+      },
+      "401" : {
+        "description" : "Unauthorized, no token is found",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "$ref" : "#/components/schemas/HttpErrorResponse"
+            }
+          }
+        }
+      },
+      "403" : {
+        "description" : "Forbidden, a token is found but is invalid",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "$ref" : "#/components/schemas/HttpErrorResponse"
+            }
+          }
+        }
+      },
+      "404" : {
+        "description" : "Not found",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "$ref" : "#/components/schemas/HttpErrorResponse"
+            }
+          }
+        }
+      },
+      "400" : {
+        "description" : "The request could not be processed, check the response for more information.",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "$ref" : "#/components/schemas/HttpErrorResponse"
+            }
+          }
+        }
+      },
+      "500" : {
+        "description" : "Internal server error",
+        "content" : {
+          "application/json" : {
+            "schema" : {
+              "$ref" : "#/components/schemas/HttpErrorResponse"
+            }
+          }
+        }
+      }
+    }
+  }
+}