Merge pull request #376 from senthilkumarmohan/fix#375-Add-schema-rules-for-discriminator-and-required-fields

Fix#375 added schema rules for discriminator and required fields

Author: PerthCharern

src/Microsoft.OpenApi/Properties/SRResource.Designer.cs

@@ -216,6 +216,9 @@
   <data name="Validation_RuleAddTwice" xml:space="preserve">
     <value>The same rule cannot be in the same rule set twice.</value>
   </data>
+  <data name="Validation_SchemaRequiredFieldListMustContainThePropertySpecifiedInTheDiscriminator" xml:space="preserve">
+    <value>Schema {0} must contain property specified in the discriminator {1} in the required field list.</value>
+  </data>
   <data name="Validation_StringMustBeEmailAddress" xml:space="preserve">
     <value>The string '{0}' MUST be in the format of an email address.</value>
   </data>

src/Microsoft.OpenApi/Properties/SRResource.resx

@@ -772,7 +772,7 @@ internal void Walk(OpenApiSchema schema)
 
             if (schema.AnyOf != null)
             {
-                Walk("anyOf", () => Walk(schema.AllOf));
+                Walk("anyOf", () => Walk(schema.AnyOf));
             }
 
             if (schema.Properties != null) {
@@ -883,7 +883,7 @@ internal void Walk(IList<OpenApiSchema> schemas)
                 }
             }
         }
-
+        
         /// <summary>
         /// Visits <see cref="OpenApiOAuthFlows"/> and child objects
         /// </summary>

src/Microsoft.OpenApi/Services/OpenApiWalker.cs

@@ -57,6 +57,29 @@ public static class OpenApiSchemaRules
                     context.Exit();
                 });
 
+        /// <summary>
+        /// Validates Schema Discriminator
+        /// </summary>
+        public static ValidationRule<OpenApiSchema> ValidateSchemaDiscriminator =>
+            new ValidationRule<OpenApiSchema>(
+                (context, schema) =>
+                {
+                    // discriminator
+                    context.Enter("discriminator");
+
+                    if(schema.Reference != null && schema.Discriminator != null)
+                    {
+                        if (!schema.Required.Contains(schema.Discriminator?.PropertyName))
+                        {
+                            context.CreateError(nameof(ValidateSchemaDiscriminator),
+                                                string.Format(SRResource.Validation_SchemaRequiredFieldListMustContainThePropertySpecifiedInTheDiscriminator,
+                                                                                schema.Reference.Id, schema.Discriminator.PropertyName));
+                        }
+                    }
+
+                    context.Exit();
+                });
+
         /// <summary>
         /// Validates OneOf Discriminator
         /// </summary>
@@ -97,7 +120,7 @@ public static class OpenApiSchemaRules
 
         // add more rule.
 
-        
+
         /// <summary>
         /// Checks if the schemas in the list contain a property with the property name specified by the discriminator.
         /// </summary>

src/Microsoft.OpenApi/Validations/Rules/OpenApiSchemaRules.cs

@@ -352,5 +352,41 @@ public void ValidateAnyOfCompositeSchemaMustContainPropertySpecifiedInTheDiscrim
 
                 });
         }
+
+        [Fact]
+        public void ValidateSchemaRequiredFieldListMustContainThePropertySpecifiedInTheDiscriminator()
+        {
+            IEnumerable<OpenApiError> errors;
+            var components = new OpenApiComponents
+            {
+                Schemas = {
+                    {
+                        "schema1",
+                        new OpenApiSchema
+                        {
+                            Type = "object",
+                            Discriminator = new OpenApiDiscriminator { PropertyName = "property1" },
+                            Reference = new OpenApiReference { Id = "schema1" }
+                        }
+                    }
+                }
+            };
+            // Act
+            var validator = new OpenApiValidator(ValidationRuleSet.GetDefaultRuleSet());
+            var walker = new OpenApiWalker(validator);
+            walker.Walk(components);
+
+            errors = validator.Errors;
+            bool result = !errors.Any();
+
+            // Assert
+            result.Should().BeFalse();
+            errors.ShouldAllBeEquivalentTo(new List<OpenApiValidatorError>
+            {
+                    new OpenApiValidatorError(nameof(OpenApiSchemaRules.ValidateSchemaDiscriminator),"#/schemas/schema1/discriminator",
+                        string.Format(SRResource.Validation_SchemaRequiredFieldListMustContainThePropertySpecifiedInTheDiscriminator,
+                                    "schema1", "property1"))
+            });
+        }
     }
 }

test/Microsoft.OpenApi.Tests/Validations/OpenApiSchemaValidationTests.cs

@@ -43,7 +43,7 @@ public void DefaultRuleSetPropertyReturnsTheCorrectRules()
             Assert.NotEmpty(rules);
 
             // Update the number if you add new default rule(s).
-            Assert.Equal(22, rules.Count);
+            Assert.Equal(23, rules.Count);
         }
     }
 }