Drop ApiDescription.Client package - #68211
Merged
Merged
Conversation
Youssef1313
commented
Aug 5, 2026
Comment on lines
-8
to
-10
| <Target Name="_WarnMicrosoftExtensionsApiDescriptionClientDeprecated" BeforeTargets="BeforeCompile;Build;Restore"> | ||
| <Warning Code="ASPDEPR001" Text="The 'Microsoft.Extensions.ApiDescription.Client' package is deprecated and will be removed in a future release." HelpLink="https://aka.ms/aspnet/deprecate/001" /> | ||
| </Target> |
Member
Author
There was a problem hiding this comment.
This was the deprecation message for users.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR removes the deprecated Microsoft.Extensions.ApiDescription.Client (Extensions.ApiDescription.Client) tooling package from the repository, including its projects, build assets, and tests, and drops it from solution/build bookkeeping.
Changes:
- Remove
Microsoft.Extensions.ApiDescription.Clientprojects from solution filters/solution index. - Remove the assembly/project from
eng/shipping and project reference lists. - Delete the package’s implementation, build/targets content, nuspec, and associated test infrastructure and test assets.
Reviewed changes
Copilot reviewed 29 out of 29 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Tools/Tools.slnf | Removes the ApiDescription.Client projects from the Tools solution filter. |
| src/Tools/Extensions.ApiDescription.Client/test/TestProjects/files/swashbuckle.json | Removes test OpenAPI input file as part of deleting the test suite. |
| src/Tools/Extensions.ApiDescription.Client/test/TestProjects/files/NSwag.json | Removes test OpenAPI input file as part of deleting the test suite. |
| src/Tools/Extensions.ApiDescription.Client/test/TestProjects/files/azureMonitor.json | Removes test OpenAPI input file as part of deleting the test suite. |
| src/Tools/Extensions.ApiDescription.Client/test/TestProjects/build/Fakes.targets | Removes test build fakes used by the deleted test projects. |
| src/Tools/Extensions.ApiDescription.Client/test/TemporaryOpenApiProject.cs | Removes temporary project harness used by the deleted tests. |
| src/Tools/Extensions.ApiDescription.Client/test/TargetTest.cs | Removes end-to-end MSBuild target behavior tests for the deleted package. |
| src/Tools/Extensions.ApiDescription.Client/test/MockBuildEngine.cs | Removes test build engine mock used by deleted tests. |
| src/Tools/Extensions.ApiDescription.Client/test/Microsoft.Extensions.ApiDescription.Client.Tests.csproj | Removes the test project definition. |
| src/Tools/Extensions.ApiDescription.Client/test/MetadataSerializerTest.cs | Removes unit tests for metadata serialization in the deleted package. |
| src/Tools/Extensions.ApiDescription.Client/test/GetOpenApiReferenceMetadataTest.cs | Removes unit tests for OpenApiReference metadata task behavior. |
| src/Tools/Extensions.ApiDescription.Client/test/GetCurrentOpenApiReferenceTest.cs | Removes unit tests for current OpenApiReference restoration task. |
| src/Tools/Extensions.ApiDescription.Client/test/CSharpIdentifierTest.cs | Removes unit tests for identifier sanitization helper in the deleted package. |
| src/Tools/Extensions.ApiDescription.Client/src/Resources.resx | Removes the resource strings used by the deleted MSBuild tasks. |
| src/Tools/Extensions.ApiDescription.Client/src/Microsoft.Extensions.ApiDescription.Client.nuspec | Removes NuGet packaging spec for the deleted package. |
| src/Tools/Extensions.ApiDescription.Client/src/Microsoft.Extensions.ApiDescription.Client.csproj | Removes the package project file. |
| src/Tools/Extensions.ApiDescription.Client/src/MetadataSerializer.cs | Removes package implementation (metadata serialization). |
| src/Tools/Extensions.ApiDescription.Client/src/GetOpenApiReferenceMetadata.cs | Removes MSBuild task implementation for OpenApiReference item metadata. |
| src/Tools/Extensions.ApiDescription.Client/src/GetCurrentOpenApiReference.cs | Removes MSBuild task implementation for deserializing item metadata. |
| src/Tools/Extensions.ApiDescription.Client/src/CSharpIdentifier.cs | Removes helper used for generating safe C# identifiers. |
| src/Tools/Extensions.ApiDescription.Client/src/buildMultiTargeting/Microsoft.Extensions.ApiDescription.Client.targets | Removes multi-targeting support targets for the deleted package. |
| src/Tools/Extensions.ApiDescription.Client/src/buildMultiTargeting/Microsoft.Extensions.ApiDescription.Client.props | Removes multi-targeting props for the deleted package. |
| src/Tools/Extensions.ApiDescription.Client/src/build/OpenApiItemsSchema.xaml | Removes CPS property page schema for OpenAPI items. |
| src/Tools/Extensions.ApiDescription.Client/src/build/Microsoft.Extensions.ApiDescription.Client.targets | Removes build targets that wired OpenAPI codegen into builds. |
| src/Tools/Extensions.ApiDescription.Client/src/build/Microsoft.Extensions.ApiDescription.Client.props | Removes build props (including deprecation warning target) for the deleted package. |
| src/Tools/Extensions.ApiDescription.Client/README.md | Removes package README. |
| eng/ShippingAssemblies.props | Drops Microsoft.Extensions.ApiDescription.Client from the shipping assembly list. |
| eng/ProjectReferences.props | Drops Microsoft.Extensions.ApiDescription.Client from project reference provider list. |
| AspNetCore.slnx | Removes the Extensions.ApiDescription.Client folder/projects from the solution index. |
Comment on lines
106
to
108
| "src\\Testing\\src\\Microsoft.AspNetCore.InternalTesting.csproj", | ||
| "src\\Tools\\Extensions.ApiDescription.Client\\src\\Microsoft.Extensions.ApiDescription.Client.csproj", | ||
| "src\\Tools\\Extensions.ApiDescription.Client\\test\\Microsoft.Extensions.ApiDescription.Client.Tests.csproj", | ||
| "src\\Tools\\Extensions.ApiDescription.Server\\src\\Microsoft.Extensions.ApiDescription.Server.csproj", | ||
| "src\\Tools\\FirstRunCertGenerator\\src\\Microsoft.AspNetCore.DeveloperCertificates.XPlat.csproj", |
Comment on lines
130
to
133
| <AspNetCoreShippingAssembly Include="Microsoft.AspNetCore.Authentication.OpenIdConnect" /> | ||
| <AspNetCoreShippingAssembly Include="Microsoft.AspNetCore.Authentication.Twitter" /> | ||
| <AspNetCoreShippingAssembly Include="Microsoft.AspNetCore.Authentication.WsFederation" /> | ||
| <AspNetCoreShippingAssembly Include="Microsoft.Extensions.ApiDescription.Client" /> | ||
| <AspNetCoreShippingAssembly Include="Microsoft.Extensions.ApiDescription.Server" /> |
wtgodbe
approved these changes
Aug 5, 2026
Member
Author
|
/backport to release/10.0 |
Contributor
|
Started backporting to |
Contributor
|
@Youssef1313 backporting to git am output$ git am --3way --empty=keep --ignore-whitespace --keep-non-patch changes.patch
Applying: Drop ApiDescription.Client package
Using index info to reconstruct a base tree...
M AspNetCore.slnx
M eng/ProjectReferences.props
M eng/ShippingAssemblies.props
M src/Tools/Extensions.ApiDescription.Client/src/Microsoft.Extensions.ApiDescription.Client.nuspec
M src/Tools/Extensions.ApiDescription.Client/src/build/Microsoft.Extensions.ApiDescription.Client.props
M src/Tools/Extensions.ApiDescription.Client/src/buildMultiTargeting/Microsoft.Extensions.ApiDescription.Client.props
M src/Tools/Extensions.ApiDescription.Client/test/TargetTest.cs
M src/Tools/Extensions.ApiDescription.Client/test/TemporaryOpenApiProject.cs
M src/Tools/Tools.slnf
Falling back to patching base and 3-way merge...
Auto-merging AspNetCore.slnx
Auto-merging eng/ProjectReferences.props
Auto-merging eng/ShippingAssemblies.props
CONFLICT (modify/delete): src/Tools/Extensions.ApiDescription.Client/src/Microsoft.Extensions.ApiDescription.Client.nuspec deleted in Drop ApiDescription.Client package and modified in HEAD. Version HEAD of src/Tools/Extensions.ApiDescription.Client/src/Microsoft.Extensions.ApiDescription.Client.nuspec left in tree.
CONFLICT (modify/delete): src/Tools/Extensions.ApiDescription.Client/src/build/Microsoft.Extensions.ApiDescription.Client.props deleted in Drop ApiDescription.Client package and modified in HEAD. Version HEAD of src/Tools/Extensions.ApiDescription.Client/src/build/Microsoft.Extensions.ApiDescription.Client.props left in tree.
CONFLICT (modify/delete): src/Tools/Extensions.ApiDescription.Client/src/buildMultiTargeting/Microsoft.Extensions.ApiDescription.Client.props deleted in Drop ApiDescription.Client package and modified in HEAD. Version HEAD of src/Tools/Extensions.ApiDescription.Client/src/buildMultiTargeting/Microsoft.Extensions.ApiDescription.Client.props left in tree.
CONFLICT (modify/delete): src/Tools/Extensions.ApiDescription.Client/test/TargetTest.cs deleted in Drop ApiDescription.Client package and modified in HEAD. Version HEAD of src/Tools/Extensions.ApiDescription.Client/test/TargetTest.cs left in tree.
CONFLICT (modify/delete): src/Tools/Extensions.ApiDescription.Client/test/TemporaryOpenApiProject.cs deleted in Drop ApiDescription.Client package and modified in HEAD. Version HEAD of src/Tools/Extensions.ApiDescription.Client/test/TemporaryOpenApiProject.cs left in tree.
Auto-merging src/Tools/Tools.slnf
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config set advice.mergeConflict false"
Patch failed at 0001 Drop ApiDescription.Client package
Error: The process '/usr/bin/git' failed with exit code 128 |
Copilot AI
added a commit
that referenced
this pull request
Aug 6, 2026
Co-authored-by: Youssef1313 <31348972+Youssef1313@users.noreply.github.com>
This was referenced Aug 6, 2026
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
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.
Fixes #68203
This package was deprecated in .NET 10. So, simply removing it completely.