Skip to content

Support Deprecation header #1151

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

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
Draft

Support Deprecation header #1151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
5e83209
Extract base class for LinkList
Nov 26, 2025
219f5c7
Add DeprecationPolicy class
Nov 26, 2025
54d9cf3
Extract PolicyBuilder base interface
Nov 26, 2025
b803da7
Extract LinkBuilder base class
Nov 26, 2025
012bf1c
Implement DeprecationPolicyBuilder
Nov 26, 2025
3d03004
Add deprecation policy to ApIVersionPolicyBuilder
Nov 26, 2025
8622463
Extract PolicyManager base class
Nov 26, 2025
ec9c98f
Implement DeprecationPolicyManager
Nov 26, 2025
c882dc2
Emit Deprecation header when policy is set
Nov 26, 2025
fb39354
Pass DeprecationPolicyManager through all service layers
Nov 26, 2025
4c5c545
Include DeprecationPolicy in Swagger generation
Nov 26, 2025
9a5389d
Fix compile errors in netstandard
Nov 26, 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
75 changes: 67 additions & 8 deletions examples/AspNetCore/OData/ODataOpenApiExample/ConfigureSwaggerOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,25 +50,84 @@ private static OpenApiInfo CreateInfoForApiVersion( ApiVersionDescription descri
text.Append( " This API version has been deprecated." );
}

if ( description.SunsetPolicy is { } policy )
if ( description.DeprecationPolicy is { } deprecationPolicy )
{
if ( policy.Date is { } when )
if ( deprecationPolicy.Date is { } when )
{
text.Append( " The API will be sunset on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
if ( when < DateTime.Now )
{
text.Append( " The API has been deprecated on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
}
else
{
text.Append( " The API will be deprecated on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
}
}

if ( policy.HasLinks )
if ( deprecationPolicy.HasLinks )
{
text.AppendLine();

var rendered = false;

for ( var i = 0; i < policy.Links.Count; i++ )
foreach ( var link in deprecationPolicy.Links )
{
var link = policy.Links[i];
if ( link.Type == "text/html" )
{
if ( !rendered )
{
text.Append( "<h4>Links</h4><ul>" );
rendered = true;
}

text.Append( "<li><a href=\"" );
text.Append( link.LinkTarget.OriginalString );
text.Append( "\">" );
text.Append(
StringSegment.IsNullOrEmpty( link.Title )
? link.LinkTarget.OriginalString
: link.Title.ToString() );
text.Append( "</a></li>" );
}
}

if ( rendered )
{
text.Append( "</ul>" );
}
}
}

if ( description.SunsetPolicy is { } sunsetPolicy )
{
if ( sunsetPolicy.Date is { } when )
{
if ( when < DateTime.Now )
{
text.Append( " The API has been sunset on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
}
else
{
text.Append( " The API will be sunset on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
}
}

if ( sunsetPolicy.HasLinks )
{
text.AppendLine();

var rendered = false;

foreach ( var link in sunsetPolicy.Links )
{
if ( link.Type == "text/html" )
{
if ( !rendered )
Expand Down
75 changes: 67 additions & 8 deletions examples/AspNetCore/OData/SomeODataOpenApiExample/ConfigureSwaggerOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,25 +50,84 @@ private static OpenApiInfo CreateInfoForApiVersion( ApiVersionDescription descri
text.Append( " This API version has been deprecated." );
}

if ( description.SunsetPolicy is { } policy )
if ( description.DeprecationPolicy is { } deprecationPolicy )
{
if ( policy.Date is { } when )
if ( deprecationPolicy.Date is { } when )
{
text.Append( " The API will be sunset on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
if ( when < DateTime.Now )
{
text.Append( " The API has been deprecated on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
}
else
{
text.Append( " The API will be deprecated on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
}
}

if ( policy.HasLinks )
if ( deprecationPolicy.HasLinks )
{
text.AppendLine();

var rendered = false;

for ( var i = 0; i < policy.Links.Count; i++ )
foreach ( var link in deprecationPolicy.Links )
{
var link = policy.Links[i];
if ( link.Type == "text/html" )
{
if ( !rendered )
{
text.Append( "<h4>Links</h4><ul>" );
rendered = true;
}

text.Append( "<li><a href=\"" );
text.Append( link.LinkTarget.OriginalString );
text.Append( "\">" );
text.Append(
StringSegment.IsNullOrEmpty( link.Title )
? link.LinkTarget.OriginalString
: link.Title.ToString() );
text.Append( "</a></li>" );
}
}

if ( rendered )
{
text.Append( "</ul>" );
}
}
}

if ( description.SunsetPolicy is { } sunsetPolicy )
{
if ( sunsetPolicy.Date is { } when )
{
if ( when < DateTime.Now )
{
text.Append( " The API has been sunset on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
}
else
{
text.Append( " The API will be sunset on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
}
}

if ( sunsetPolicy.HasLinks )
{
text.AppendLine();

var rendered = false;

foreach ( var link in sunsetPolicy.Links )
{
if ( link.Type == "text/html" )
{
if ( !rendered )
Expand Down
75 changes: 67 additions & 8 deletions examples/AspNetCore/WebApi/MinimalOpenApiExample/ConfigureSwaggerOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,25 +50,84 @@ private static OpenApiInfo CreateInfoForApiVersion( ApiVersionDescription descri
text.Append( " This API version has been deprecated." );
}

if ( description.SunsetPolicy is { } policy )
if ( description.DeprecationPolicy is { } deprecationPolicy )
{
if ( policy.Date is { } when )
if ( deprecationPolicy.Date is { } when )
{
text.Append( " The API will be sunset on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
if ( when < DateTime.Now )
{
text.Append( " The API has been deprecated on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
}
else
{
text.Append( " The API will be deprecated on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
}
}

if ( policy.HasLinks )
if ( deprecationPolicy.HasLinks )
{
text.AppendLine();

var rendered = false;

for ( var i = 0; i < policy.Links.Count; i++ )
foreach ( var link in deprecationPolicy.Links )
{
var link = policy.Links[i];
if ( link.Type == "text/html" )
{
if ( !rendered )
{
text.Append( "<h4>Links</h4><ul>" );
rendered = true;
}

text.Append( "<li><a href=\"" );
text.Append( link.LinkTarget.OriginalString );
text.Append( "\">" );
text.Append(
StringSegment.IsNullOrEmpty( link.Title )
? link.LinkTarget.OriginalString
: link.Title.ToString() );
text.Append( "</a></li>" );
}
}

if ( rendered )
{
text.Append( "</ul>" );
}
}
}

if ( description.SunsetPolicy is { } sunsetPolicy )
{
if ( sunsetPolicy.Date is { } when )
{
if ( when < DateTime.Now )
{
text.Append( " The API has been sunset on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
}
else
{
text.Append( " The API will be sunset on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
}
}

if ( sunsetPolicy.HasLinks )
{
text.AppendLine();

var rendered = false;

foreach ( var link in sunsetPolicy.Links )
{
if ( link.Type == "text/html" )
{
if ( !rendered )
Expand Down
75 changes: 67 additions & 8 deletions examples/AspNetCore/WebApi/OpenApiExample/ConfigureSwaggerOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,25 +50,84 @@ private static OpenApiInfo CreateInfoForApiVersion( ApiVersionDescription descri
text.Append( " This API version has been deprecated." );
}

if ( description.SunsetPolicy is { } policy )
if ( description.DeprecationPolicy is { } deprecationPolicy )
{
if ( policy.Date is { } when )
if ( deprecationPolicy.Date is { } when )
{
text.Append( " The API will be sunset on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
if ( when < DateTime.Now )
{
text.Append( " The API has been deprecated on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
}
else
{
text.Append( " The API will be deprecated on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
}
}

if ( policy.HasLinks )
if ( deprecationPolicy.HasLinks )
{
text.AppendLine();

var rendered = false;

for ( var i = 0; i < policy.Links.Count; i++ )
foreach ( var link in deprecationPolicy.Links )
{
var link = policy.Links[i];
if ( link.Type == "text/html" )
{
if ( !rendered )
{
text.Append( "<h4>Links</h4><ul>" );
rendered = true;
}

text.Append( "<li><a href=\"" );
text.Append( link.LinkTarget.OriginalString );
text.Append( "\">" );
text.Append(
StringSegment.IsNullOrEmpty( link.Title )
? link.LinkTarget.OriginalString
: link.Title.ToString() );
text.Append( "</a></li>" );
}
}

if ( rendered )
{
text.Append( "</ul>" );
}
}
}

if ( description.SunsetPolicy is { } sunsetPolicy )
{
if ( sunsetPolicy.Date is { } when )
{
if ( when < DateTime.Now )
{
text.Append( " The API has been sunset on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
}
else
{
text.Append( " The API will be sunset on " )
.Append( when.Date.ToShortDateString() )
.Append( '.' );
}
}

if ( sunsetPolicy.HasLinks )
{
text.AppendLine();

var rendered = false;

foreach ( var link in sunsetPolicy.Links )
{
if ( link.Type == "text/html" )
{
if ( !rendered )
Expand Down
Loading
Loading