[OpenApi] Support derived FromKeyedServices types to ignore parameters #62926
+36
−3
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
- Support attributes derived from `FromKeyedServicesAttribute`. - Add test for existing support for attributes derived from `FromServicesAttribute`. Resolves dotnet#58739.
martincostello
requested review from
captainsafia,
a team and
halter73
as code owners
github-actions
bot
added
the
area-mvc
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for derived FromKeyedServicesAttribute types to be properly ignored as OpenAPI parameters, matching the existing behavior for derived FromServicesAttribute types.
- Changes the equality check to use
IsAssignableFromforFromKeyedServicesAttributeto support inheritance - Adds comprehensive test coverage for both derived
FromServicesAttributeandFromKeyedServicesAttributeattributes - Ensures consistent behavior across OpenAPI generation and API description providers
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
src/OpenApi/src/Services/OpenApiGenerator.cs |
Updates the attribute check to use IsAssignableFrom for FromKeyedServicesAttribute inheritance support |
src/Mvc/Mvc.ApiExplorer/src/EndpointMetadataApiDescriptionProvider.cs |
Same inheritance support change for API description generation |
src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiGeneratorTests.cs |
Adds test cases for derived attributes and custom attribute classes |
src/Mvc/Mvc.ApiExplorer/test/EndpointMetadataApiDescriptionProviderTest.cs |
Adds test cases for derived attributes and custom attribute classes |
src/Mvc/Mvc.ApiExplorer/test/DefaultApiDescriptionProviderTest.cs |
Adds comprehensive test method and custom attribute classes for derived services |
Comments suppressed due to low confidence (1)
src/Mvc/Mvc.ApiExplorer/test/DefaultApiDescriptionProviderTest.cs:11
- This unused import removal appears unrelated to the PR's purpose of supporting derived FromKeyedServices types. Consider including this change in a separate cleanup commit or PR.
using Microsoft.AspNetCore.Http;
dotnet-policy-service
bot
added
the
community-contribution
|
Thanks for your PR, @@martincostello. Someone from the team will get assigned to your PR shortly and we'll get it reviewed. |
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.
Support derived FromKeyedServices
Ignore endpoint parameters using derived
[FromKeyedServices]attributes.Description
FromKeyedServicesAttribute.FromServicesAttribute.Fixes #58739