New rule S6968 for C#: Actions that return a value should be annotated with ProducesResponseTypeAttribute containing the return type #9185
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
costin-zaharia-sonarsource
force-pushed
the
costin/rule-S6968
branch
from
f32e0d1 to
f12d0ea
Compare
gregory-paidis-sonarsource
requested changes
Apr 24, 2024
Contributor
gregory-paidis-sonarsource
left a comment
gregory-paidis-sonarsource
left a comment
There was a problem hiding this comment.
Very good work, but we need to consider some more cases.
Mostly this is on me, as I did not add "negative" tests that should be compliant during spec😞
To sum it up:
- Invocations should be inside return statements
- Some
ControllerBaseoverloads need to be excluded SwaggerResponseat controller level.
analyzers/tests/SonarAnalyzer.Test/Rules/SwaggerActionReturnTypeTest.cs
Outdated
Show resolved
Hide resolved
analyzers/tests/SonarAnalyzer.Test/Rules/SwaggerActionReturnTypeTest.cs
Outdated
Show resolved
Hide resolved
analyzers/src/SonarAnalyzer.CSharp/Rules/SwaggerActionReturnType.cs
Outdated
Show resolved
Hide resolved
analyzers/src/SonarAnalyzer.CSharp/Rules/SwaggerActionReturnType.cs
Outdated
Show resolved
Hide resolved
analyzers/src/SonarAnalyzer.CSharp/Rules/SwaggerActionReturnType.cs
Outdated
Show resolved
Hide resolved
analyzers/src/SonarAnalyzer.CSharp/Rules/SwaggerActionReturnType.cs
Outdated
Show resolved
Hide resolved
costin-zaharia-sonarsource
force-pushed
the
costin/rule-S6968
branch
3 times, most recently
from
4734c75 to
64042ab
Compare
auto-merge was automatically disabled
April 24, 2024 14:57
Pull Request is not mergeable
costin-zaharia-sonarsource
force-pushed
the
costin/rule-S6968
branch
from
64042ab to
d7672ff
Compare
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fixes #9093