Merge pull request #215 from Microsoft/PerthCharern/RelaxResponsesRule

Fix Responses rule

- Check there's one response. It doesn't have to be a success response.

- Check that the response key format adheres to the spec

Author: PerthCharern

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

@@ -2,8 +2,8 @@
 // Licensed under the MIT license. 
 
 using System.Linq;
+using System.Text.RegularExpressions;
 using Microsoft.OpenApi.Models;
-using Microsoft.OpenApi.Properties;
 
 namespace Microsoft.OpenApi.Validations.Rules
 {
@@ -14,16 +14,46 @@ namespace Microsoft.OpenApi.Validations.Rules
     public static class OpenApiResponsesRules
     {
         /// <summary>
-        /// An OpenAPI operation must contain at least one successful response
+        /// An OpenAPI operation must contain at least one response
         /// </summary>
-        public static ValidationRule<OpenApiResponses> ResponsesMustContainSuccessResponse =>
+        public static ValidationRule<OpenApiResponses> ResponsesMustContainAtLeastOneResponse =>
             new ValidationRule<OpenApiResponses>(
-                (context, item) =>
+                (context, responses) =>
                 {
-                    if (!item.Keys.Any(k => k.StartsWith("2"))) {
-                        context.AddError(new ValidationError(ErrorReason.Required,context.PathString,"Responses must contain success response"));
+                    if (!responses.Keys.Any())
+                    {
+                        context.AddError(
+                            new ValidationError(
+                                ErrorReason.Required,
+                                context.PathString,
+                                "Responses must contain at least one response"));
                     }
                 });
 
+        /// <summary>
+        /// The response key must either be "default" or an HTTP status code (1xx, 2xx, 3xx, 4xx, 5xx)
+        /// </summary>
+        public static ValidationRule<OpenApiResponses> ResponsesMustBeIdentifiedByDefaultOrStatusCode =>
+            new ValidationRule<OpenApiResponses>(
+                (context, responses) =>
+                {
+                    foreach (var key in responses.Keys)
+                    {
+                        context.Enter(key);
+
+                        if (key != "default" && !Regex.IsMatch(key, "^[1-5]([0-9][0-9]|XX)$"))
+                        {
+                            context.AddError(
+                                new ValidationError(
+                                    ErrorReason.Format,
+                                    context.PathString,
+                                    "Responses key must be 'default', an HTTP status code, " +
+                                    "or one of the following strings representing a range of HTTP status codes: " +
+                                    "'1XX', '2XX', '3XX', '4XX', '5XX'"));
+                        }
+
+                        context.Exit();
+                    }
+                });
     }
 }

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

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