fix: allow Api model without properties (#2709)

Author: hoffa

samtranslator/swagger/swagger.py

@@ -855,14 +855,10 @@ def add_models(self, models):  # type: ignore[no-untyped-def]
         for model_name, schema in models.items():
 
             model_type = schema.get("type")
-            model_properties = schema.get("properties")
 
             if not model_type:
                 raise InvalidDocumentException([InvalidTemplateException("'Models' schema is missing 'type'.")])
 
-            if not model_properties:
-                raise InvalidDocumentException([InvalidTemplateException("'Models' schema is missing 'properties'.")])
-
             self.definitions[model_name.lower()] = schema
 
     def add_resource_policy(self, resource_policy, path, stage):  # type: ignore[no-untyped-def]

tests/swagger/test_swagger.py

@@ -692,12 +692,6 @@ def test_must_fail_without_type_in_model(self):
         with self.assertRaises(InvalidDocumentException):
             self.editor.add_models(models)
 
-    def test_must_fail_without_properties_in_model(self):
-        models = {"User": {"type": "object"}}
-
-        with self.assertRaises(InvalidDocumentException):
-            self.editor.add_models(models)
-
 
 class TestSwaggerEditor_add_request_model_to_method(TestCase):
     def setUp(self):

tests/translator/input/api_model_without_properties.yaml

@@ -0,0 +1,11 @@
+Resources:
+  MyApi:
+    Type: AWS::Serverless::Api
+    Properties:
+      StageName: Prod
+      Models:
+        MyModel:
+          items:
+            type: integer
+          type: array
+          title: MyModel

tests/translator/output/api_model_without_properties.json

@@ -0,0 +1,50 @@
+{
+  "Resources": {
+    "MyApi": {
+      "Properties": {
+        "Body": {
+          "definitions": {
+            "mymodel": {
+              "items": {
+                "type": "integer"
+              },
+              "title": "MyModel",
+              "type": "array"
+            }
+          },
+          "info": {
+            "title": {
+              "Ref": "AWS::StackName"
+            },
+            "version": "1.0"
+          },
+          "paths": {},
+          "swagger": "2.0"
+        }
+      },
+      "Type": "AWS::ApiGateway::RestApi"
+    },
+    "MyApiDeployment49616beda5": {
+      "Properties": {
+        "Description": "RestApi deployment id: 49616beda518d56ac1dbce9c34f09ccca4862616",
+        "RestApiId": {
+          "Ref": "MyApi"
+        },
+        "StageName": "Stage"
+      },
+      "Type": "AWS::ApiGateway::Deployment"
+    },
+    "MyApiProdStage": {
+      "Properties": {
+        "DeploymentId": {
+          "Ref": "MyApiDeployment49616beda5"
+        },
+        "RestApiId": {
+          "Ref": "MyApi"
+        },
+        "StageName": "Prod"
+      },
+      "Type": "AWS::ApiGateway::Stage"
+    }
+  }
+}

tests/translator/output/aws-cn/api_model_without_properties.json

@@ -0,0 +1,58 @@
+{
+  "Resources": {
+    "MyApi": {
+      "Properties": {
+        "Body": {
+          "definitions": {
+            "mymodel": {
+              "items": {
+                "type": "integer"
+              },
+              "title": "MyModel",
+              "type": "array"
+            }
+          },
+          "info": {
+            "title": {
+              "Ref": "AWS::StackName"
+            },
+            "version": "1.0"
+          },
+          "paths": {},
+          "swagger": "2.0"
+        },
+        "EndpointConfiguration": {
+          "Types": [
+            "REGIONAL"
+          ]
+        },
+        "Parameters": {
+          "endpointConfigurationTypes": "REGIONAL"
+        }
+      },
+      "Type": "AWS::ApiGateway::RestApi"
+    },
+    "MyApiDeployment49616beda5": {
+      "Properties": {
+        "Description": "RestApi deployment id: 49616beda518d56ac1dbce9c34f09ccca4862616",
+        "RestApiId": {
+          "Ref": "MyApi"
+        },
+        "StageName": "Stage"
+      },
+      "Type": "AWS::ApiGateway::Deployment"
+    },
+    "MyApiProdStage": {
+      "Properties": {
+        "DeploymentId": {
+          "Ref": "MyApiDeployment49616beda5"
+        },
+        "RestApiId": {
+          "Ref": "MyApi"
+        },
+        "StageName": "Prod"
+      },
+      "Type": "AWS::ApiGateway::Stage"
+    }
+  }
+}

tests/translator/output/aws-us-gov/api_model_without_properties.json

@@ -0,0 +1,58 @@
+{
+  "Resources": {
+    "MyApi": {
+      "Properties": {
+        "Body": {
+          "definitions": {
+            "mymodel": {
+              "items": {
+                "type": "integer"
+              },
+              "title": "MyModel",
+              "type": "array"
+            }
+          },
+          "info": {
+            "title": {
+              "Ref": "AWS::StackName"
+            },
+            "version": "1.0"
+          },
+          "paths": {},
+          "swagger": "2.0"
+        },
+        "EndpointConfiguration": {
+          "Types": [
+            "REGIONAL"
+          ]
+        },
+        "Parameters": {
+          "endpointConfigurationTypes": "REGIONAL"
+        }
+      },
+      "Type": "AWS::ApiGateway::RestApi"
+    },
+    "MyApiDeployment49616beda5": {
+      "Properties": {
+        "Description": "RestApi deployment id: 49616beda518d56ac1dbce9c34f09ccca4862616",
+        "RestApiId": {
+          "Ref": "MyApi"
+        },
+        "StageName": "Stage"
+      },
+      "Type": "AWS::ApiGateway::Deployment"
+    },
+    "MyApiProdStage": {
+      "Properties": {
+        "DeploymentId": {
+          "Ref": "MyApiDeployment49616beda5"
+        },
+        "RestApiId": {
+          "Ref": "MyApi"
+        },
+        "StageName": "Prod"
+      },
+      "Type": "AWS::ApiGateway::Stage"
+    }
+  }
+}