Support Ad Hoc Model Bound Settings

[commonsensesoftware]

Support Ad Hoc Model Bound Settings

• You've read the Contributor Guide and Code of Conduct.
• You've included unit or integration tests for your change, where applicable.
• You've included inline docs for your change, where applicable.
• There's an open issue for the PR that you are making. If you'd like to propose a new feature or change, please open an issue to discuss the change or find an existing issue.

Description

Adds support for OData Model Bound settings using an ad hoc EDM. Developers have the following options:

1. Apply any Model Bound settings via attributes (ex: [Filter("title")])
   a. This is achieved via the ImplicitModelBoundSettingsConvention
   b. In ASP.NET Core, this is wire up automatically via DI
   c. In ASP.NET Web API, it must be added explicitly
2. ODataExplorerOptions now has a public VersionedODataModelBuilder AdHocModelBuilder { get; } property that can be used to:
   a. Configure ad hoc settings
   b. Add conventions specific to ad hoc models

Each convention must be IModelConfiguration. If an implementation needs/wants to participate in the discovery process, it must also implement IODataQueryOptionsConvention, which will be visited for each ApiDescription.

Examples

Assume the following model:

[Filter("title", "published")]
public class Book
{
    public string Id { get; set; }
    public string Title { get; set; }
    public string Author { get; set; }
    public int Published { get; set; }
}

The following configurations will explore the $filter query option and indicated that only title and published are allowed.

ASP.NET Core

The basic scenario works without any additional configuration:

builder.Services.AddApiVersioning().AddODataApiExplorer();

The basic scenario works without any additional configuration:

builder.Services
       .AddApiVersioning()
       .AddODataApiExplorer(
        options =>
        {
            // equivalent to the default, but demonstrates a non-DI method to add conventions
            options.AdHocModelBuilder.ModelConfigurations.Clear();
            options.AdHocModelBuilder.ModelConfigurations.Add( new ImplicitModelBoundSettingsConvention() );
        } );

ASP.NET Web API

configuration.EnableDependencyInjection();
configuration.AddApiVersioning();
configuration.MapHttpAttributeRoutes();
configuration.AddODataApiExplorer(
       options => options.AdHocModelBuilder.ModelConfigurations.Add( new ImplicitModelBoundSettingsConvention() ) );