Aspnet-api-versioning: Add odata metadata properties to ODataValue

[crackalak]

Can metadata be added to ODataValue to support using count?

When using the following attribute parameters
[ProducesResponseType( typeof( ODataValue<IEnumerable<Color>> ), Status200OK )]

It currently produces this as the model:

{
    "value": []
}

Instead of what is really returned:

{
    "@odata.context":"http://localhost/$metadata#Collection(NS.Color)",
    "@odata.count": 3,  
    "@odata.nextLink":"http://localhost/Customers(5)/Colors?$count=true&$skip=2",
    "value": []
}

I have tried creating a class for it myself, however, the swagger docs produced then don't have most of the odata parameters like $filter, $orderby etc.

[crackalak]

I provided my own stand-in class, I'll extend ODataValue and see how I get on.

I had a feeling it wouldn't be simple with the number of OData options!

Thanks for responding so quick 😃

[crackalak]

I extended ODataValue but got the same output, with only $select and $expand listed a parameters.

I've had a look through the code and found that it is treating it as a "single result" because is sees that the generic type definition is not ODataValue<T>.

The check could be changed to look at the base type as well if it doesn't match, that way extending ODataValue<T> will work, what do you think @commonsensesoftware ?

https://github.com/microsoft/aspnet-api-versioning/blob/ae108a0bc851b7b8271f34cfba45b31d846978a5/src/Common.OData.ApiExplorer/AspNet.OData/Builder/ODataAttributeVisitor.cs#L106-L117

https://github.com/microsoft/aspnet-api-versioning/blob/8afc8f9ae41a1ff2420f2eb407f802c25ef64ecf/src/Microsoft.AspNetCore.OData.Versioning.ApiExplorer/AspNet.OData/Builder/ODataValidationSettingsConvention.cs#L153-L158

https://github.com/microsoft/aspnet-api-versioning/blob/8afc8f9ae41a1ff2420f2eb407f802c25ef64ecf/src/Common.OData.ApiExplorer/AspNet.OData/TypeExtensions.cs#L162-L169

https://github.com/microsoft/aspnet-api-versioning/blob/8afc8f9ae41a1ff2420f2eb407f802c25ef64ecf/src/Common.OData.ApiExplorer/AspNet.OData/TypeExtensions.cs#L299-L301

[crackalak]

Extending ODataValue also affects the response model, it ignores changes to the entity type configuration so something like order.Ignore(o => o.Description); does nothing and the Description property is still listed in the model shown in the swagger doc.

[crackalak]

No, I'm returning IQueryable<T>. Here's what I have:

[ODataRoute]
[ProducesResponseType(typeof(ODataValueWithCount<IEnumerable<CustomerOutputModel>>), Status200OK)]
[EnableQuery(AllowedQueryOptions = Select | Skip | Top | Count | OrderBy | Filter, 
                AllowedOrderByProperties = "accountNumber,company")]
public IQueryable<CustomerOutputModel> Get()
{
    var customers = _customerService.GetCustomers();
    return customers;
}

public class ODataValueWithCount<T> : ODataValue<T>
{
    [JsonProperty("@odata.context")]
    public string ODataContext { get; set; }
    [JsonProperty("@odata.count")]
    public int ODataCount { get; set; }
    [JsonProperty("@odata.nextLink")]
    public string ODataNextLink { get; set; }
}

public void Apply(ODataModelBuilder builder, ApiVersion apiVersion)
{
    var account = builder.EntitySet<CustomerOutputModel>("Customers").EntityType;

    account.Ignore(p => p.AccountIndex);
    account.HasKey(k => new { k.AccountNumber });
}

And this is how swagger looks:

[crackalak]

@commonsensesoftware Have you got everything you need on this or can I help further?