Deprecate specific route out of multiple routes on single Web API method

Question

Hi I have WEB API implementation as shown below. Where we are using multiple routes on single method.

[SwaggerOperation("Update Records By Id")]
    [Route("/construction/field-record")]
    [Route("/construction/fieldRecord")]
    public async Task<IActionResult> UpdateRecord([FromBody] UpdateRecordRequest request)

Two questions,

1. How to mark only one route out of two as deprecated?
2. How to update swagger indicating that route is "Deprecated" on sawagger UI?

-Thanks

Answer 1

You can add an OperationFilter that checks the RelativePath. This string contains the designation of the route. Just specify the HttpPost/HttpGet-routes

[HttpPost("/construction/field-record")]
[HttpPost("/construction/fieldRecord")]

and then use the following operation filter

public class ExplicitObsoleteRoutes : IOperationFilter
{
    public void Apply(OpenApiOperation operation, OperationFilterContext context)
    {
        if (context.ApiDescription.RelativePath.EndsWith("fieldRecord"))
        {
            operation.Deprecated = true;
        }
    }
}