Visitar URL original
Add Validation Rule for path operations to not have a request body by martincostello · Pull Request #2472 · microsoft/OpenAPI.NET · GitHub
Skip to content

Add Validation Rule for path operations to not have a request body #2472

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
Vincent Biret (baywet) merged 4 commits into from
Aug 25, 2025
Merged

Add Validation Rule for path operations to not have a request body #2472

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1783904
Avoid context enter/exit
martincostello Aug 22, 2025
7b7cea4
Add recommended rules
martincostello Aug 22, 2025
bbdaa02
Address feedback
martincostello Aug 22, 2025
92564f3
Test not part of default rules
martincostello Aug 23, 2025
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
Prev Previous commit
Next Next commit
Address feedback 
Address Copilot feedback.
  • Loading branch information
@martincostello
martincostello committed Aug 22, 2025
commit bbdaa02308f946dbfa6f0b257a55adc825bb6718
2 changes: 1 addition & 1 deletion src/Microsoft.OpenApi/Validations/Rules/OpenApiResponsesRules.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public static partial class OpenApiResponsesRules
new(nameof(ResponsesMustContainAtLeastOneResponse),
(context, responses) =>
{
if (responses.Keys.Count == 0)
if (responses.Count == 0)
{
context.CreateError(nameof(ResponsesMustContainAtLeastOneResponse),
"Responses must contain at least one response");
Expand Down
14 changes: 6 additions & 8 deletions test/Microsoft.OpenApi.Tests/Validations/OpenApiRecommendedRulesTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,6 @@ public static void GetOperationWithoutRequestBodyIsValid()
ruleSet.Add(typeof(OpenApiPaths), OpenApiRecommendedRules.GetOperationShouldNotHaveRequestBody);

// Act

var errors = document.Validate(ruleSet);
var result = !errors.Any();

Expand Down Expand Up @@ -193,15 +192,14 @@ public static void GetOperationWithRequestBodyIsInvalid()
ruleSet.Add(typeof(OpenApiPaths), OpenApiRecommendedRules.GetOperationShouldNotHaveRequestBody);

// Act

var errors = document.Validate(ruleSet);
var result = !errors.Any();
var warnings = document.Validate(ruleSet);
var result = !warnings.Any();

// Assert
Assert.False(result);
Assert.NotNull(errors);
var error = Assert.Single(errors);
Assert.Equal("GET operations should not have a request body.", error.Message);
Assert.Equal("#/paths/people/get/requestbody", error.Pointer);
Assert.NotNull(warnings);
var warning = Assert.Single(warnings);
Assert.Equal("GET operations should not have a request body.", warning.Message);
Assert.Equal("#/paths/people/get/requestbody", warning.Pointer);
}
}