Skip to content

Add deprecation warning to Microsoft.Extensions.ApiDescription.Client MSBuild package #62646

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
merged 4 commits into from
Jul 10, 2025
Merged

Add deprecation warning to Microsoft.Extensions.ApiDescription.Client MSBuild package #62646

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4cad482
Initial plan
Copilot Jul 9, 2025
a7e98cd
Add deprecation warning to MSBuild package in Extensions.ApiDescripti…
Copilot Jul 9, 2025
5bc86d4
Update deprecation warning text to include aka.ms link
Copilot Jul 10, 2025
0b05243
Add warning code and help link to deprecation warning
Copilot Jul 10, 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
5 changes: 5 additions & 0 deletions ...tensions.ApiDescription.Client/src/build/Microsoft.Extensions.ApiDescription.Client.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
<PropertyGroup>
<_ApiDescriptionClientAssemblyPath>$(MSBuildThisFileDirectory)../tasks/netstandard2.0/Microsoft.Extensions.ApiDescription.Client.dll</_ApiDescriptionClientAssemblyPath>
</PropertyGroup>

<!-- Emit deprecation warning for this package -->
<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" />
Copy link
Member

@DamianEdwards DamianEdwards Jul 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just verifying, this can be suppressed with <NoWarn>$(NoWarn);ASPDEPR001</NoWarn> in the project file, right?

Copy link
Member

@captainsafia captainsafia Jul 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep -- NoWarn will work now that we have a code for this.

</Target>
<UsingTask TaskName="GetCurrentOpenApiReference" AssemblyFile="$(_ApiDescriptionClientAssemblyPath)" />
<UsingTask TaskName="GetOpenApiReferenceMetadata" AssemblyFile="$(_ApiDescriptionClientAssemblyPath)" />

Expand Down
Loading