Skip to content

Merge pull request #2790 from microsoft/fix/path-parameter-with-slash-validation #2791

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
baywet merged 1 commit into from
Mar 20, 2026
+83 −9
Merged

Merge pull request #2790 from microsoft/fix/path-parameter-with-slash-validation #2791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions src/Microsoft.OpenApi/Services/OpenApiVisitorBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,19 @@ public virtual void Enter(string segment)
this._path.Push(string.Empty);
return;
}
this._path.Push(EncodeJsonPointerSegment(segment));
}

internal static string EncodeJsonPointerSegment(string? segment)
{
if (string.IsNullOrEmpty(segment))
{
return string.Empty;
}
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP1_0_OR_GREATER
this._path.Push(segment.Replace("~", "~0", StringComparison.Ordinal).Replace("/", "~1", StringComparison.OrdinalIgnoreCase));
return segment.Replace("~", "~0", StringComparison.Ordinal).Replace("/", "~1", StringComparison.OrdinalIgnoreCase);
#else
this._path.Push(segment.Replace("~", "~0").Replace("/", "~1"));
return segment!.Replace("~", "~0").Replace("/", "~1");
#endif
}

Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.OpenApi/Validations/Rules/OpenApiParameterRules.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public static class OpenApiParameterRules
(context, parameter) =>
{
if (parameter.In == ParameterLocation.Path &&
!(context.PathString.Contains("{" + parameter.Name + "}") || context.PathString.Contains("#/components")))
!(context.PathString.Contains("{" + OpenApiVisitorBase.EncodeJsonPointerSegment(parameter.Name) + "}") || context.PathString.Contains("#/components")))
{
context.Enter("in");
context.CreateError(
Expand Down
2 changes: 1 addition & 1 deletion test/Microsoft.OpenApi.Tests/Validations/OpenApiHeaderValidationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ public void ValidateExamplesShouldNotHaveDataTypeMismatchForSimpleSchema()
// Act
var validator = new OpenApiValidator(ValidationRuleSet.GetDefaultRuleSet());
var walker = new OpenApiWalker(validator);
walker.Walk(header);
walker.Walk((IOpenApiHeader)header);

warnings = validator.Warnings;
var result = !warnings.Any();
Expand Down
69 changes: 67 additions & 2 deletions test/Microsoft.OpenApi.Tests/Validations/OpenApiParameterValidationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ public void ValidateExampleShouldNotHaveDataTypeMismatchForSimpleSchema()
var validator = new OpenApiValidator(ValidationRuleSet.GetDefaultRuleSet());
validator.Enter("{parameter1}");
var walker = new OpenApiWalker(validator);
walker.Walk(parameter);
walker.Walk((IOpenApiParameter)parameter);

warnings = validator.Warnings;
var result = !warnings.Any();
Expand Down Expand Up @@ -203,13 +203,78 @@ public void PathParameterInThePathShouldBeOk()
validator.Enter("1");

var walker = new OpenApiWalker(validator);
walker.Walk(parameter);
walker.Walk((IOpenApiParameter)parameter);

errors = validator.Errors;
var result = errors.Any();

// Assert
Assert.False(result);
}

[Fact]
public void PathParameterInThePathShouldBeOkWithSlashInParameterName()
{
// Arrange
IEnumerable<OpenApiError> errors;

var parameter = new OpenApiParameter
{
Name = "parameter/1",
In = ParameterLocation.Path,
Required = true,
Schema = new OpenApiSchema()
{
Type = JsonSchemaType.String,
}
};

// Act
var validator = new OpenApiValidator(ValidationRuleSet.GetDefaultRuleSet());
validator.Enter("paths");
validator.Enter("/{parameter/1}");
validator.Enter("get");
validator.Enter("parameters");
validator.Enter("1");

var walker = new OpenApiWalker(validator);
walker.Walk((IOpenApiParameter)parameter);

errors = validator.Errors;
var result = errors.Any();

// Assert
Assert.False(result);
}

[Fact]
public void PathParameterValidationShouldNotThrowWithEmptyParameterName()
{
// Arrange
var parameter = new OpenApiParameter
{
Name = string.Empty,
In = ParameterLocation.Path,
Required = true,
Schema = new OpenApiSchema()
{
Type = JsonSchemaType.String,
}
};

// Act
var validator = new OpenApiValidator(ValidationRuleSet.GetDefaultRuleSet());
validator.Enter("paths");
validator.Enter("/{}");
validator.Enter("get");
validator.Enter("parameters");
validator.Enter("1");

var walker = new OpenApiWalker(validator);
var exception = Record.Exception(() => walker.Walk((IOpenApiParameter)parameter));

// Assert
Assert.Null(exception);
}
}
}
6 changes: 3 additions & 3 deletions test/Microsoft.OpenApi.Tests/Validations/OpenApiSchemaValidationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public void ValidateDefaultShouldNotHaveDataTypeMismatchForSimpleSchema()
// Act
var validator = new OpenApiValidator(ValidationRuleSet.GetDefaultRuleSet());
var walker = new OpenApiWalker(validator);
walker.Walk(schema);
walker.Walk((IOpenApiSchema)schema);

warnings = validator.Warnings;
var result = !warnings.Any();
Expand All @@ -50,7 +50,7 @@ public void ValidateExampleAndDefaultShouldNotHaveDataTypeMismatchForSimpleSchem
// Act
var validator = new OpenApiValidator(ValidationRuleSet.GetDefaultRuleSet());
var walker = new OpenApiWalker(validator);
walker.Walk(schema);
walker.Walk((IOpenApiSchema)schema);

warnings = validator.Warnings;
bool result = !warnings.Any();
Expand Down Expand Up @@ -92,7 +92,7 @@ public void ValidateEnumShouldNotHaveDataTypeMismatchForSimpleSchema()
// Act
var validator = new OpenApiValidator(ValidationRuleSet.GetDefaultRuleSet());
var walker = new OpenApiWalker(validator);
walker.Walk(schema);
walker.Walk((IOpenApiSchema)schema);

warnings = validator.Warnings;
var result = !warnings.Any();
Expand Down
Loading