Skip to content

Commit 1a1a6b6

Browse files
Chris Martinezcommonsensesoftware
authored andcommitted
Update examples with new IsDeprecated extension method
1 parent 1f2729b commit 1a1a6b6

File tree

4 files changed

+4
-20
lines changed

4 files changed

+4
-20
lines changed

samples/aspnetcore/SwaggerODataSample/SwaggerDefaultValues.cs

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
namespace Microsoft.Examples
22
{
3-
using Microsoft.AspNetCore.Mvc.Abstractions;
43
using Microsoft.AspNetCore.Mvc.ApiExplorer;
54
using Swashbuckle.AspNetCore.Swagger;
65
using Swashbuckle.AspNetCore.SwaggerGen;
76
using System.Linq;
8-
using static Microsoft.AspNetCore.Mvc.Versioning.ApiVersionMapping;
97

108
/// <summary>
119
/// Represents the Swagger/Swashbuckle operation filter used to document the implicit API version parameter.
@@ -22,10 +20,8 @@ public class SwaggerDefaultValues : IOperationFilter
2220
public void Apply( Operation operation, OperationFilterContext context )
2321
{
2422
var apiDescription = context.ApiDescription;
25-
var apiVersion = apiDescription.GetApiVersion();
26-
var model = apiDescription.ActionDescriptor.GetApiVersionModel( Explicit | Implicit );
2723

28-
operation.Deprecated = model.DeprecatedApiVersions.Contains( apiVersion );
24+
operation.Deprecated = apiDescription.IsDeprecated();
2925

3026
if ( operation.Parameters == null )
3127
{

samples/aspnetcore/SwaggerSample/SwaggerDefaultValues.cs

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
namespace Microsoft.Examples
22
{
3-
using Microsoft.AspNetCore.Mvc.Abstractions;
43
using Microsoft.AspNetCore.Mvc.ApiExplorer;
54
using Swashbuckle.AspNetCore.Swagger;
65
using Swashbuckle.AspNetCore.SwaggerGen;
76
using System.Linq;
8-
using static Microsoft.AspNetCore.Mvc.Versioning.ApiVersionMapping;
97

108
/// <summary>
119
/// Represents the Swagger/Swashbuckle operation filter used to document the implicit API version parameter.
@@ -22,10 +20,8 @@ public class SwaggerDefaultValues : IOperationFilter
2220
public void Apply( Operation operation, OperationFilterContext context )
2321
{
2422
var apiDescription = context.ApiDescription;
25-
var apiVersion = apiDescription.GetApiVersion();
26-
var model = apiDescription.ActionDescriptor.GetApiVersionModel( Explicit | Implicit );
2723

28-
operation.Deprecated = model.DeprecatedApiVersions.Contains( apiVersion );
24+
operation.Deprecated = apiDescription.IsDeprecated();
2925

3026
if ( operation.Parameters == null )
3127
{

samples/webapi/SwaggerODataWebApiSample/SwaggerDefaultValues.cs

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
namespace Microsoft.Examples
22
{
3-
using Microsoft.Web.Http.Description;
43
using Swashbuckle.Swagger;
54
using System.Linq;
65
using System.Web.Http.Description;
@@ -20,10 +19,7 @@ public class SwaggerDefaultValues : IOperationFilter
2019
/// <param name="apiDescription">The API description being filtered.</param>
2120
public void Apply( Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription )
2221
{
23-
if ( apiDescription is VersionedApiDescription versionedApiDescription )
24-
{
25-
operation.deprecated = versionedApiDescription.IsDeprecated;
26-
}
22+
operation.deprecated = apiDescription.IsDeprecated();
2723

2824
if ( operation.parameters == null )
2925
{

samples/webapi/SwaggerWebApiSample/SwaggerDefaultValues.cs

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
namespace Microsoft.Examples
22
{
3-
using Microsoft.Web.Http.Description;
43
using Swashbuckle.Swagger;
54
using System.Linq;
65
using System.Web.Http.Description;
@@ -20,10 +19,7 @@ public class SwaggerDefaultValues : IOperationFilter
2019
/// <param name="apiDescription">The API description being filtered.</param>
2120
public void Apply( Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription )
2221
{
23-
if ( apiDescription is VersionedApiDescription versionedApiDescription )
24-
{
25-
operation.deprecated = versionedApiDescription.IsDeprecated;
26-
}
22+
operation.deprecated = apiDescription.IsDeprecated();
2723

2824
if ( operation.parameters == null )
2925
{

0 commit comments

Comments
 (0)