Map also description to model (#88)

Author: msimperi

src/index.spec.js

@@ -141,6 +141,7 @@ describe('ServerlessAWSDocumentation', function () {
               ContentType: 'application/json',
               Name: 'TestModel',
               Schema: 'some complex schema',
+              Description: 'the test model schema',
             },
           },
           OtherModelModel: {
@@ -152,6 +153,7 @@ describe('ServerlessAWSDocumentation', function () {
               ContentType: 'application/json',
               Name: 'OtherModel',
               Schema: 'some even more complex schema',
+              Description: 'the other test model schema',
             },
           },
           NoSchemaModelModel: {
@@ -163,6 +165,7 @@ describe('ServerlessAWSDocumentation', function () {
               ContentType: 'application/json',
               Name: 'NoSchemaModel',
               Schema: {},
+              Description: 'the other test model schema',
             },
           },
           ExistingResource: {

src/models.js

@@ -42,17 +42,22 @@ function replaceModelRefs(restApiId, cfModel) {
 module.exports = {
   createCfModel: function createCfModel(restApiId) {
     return function(model) {
-      return replaceModelRefs(restApiId,
-        {
-          Type: 'AWS::ApiGateway::Model',
-          Properties: {
-            RestApiId: restApiId,
-            ContentType: model.contentType,
-            Name: model.name,
-            Schema: model.schema || {},
-          },
-        }
-      );
+
+      let cfModel = {
+        Type: 'AWS::ApiGateway::Model',
+        Properties: {
+          RestApiId: restApiId,
+          ContentType: model.contentType,
+          Name: model.name,
+          Schema: model.schema || {},
+        },
+      }
+
+      if (model.description) {
+        cfModel.Properties.Description = model.description
+      }
+
+      return replaceModelRefs(restApiId, cfModel)
     }
   },
 

src/models.spec.js

@@ -58,6 +58,7 @@ describe('ServerlessAWSDocumentation', function() {
             let modelInput = {
                 contentType: 'application/json',
                 name: 'TestModel',
+                description: 'Test description',
                 schema: {
                     type: 'object',
                     properties: {
@@ -98,7 +99,8 @@ describe('ServerlessAWSDocumentation', function() {
                                 }
                             }
                         }
-                    }
+                    },
+                    Description: 'Test description',
                 },
                 DependsOn: [
                     'OtherModelNameModel'