fail early with hyphen in custom_id tag

bentsku · bentsku · commit 7dd432106449 · 2025-04-19T01:59:02.000+02:00
diff --git a/localstack-core/localstack/services/apigateway/next_gen/provider.py b/localstack-core/localstack/services/apigateway/next_gen/provider.py
@@ -1,6 +1,8 @@
 from localstack.aws.api import CommonServiceException, RequestContext, handler
 from localstack.aws.api.apigateway import (
+    BadRequestException,
     CacheClusterSize,
+    CreateRestApiRequest,
     CreateStageRequest,
     Deployment,
     DeploymentCanarySettings,
@@ -12,12 +14,14 @@
     NotFoundException,
     NullableBoolean,
     NullableInteger,
+    RestApi,
     Stage,
     StatusCode,
     String,
     TestInvokeMethodRequest,
     TestInvokeMethodResponse,
 )
+from localstack.constants import TAG_KEY_CUSTOM_ID
 from localstack.services.apigateway.helpers import (
     get_apigateway_store,
     get_moto_rest_api,
@@ -56,6 +60,16 @@ def on_after_init(self):
         apply_patches()
         self.router.register_routes()
 
+    @handler("CreateRestApi", expand=False)
+    def create_rest_api(self, context: RequestContext, request: CreateRestApiRequest) -> RestApi:
+        if "-" in request.get("tags", {}).get(TAG_KEY_CUSTOM_ID, ""):
+            raise BadRequestException(
+                f"The '{TAG_KEY_CUSTOM_ID}' tag cannot contain the '-' character."
+            )
+
+        response = super().create_rest_api(context, request)
+        return response
+
     @handler("DeleteRestApi")
     def delete_rest_api(self, context: RequestContext, rest_api_id: String, **kwargs) -> None:
         super().delete_rest_api(context, rest_api_id, **kwargs)
diff --git a/tests/aws/services/apigateway/test_apigateway_api.py b/tests/aws/services/apigateway/test_apigateway_api.py
@@ -201,14 +201,21 @@ def test_create_rest_api_with_tags(self, apigw_create_rest_api, snapshot, aws_cl
         snapshot.match("get-rest-apis-w-tags", response)
 
     @markers.aws.only_localstack
-    def test_create_rest_api_with_custom_id_tag(self, apigw_create_rest_api):
+    def test_create_rest_api_with_custom_id_tag(self, apigw_create_rest_api, aws_client):
         custom_id_tag = "testid123"
         response = apigw_create_rest_api(
             name="my_api", description="this is my api", tags={TAG_KEY_CUSTOM_ID: custom_id_tag}
         )
         api_id = response["id"]
         assert api_id == custom_id_tag
 
+        with pytest.raises(aws_client.apigateway.exceptions.BadRequestException):
+            apigw_create_rest_api(
+                name="my_api",
+                description="bad custom id",
+                tags={TAG_KEY_CUSTOM_ID: "bad-custom-id-hyphen"},
+            )
+
     @markers.aws.validated
     def test_update_rest_api_operation_add_remove(
         self, apigw_create_rest_api, snapshot, aws_client
