fix: Exclude Non-Method Path Sections (#2171)

* Added Exclusion for Non-Method Path Sections

* Added Unit Tests

Author: CoshUS

samtranslator/swagger/swagger.py

@@ -28,6 +28,7 @@ class SwaggerEditor(object):
     _CACHE_KEY_PARAMETERS = "cacheKeyParameters"
     # https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
     _ALL_HTTP_METHODS = ["OPTIONS", "GET", "HEAD", "POST", "PUT", "DELETE", "PATCH"]
+    _EXCLUDED_PATHS_FIELDS = ["summary", "description", "parameters"]
     _POLICY_TYPE_IAM = "Iam"
     _POLICY_TYPE_IP = "Ip"
     _POLICY_TYPE_VPC = "Vpc"
@@ -527,8 +528,8 @@ def set_path_default_authorizer(
         for method_name, method in self.get_path(path).items():
             normalized_method_name = self._normalize_method_name(method_name)
 
-            # Excluding parameters section
-            if normalized_method_name == "parameters":
+            # Excluding non-method sections
+            if normalized_method_name in SwaggerEditor._EXCLUDED_PATHS_FIELDS:
                 continue
             if add_default_auth_to_preflight or normalized_method_name != "options":
                 normalized_method_name = self._normalize_method_name(method_name)
@@ -623,8 +624,8 @@ def set_path_default_apikey_required(self, path):
         """
 
         for method_name, method in self.get_path(path).items():
-            # Excluding parameters section
-            if method_name == "parameters":
+            # Excluding non-method sections
+            if method_name in SwaggerEditor._EXCLUDED_PATHS_FIELDS:
                 continue
 
             # It is possible that the method could have two definitions in a Fn::If block.

tests/swagger/test_swagger.py

@@ -949,8 +949,14 @@ def setUp(self):
         self.original_swagger = {
             "swagger": "2.0",
             "paths": {
-                "/foo": {"get": {_X_INTEGRATION: {"a": "b"}}, "post": {_X_INTEGRATION: {"a": "b"}}},
-                "/bar": {"get": {_X_INTEGRATION: {"a": "b"}}},
+                "/foo": {
+                    "summary": "a",
+                    "description": "b",
+                    "parameters": {"a": "b"},
+                    "get": {_X_INTEGRATION: {"a": "b"}},
+                    "post": {_X_INTEGRATION: {"a": "b"}},
+                },
+                "/bar": {"summary": "a", "description": "b", "get": {_X_INTEGRATION: {"a": "b"}}},
             },
         }
 
@@ -971,6 +977,8 @@ def test_must_add_default_apikey_to_all_paths(self):
         self.editor.set_path_default_apikey_required(path)
         methods = self.editor.swagger["paths"][path]
         for method in methods:
+            if method in ["summary", "parameters", "description"]:
+                continue
             self.assertEqual(expected, methods[method]["security"])
 
     def test_add_default_apikey_to_all_paths_correctly_handles_method_level_settings(self):