ActionDescriptor no longer returns an ApiVersionModel property

[karun-verghese]

ActionDescriptor no longer returns an ApiVersionModel property

[commonsensesoftware]

Things changed a little as was called out in #808 under API Version Model Extensions. I'm observing that a lot of people are not finding this during their migrations so I work on lifting some of that information out into a more formal migration guide.

The old API to new API mapping is:

• GetApiVersionModel(ApiVersionMapping) → GetApiVersionMetadata()
• GetApiVersionModel() → ApiVersionMetadata.Map(ApiVersionMapping.Explicit)
• MappingTo(ApiVersion) → ApiVersionMetadata.MappingTo(ApiVersion)
• IsMappedTo(ApiVersion) → ApiVersionMetadata.IsMappedTo(ApiVersion)

This enables the API to be common for the older ASP.NET Web API stack as well as the ASP.NET Core stack. Action descriptor properties are no longer used so that API Versioning can work for Minimal APIs, which doesn't support them.

GetApiVersionMetadata() is generally the thing you are looking for and you shouldn't have to build your own extension methods to get the properties out. You can obviously create more refined extension methods, but they can build upon what is provided. If you really want to dive down into what these extension methods do, have a look at:

aspnet-api-versioning/src/AspNetCore/WebApi/src/Asp.Versioning.Mvc/Abstractions/ActionDescriptorExtensions.cs

Line 18 in ee996f2

public static ApiVersionMetadata GetApiVersionMetadata( this ActionDescriptor action )

or

aspnet-api-versioning/src/AspNetCore/WebApi/src/Asp.Versioning.Mvc.ApiExplorer/ApiDescriptionExtensions.cs

Line 45 in ee996f2

var metatadata = apiDescription.ActionDescriptor.GetApiVersionMetadata();

I hope that helps.

[karun-verghese]

Thanks a lot! I'll check this out. Yes some documentation on this in the wiki would definitely help