Task<ActionResult<IQueryable<TPOCO>>> Get(ODataQueryOptions<TPOCO> options)

[vigouredelaruse]

there is a dearth of information on using the subjectline pattern in asp.net core odata controllers.

as per the documentation, ODataQueryOptions.cs can be used to perform query composition
https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.odata.query.odataqueryoptions?view=odata-aspnetcore-8.0

this means query composition can be delegated to

• client developers consuming odata endpoints
• odata httpcontext feature mediated sql generation
• server side auditing of queries and the ability to execute them

obviously this reduces the think time for api developers vis a vis composing entity storage queries

but all this power is hidden behind many barely repeatable google queries

this is to crystallize thoughts around a doc enhancement vis a vis code that looks like this

    public class TPOCOController :
        ODataController
...
        [Microsoft.AspNetCore.OData.Query.EnableQuery]
        public async Task<ActionResult<IQueryable<TPOCO>>> Get(ODataQueryOptions<TPOCO> options)

sometimes you want to dynamically instantiate ODataQueryOptions

it took too long to piece together the following

               // you don't know the power of the weak interaction between domain and infrastructure
               var model = new HorselessOdataModel();
               var edmContent = model.GetContentEDMModel();
               
                // now behold the power of the minimized sql think time by api development teams
                // and the few mentions of a specific entity doing any specific sql query activity
                var queryOptions = new ODataQueryOptions<TPOCO>(
                    new ODataQueryContext(edmContent, typeof(TPOCO),
                    this.HttpContext.ODataFeature().Path), 
                    this.Request);

              // later on you cause the sql generation
              queryOptions.Apply(yourQueryable);

cobbled by looking at

• https://csharp.hotexamples.com/examples/-/ODataQueryContext/-/php-odataquerycontext-class-examples.html
• [feature/netcore] How to unit test with ODataQueryOptions WebApi#1352
• https://github.com/OData/AspNetCoreOData/blob/main/sample/ODataDynamicModel/Controllers/HandleAllController.cs

there may be a working sample like this on learn.microsoft.com by now but if not there should be. there really should be

regards