/// <summary>
/// Merges API version information from the specified attributes with the current conventions.
/// </summary>
/// <param name="attributes">The <see cref="IEnumerable{T}">sequence</see> of attributes to merge.</param>
protected virtual void MergeAttributesWithConventions(IEnumerable <object> attributes)
{
if (VersionNeutral |= attributes.OfType <IApiVersionNeutral>().Any())
{
return;
}
const ApiVersionProviderOptions DeprecatedAdvertised = Deprecated | Advertised;
var providers = attributes.OfType <IApiVersionProvider>();
foreach (var provider in providers)
{
switch (provider.Options)
{
case None:
SupportedVersions.UnionWith(provider.Versions);
break;
case Deprecated:
DeprecatedVersions.UnionWith(provider.Versions);
break;
case Advertised:
AdvertisedVersions.UnionWith(provider.Versions);
break;
case DeprecatedAdvertised:
DeprecatedAdvertisedVersions.UnionWith(provider.Versions);
break;
}
}
}
/// <summary>
/// Indicates that the specified API version is advertised by the configured action.
/// </summary>
/// <param name="apiVersion">The advertised <see cref="ApiVersion">API version</see> not directly implemented by the action.</param>
/// <returns>The original <see cref="ActionApiVersionConventionBuilder"/>.</returns>
public virtual ActionApiVersionConventionBuilder AdvertisesApiVersion(ApiVersion apiVersion)
{
Arg.NotNull(apiVersion, nameof(apiVersion));
Contract.Ensures(Contract.Result <ActionApiVersionConventionBuilder>() != null);
AdvertisedVersions.Add(apiVersion);
return(this);
}
/// <summary>
/// Merges API version information from the specified attributes with the current conventions.
/// </summary>
/// <param name="attributes">The <see cref="IReadOnlyList{T}">read-only list</see> of attributes to merge.</param>
protected virtual void MergeAttributesWithConventions(IReadOnlyList <object> attributes)
{
if (attributes == null)
{
throw new ArgumentNullException(nameof(attributes));
}
if (VersionNeutral)
{
return;
}
const ApiVersionProviderOptions DeprecatedAdvertised = Deprecated | Advertised;
var supported = default(List <ApiVersion>);
var deprecated = default(List <ApiVersion>);
var advertised = default(List <ApiVersion>);
var deprecatedAdvertised = default(List <ApiVersion>);
for (var i = 0; i < attributes.Count; i++)
{
switch (attributes[i])
{
case IApiVersionNeutral:
VersionNeutral = true;
return;
case IApiVersionProvider provider:
List <ApiVersion> target;
IReadOnlyList <ApiVersion> source;
switch (provider.Options)
{
case None:
target = supported ??= new();
source = provider.Versions;
break;
case Deprecated:
target = deprecated ??= new();
source = provider.Versions;
break;
case Advertised:
target = advertised ??= new();
source = provider.Versions;
break;
case DeprecatedAdvertised:
target = deprecatedAdvertised ??= new();
source = provider.Versions;
break;
default:
continue;
}
for (var j = 0; j < source.Count; j++)
{
target.Add(source[j]);
}
break;
}
}
if (supported is not null && supported.Count > 0)
{
SupportedVersions.UnionWith(supported);
}
if (deprecated is not null && deprecated.Count > 0)
{
DeprecatedVersions.UnionWith(deprecated);
}
if (advertised is not null && advertised.Count > 0)
{
AdvertisedVersions.UnionWith(advertised);
}
if (deprecatedAdvertised is not null && deprecatedAdvertised.Count > 0)
{
DeprecatedAdvertisedVersions.UnionWith(deprecatedAdvertised);
}
}
/// <summary>
/// Indicates that the specified API version is advertised by the configured controller.
/// </summary>
/// <param name="apiVersion">The advertised <see cref="ApiVersion">API version</see> not directly implemented by the controller.</param>
/// <returns>The original <see cref="ControllerApiVersionConventionBuilder"/>.</returns>
public virtual ControllerApiVersionConventionBuilder AdvertisesApiVersion(ApiVersion apiVersion)
{
AdvertisedVersions.Add(apiVersion);
return(this);
}
