Skip to content

Commit df86936

Browse files
committed
resolve the comments, typos and some test codes
1 parent aebee6f commit df86936

File tree

10 files changed

+39
-12
lines changed

10 files changed

+39
-12
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ internal static class OpenApiExternalDocsRules
2020
new ValidationRule<OpenApiExternalDocs>(
2121
(context, item) =>
2222
{
23-
// title
23+
// url
2424
context.Push("url");
2525
if (item.Url == null)
2626
{

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ namespace Microsoft.OpenApi.Validations.Rules
1313
public static class OpenApiPathsRules
1414
{
1515
/// <summary>
16-
/// A relative path to an individual endpoint. The field name MUST begin with a slash.
16+
/// A relative path to an individual endpoint. The field name MUST begin with a slash.
1717
/// </summary>
1818
public static ValidationRule<OpenApiPaths> PathNameMustBeginWithSlash =>
1919
new ValidationRule<OpenApiPaths>(

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ internal static class OpenApiResponseRules
2020
new ValidationRule<OpenApiResponse>(
2121
(context, response) =>
2222
{
23-
// title
23+
// description
2424
context.Push("description");
2525
if (String.IsNullOrEmpty(response.Description))
2626
{

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ namespace Microsoft.OpenApi.Validations.Rules
1414
public static class OpenApiServerRules
1515
{
1616
/// <summary>
17-
/// REQUIRED.
17+
/// Validate the field is required.
1818
/// </summary>
1919
public static ValidationRule<OpenApiServer> FieldIsRequired =>
2020
new ValidationRule<OpenApiServer>(

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ namespace Microsoft.OpenApi.Validations.Rules
1414
public static class OpenApiTagRules
1515
{
1616
/// <summary>
17-
/// REQUIRED.
17+
/// Validate the field is required.
1818
/// </summary>
1919
public static ValidationRule<OpenApiTag> FieldIsRequired =>
2020
new ValidationRule<OpenApiTag>(

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ internal static class RuleHelpers
1111
/// Input string must be in the format of an email address
1212
/// </summary>
1313
/// <param name="input">The input string.</param>
14-
/// <returns></returns>
14+
/// <returns>True if it's an email address. Otherwise False.</returns>
1515
public static bool IsEmailAddress(this string input)
1616
{
1717
if (String.IsNullOrEmpty(input))

src/Microsoft.OpenApi/Validations/ValidationError.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ public ValidationError(ErrorReason reason, string path, string message)
5858
/// <returns>The error string.</returns>
5959
public override string ToString()
6060
{
61-
return "ErroCode: " + ErrorCode + ", " + ErrorPath + " | " + ErrorMessage;
61+
return "ErrorCode: " + ErrorCode + ", " + ErrorPath + " | " + ErrorMessage;
6262
}
6363
}
6464
}

src/Microsoft.OpenApi/Validations/Visitors/VisitorBase.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ public void Visit(ValidationContext context, object item)
3838
/// <param name="element">The element.</param>
3939
protected virtual void Next(ValidationContext context, T element)
4040
{
41-
IOpenApiExtensible extensbile = element as IOpenApiExtensible;
42-
if (extensbile != null)
41+
IOpenApiExtensible extensible = element as IOpenApiExtensible;
42+
if (extensible != null)
4343
{
4444
var rules = context.RuleSet.Where(r => r.ElementType == typeof(IOpenApiExtensible));
4545
foreach (var rule in rules)
4646
{
47-
rule.Evaluate(context, extensbile);
47+
rule.Evaluate(context, extensible);
4848
}
4949
}
5050
}

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ public void ValidateDescriptionIsRequiredInResponse()
2424
Assert.NotNull(errors);
2525
ValidationError error = Assert.Single(errors);
2626
Assert.Equal("The field 'description' in 'response' object is REQUIRED.", error.ErrorMessage);
27+
Assert.Equal(ErrorReason.Required, error.ErrorCode);
28+
Assert.Equal("#/description", error.ErrorPath);
2729
}
2830
}
2931
}

test/Microsoft.OpenApi.Tests/Validations/Visitors/OpenApiVisitorSetTests.cs

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public void VisitorsPropertyReturnsTheCorrectVisitorList()
2121
// Assert
2222
Assert.NotNull(visitors);
2323
Assert.NotEmpty(visitors);
24-
Assert.Equal(29, visitors.Count);
24+
Assert.Equal(29, visitors.Count); // Now, we have 29 DOM classes.
2525
}
2626
}
2727

@@ -38,10 +38,35 @@ public void GetVisitorThrowsUnknowElementType()
3838
}
3939

4040
[Theory]
41+
[InlineData(typeof(OpenApiCallback), typeof(CallbackVisitor))]
42+
[InlineData(typeof(OpenApiComponents), typeof(ComponentsVisitor))]
43+
[InlineData(typeof(OpenApiContact), typeof(ContactVisitor))]
44+
[InlineData(typeof(OpenApiDiscriminator), typeof(DiscriminatorVisitor))]
4145
[InlineData(typeof(OpenApiDocument), typeof(DocumentVisitor))]
46+
[InlineData(typeof(OpenApiEncoding), typeof(EncodingVisitor))]
47+
[InlineData(typeof(OpenApiExample), typeof(ExampleVisitor))]
48+
[InlineData(typeof(OpenApiExternalDocs), typeof(ExternalDocsVisitor))]
49+
[InlineData(typeof(OpenApiHeader), typeof(HeaderVisitor))]
4250
[InlineData(typeof(OpenApiInfo), typeof(InfoVisitor))]
51+
[InlineData(typeof(OpenApiLicense), typeof(LicenseVisitor))]
52+
[InlineData(typeof(OpenApiLink), typeof(LinkVisitor))]
53+
[InlineData(typeof(OpenApiMediaType), typeof(MediaTypeVisitor))]
54+
[InlineData(typeof(OpenApiOAuthFlows), typeof(OAuthFlowsVisitor))]
55+
[InlineData(typeof(OpenApiOAuthFlow), typeof(OAuthFlowVisitor))]
56+
[InlineData(typeof(OpenApiOperation), typeof(OperationVisitor))]
57+
[InlineData(typeof(OpenApiParameter), typeof(ParameterVisitor))]
58+
[InlineData(typeof(OpenApiPathItem), typeof(PathItemVisitor))]
59+
[InlineData(typeof(OpenApiPaths), typeof(PathsVisitor))]
60+
[InlineData(typeof(OpenApiRequestBody), typeof(RequestBodyVisitor))]
61+
[InlineData(typeof(OpenApiResponses), typeof(ResponsesVisitor))]
62+
[InlineData(typeof(OpenApiResponse), typeof(ResponseVisitor))]
63+
[InlineData(typeof(OpenApiSchema), typeof(SchemaVisitor))]
64+
[InlineData(typeof(OpenApiSecurityRequirement), typeof(SecurityRequirementVisitor))]
65+
[InlineData(typeof(OpenApiSecurityScheme), typeof(SecuritySchemeVisitor))]
66+
[InlineData(typeof(OpenApiServerVariable), typeof(ServerVariableVisitor))]
67+
[InlineData(typeof(OpenApiServer), typeof(ServerVisitor))]
68+
[InlineData(typeof(OpenApiTag), typeof(TagVisitor))]
4369
[InlineData(typeof(OpenApiXml), typeof(XmlVisitor))]
44-
[InlineData(typeof(OpenApiComponents), typeof(ComponentsVisitor))]
4570
public void GetVisitorReturnsTheCorrectVisitor(Type elementType, Type visitorType)
4671
{
4772
// Arrange & Act

0 commit comments

Comments
 (0)