fix(schema): AWS::Serverless::Api.MethodSettings should be a list

Fixes a mistake in the SAM schema. AWS::Serverless::Api.MethodSettings should be a list of MethodSetting objects, not a single object. fixes awslabs#242
mcblair · Nov 30, 2019 · a1f340a · a1f340a
1 parent e8ebc42
commit a1f340a
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 11 deletions.
diff --git a/cloudformation/serverless/aws-serverless-api.go b/cloudformation/serverless/aws-serverless-api.go
@@ -60,7 +60,7 @@ type Api struct {
 	// MethodSettings AWS CloudFormation Property
 	// Required: false
 	// See: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi
-	MethodSettings interface{} `json:"MethodSettings,omitempty"`
+	MethodSettings []interface{} `json:"MethodSettings,omitempty"`
 
 	// Name AWS CloudFormation Property
 	// Required: false

diff --git a/generate/sam-2016-10-31.json b/generate/sam-2016-10-31.json
@@ -207,7 +207,8 @@
                 "MethodSettings": {
                     "Documentation": "https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi",
                     "Required": false,
-                    "PrimitiveType": "Json",
+                    "PrimitiveItemType": "Json",
+                    "Type": "List",
                     "UpdateType": "Immutable"
                 },
                 "EndpointConfiguration": {

diff --git a/schema/sam.go b/schema/sam.go
@@ -52120,7 +52120,10 @@ var SamSchema = `{
                             "type": "string"
                         },
                         "MethodSettings": {
-                            "type": "object"
+                            "items": {
+                                "type": "object"
+                            },
+                            "type": "array"
                         },
                         "Name": {
                             "type": "string"

diff --git a/schema/sam.schema.json b/schema/sam.schema.json
@@ -52117,7 +52117,10 @@
                             "type": "string"
                         },
                         "MethodSettings": {
-                            "type": "object"
+                            "items": {
+                                "type": "object"
+                            },
+                            "type": "array"
                         },
                         "Name": {
                             "type": "string"

diff --git a/test/yaml/aws-serverless-api.yaml b/test/yaml/aws-serverless-api.yaml
@@ -12,21 +12,21 @@ Resources:
       CacheClusterEnabled: true
       CacheClusterSize: test-cache-cluster-size
       Variables:
-        NAME: VALUE 
+        NAME: VALUE
 
   ServerlessApiWithDefinitionUriAsS3Location:
     Type: AWS::Serverless::Api
     Properties:
       Name: test-name
       StageName: test-stage-name
-      DefinitionUri: 
+      DefinitionUri:
         Bucket: test-bucket
         Key: test-key
         Version: 1
       CacheClusterEnabled: true
       CacheClusterSize: test-cache-cluster-size
       Variables:
-        NAME: VALUE 
+        NAME: VALUE
 
   ServerlessApiWithDefinitionBodyAsJSON:
     Type: AWS::Serverless::Api
@@ -40,27 +40,27 @@ Resources:
       CacheClusterEnabled: true
       CacheClusterSize: test-cache-cluster-size
       Variables:
-        NAME: VALUE 
+        NAME: VALUE
 
   ServerlessApiWithDefinitionBodyAsYAML:
     Type: AWS::Serverless::Api
     Properties:
       Name: test-name
       StageName: test-stage-name
-      DefinitionBody: 
+      DefinitionBody:
         DefinitionKey: test-definition-value
       CacheClusterEnabled: true
       CacheClusterSize: test-cache-cluster-size
       Variables:
-        NAME: VALUE 
+        NAME: VALUE
 
   ServerlessApiWithMethodSettingsAsYAML:
     Type: AWS::Serverless::Api
     Properties:
       Name: test-name
       StageName: test-stage-name
       MethodSettings:
-        LoggingLevel: ERROR
+      - LoggingLevel: ERROR
         MetricsEnabled: true
       CacheClusterEnabled: true
       CacheClusterSize: test-cache-cluster-size