Add Validation Rule for path operations to not have a request body #2472
+437
−125
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Avoid using `Enter()` and `Exit()` operations in validation rules where possible. - Use `string` not `String`. - Remove redundant comments. - Fix typo in comment.
Add new `OpenApiRecommendedRules` class and adds a new `GetOperationShouldNotHaveRequestBody` rule. Resolves microsoft#2454.
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new validation rule to check that GET operations should not have request bodies, along with several code quality improvements. The changes introduce the OpenApiRecommendedRules class with a specific validation rule for GET operations and refactor existing validation rules to optimize performance.
- Adds
GetOperationShouldNotHaveRequestBodyvalidation rule in newOpenApiRecommendedRulesclass - Optimizes validation rules by avoiding unnecessary
Enter()/Exit()calls when validation conditions aren't met - Standardizes string usage and fixes typos across validation rule files
Reviewed Changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
src/Microsoft.OpenApi/Validations/Rules/OpenApiRecommendedRules.cs |
New class containing the GET operation request body validation rule |
test/Microsoft.OpenApi.Tests/Validations/OpenApiRecommendedRulesTests.cs |
Comprehensive tests for the new validation rule |
test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt |
Updates public API surface to include new class |
| Multiple validation rule files | Performance optimizations and code quality improvements |
src/Microsoft.OpenApi/Services/OpenApiVisitorBase.cs |
Typo fix in comment |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
src/Microsoft.OpenApi/Validations/Rules/OpenApiResponsesRules.cs
Outdated
Show resolved
Hide resolved
Address Copilot feedback.
baywet
requested changes
Aug 22, 2025
Address feedback.
baywet
approved these changes
Aug 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
OpenApiRecommendedRulesclass that adds a newGetOperationShouldNotHaveRequestBodyrule.Enter()andExit()operations in validation rules where possible to avoid stack push/pop calls these perform.stringnotString.Resolves #2454.