8000 @odata.context url for navigation property · Issue #691 · OData/AspNetCoreOData · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

@odata.context url for navigation property #691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
danleydmello opened this issue Sep 7, 2022 · 28 comments · Fixed by #975
Closed

@odata.context url for navigation property #691

danleydmello opened this issue Sep 7, 2022 · 28 comments · Fixed by #975
Assignees
@xuzhg @ElizabethOkerio
Labels
bug Something isn't working followup

Comments

@danleydmello
Copy link
Contributor
danleydmello commented Sep 7, 2022 •
edited
Loading

The @odata.context url for the contained entity does not include the key of the entity-set.

e.g http://host/service/Orders(4711)/Item

Expected @odata.contex url in the response should be http://host/service/$metadata#Orders(4711)/Item/$entity

Actual @odata.contex url in the response is http://host/service/$metadata#Orders/Item/$entity //without key

Reference Odata specs http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_Entity

To reproduce the problem,
run ODataDynamicModel Sample application
Run this query http://localhost:4527/odata/mydatasource/Products/1/DetailInfo

In response the key 1 is missing:
{"@odata.context":"http://localhost:4527/odata/mydatasource/$metadata#Products/ns.DetailInfo/$entity","ID":88,"Title":"abc_detailinfo"}
@danleydmello danleydmello added the bug Something isn't working label Sep 7, 2022
@julealgon
Copy link
Contributor

Question: if you change your route to use parenthesis-based keys (i.e. http://localhost:4527/odata/mydatasource/Products(1)/DetailInfo) does this change the result in any way?

@danleydmello
Copy link
Contributor Author

Question: if you change your route to use parenthesis-based keys (i.e. http://localhost:4527/odata/mydatasource/Products(1)/DetailInfo) does this change the result in any way?

@julealgon , no, still same issue.
To reproduce it, I added template for ({key}) in https://github.com/OData/AspNetCoreOData/blob/main/sample/ODataDynamicModel/Extensions/EntitySetWithKeyTemplateSegment.cs

Response I got:
{"@odata.context":"http://localhost:4527/odata/mydatasource/$metadata#Products/ns.DetailInfo/$entity","ID":88,"Title":"abc_detailinfo"}

@mikepizzo
Copy link
Member

Hi @ElizabethOkerio -- it looks like you're oncall this week. This does look like a bug, and I do think we have issues in this area. Can you work with @xuzhg (who is backup) to verify and figure out a fix.

@sfalik
Copy link
sfalik commented Sep 29, 2022

Hi All, i've been working with @danleydmello on this problem -- just wondering if there is any update as this is currently blocking us.

@ElizabethOkerio
Copy link
Contributor

@sfalik yes we have a fix. Hope to get it merged soon.

@danleydmello
Copy link
Contributor Author
danleydmello commented Oct 25, 2022 •
edited
Loading

@ElizabethOkerio, any update on this?

Thanks

@dnperfors
Copy link

@sfalik @ElizabethOkerio, I would love to see an update here as well.

I found out that when you specify the full route template on the controller method, the context is set correctly, so it looks like a problem on the conventional routes.

@sfalik
Copy link
sfalik commented Nov 29, 2022

...I found out that when you specify the full route template on the controller method, the context is set correctly, so it looks like a problem on the conventional routes.

Thanks for the heads up!

@mikepizzo, @ElizabethOkerio any update here would really be appreciated!

@dnperfors
Copy link

@sfalik @ElizabethOkerio, I would love to see an update here as well.

I found out that when you specify the full route template on the controller method, the context is set correctly, so it looks like a problem on the conventional routes.

After some more testing, this workaround doesn't fully work. In my case I had the contained item on a derived type and then the workaround worked, but on the main type, the workaround doesn't work!

@mikepizzo, @ElizabethOkerio any updates yet?

@ElizabethOkerio
Copy link
Contributor

@dnperfors will follow up on this work item this week. Will get back to you.

@danleydmello
Copy link
Contributor Author

@ElizabethOkerio , any update yet?

@ElizabethOkerio
Copy link
Contributor

@xuzhg

@xuzhg xuzhg self-assigned this Jan 11, 2023
@xuzhg xuzhg added the followup label Jan 11, 2023
@dnperfors
Copy link

@xuzhg and @ElizabethOkerio, I will not ask for an update, we probably won't get...
Therefore I will just follow up on this. Because the @odata.context URL is not correctly generated, the (Microsoft) OData client can't handle the response. I don't have the exact error, but this is one of the blocking issues for using this library.

@danleydmello
Copy link
Contributor Author

@dnperfors , same problem we are facing, the PowerBI OData feed fails to handle the response in this situation

@sfalik
Copy link
sfalik commented Jun 5, 2023

@mikepizzo @ElizabethOkerio -- could we get an update on this please? This issue is still blocking us.

@dnperfors
Copy link

This is one of the reasons we decided not to use this library at all. Of course there are multiple others, including the lack of documentation and communication.

@mikepizzo mikepizzo mentioned this issue Jun 7, 2023
Open
@ElizabethOkerio
Copy link
Contributor
ElizabethOkerio commented Jun 7, 2023 •
edited
Loading

@sfalik @dnperfors Sorry this has taken some time to resolve. We've prioritized it and we are currently working on a solution for it. Thanks.

@ElizabethOkerio
Copy link
Contributor
ElizabethOkerio commented Jun 12, 2023 •
edited
Loading

Just a quick one: Looking at the csdl from the ODataDynamicModel,

<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
<edmx:DataServices>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ns">
<EntityType Name="Product">
<Key>
<PropertyRef Name="ID"/>
</Key>
<Property Name="Name" Type="Edm.String"/>
<Property Name="ID" Type="Edm.Int32"/>
<NavigationProperty Name="DetailInfo" Type="ns.DetailInfo" Nullable="false"/>
</EntityType>
<EntityType Name="DetailInfo">
<Key>
<PropertyRef Name="ID"/>
</Key>
<Property Name="ID" Type="Edm.Int32"/>
<Property Name="Title" Type="Edm.String"/>
</EntityType>
<EntityContainer Name="container">
<EntitySet Name="Products" EntityType="ns.Product">
<NavigationPropertyBinding Path="DetailInfo" Target="DetailInfos"/>
</EntitySet>
<EntitySet Name="DetailInfos" EntityType="ns.Product"/>
</EntityContainer>
</Schema>
</edmx:DataServices>
</edmx:Edmx>

DetailInfo is not a contained navigation property. If it were, it could have the ContainsTarget attribute set to True. Another thing I'm picking from the CSDL is that the entityset DetailInfos is assigned ns.Product entity type which it shouldn't. It should be assigned the ns.DetailInfos entity type.

We are still looking into this issue but the way this project has been set-up could be the cause of the issues with the context URL not being set appropriately.

@ElizabethOkerio
Copy link
Contributor
ElizabethOkerio commented Jun 12, 2023 •
edited
Loading

This is what have done to try and repro the issue.

Model classes:

 public class Account
    {
        public int AccountID { get; set; }
        public string Name { get; set; }
        [Contained]
        public IList<PaymentInstrument> PayinPIs { get; set; }
    }

    public class PaymentInstrument
    {
        public int PaymentInstrumentID { get; set; }
        public string FriendlyName { get; set; }
    }

Controller

        // GET ~/Accounts(100)/PayinPIs         
        [EnableQuery]
        public IActionResult GetPayinPIs(int key)
        {
            var payinPIs = _accounts.Single(a => a.AccountID == key).PayinPIs;
            return Ok(payinPIs);
        }

Request:

https://localhost:7098/odata/Accounts(100)/PayinPIs

Response:

{
    "@odata.context": "https://localhost:7098/odata/$metadata#Accounts(100)/PayinPIs",
    "value": [
        {
            "PaymentInstrumentID": 101,
            "FriendlyName": "101 first PI"
        },
        {
            "PaymentInstrumentID": 102,
            "FriendlyName": "102 second PI"
        }
    ]
}

@ElizabethOkerio
Copy link
Contributor

The response seems to be Ok. Could you please share your repro? Are you using a dynamic model?

@dnperfors
Copy link

I see you are using a collection, the issue talks about a reference to a single type...

@ElizabethOkerio
Copy link
Contributor
ElizabethOkerio commented Jun 12, 2023 •
edited
Loading

@dnperfors I've updated my model to look like this:

    public class Account
    {
        public int AccountID { get; set; }
        public string Name { get; set; }

        [Contained]
        public PaymentInstrument PayinPI { get; set; }
    }

Controller

        // GET ~/Accounts(100)/PayinPI        
        [EnableQuery]
        public IActionResult GetPayinPI(int key)
        {
            var payinPIs = _accounts.Single(a => a.AccountID == key).PayinPI;
            return Ok(payinPIs);
        }

Request
https://localhost:7098/odata/Accounts(100)/PayinPI

Response

{
    "@odata.context": "https://localhost:7098/odata/$metadata#Accounts(100)/PayinPI/$entity",
    "PaymentInstrumentID": 101,
    "FriendlyName": "101 first PI"
}

@danleydmello
Copy link
Contributor Author

The response seems to be Ok. Could you please share your repro? Are you using a dynamic model?

Thanks, @ElizabethOkerio for trying this out. Our code is in Azure DevOps repo so can't be shared easily,.
Yes, we are using the dynamic model. We used ODataDynamicModel as an example to build our OData service.

You pointed out that there is an issue with the DetailInfo EDM in ODataDynamicModel. Have you tried fixing this issue and running ODataDynamicModel example to test if it produce the correct odata context url?

Thanks

@ElizabethOkerio
Copy link
Contributor

Yes looking into this.

@ElizabethOkerio ElizabethOkerio mentioned this issue Jun 29, 2023
Merged
@gathogojr gathogojr linked a pull request Jun 29, 2023 that will close this issue
update dynamic sample #975
Merged
@ElizabethOkerio
Copy link
Contributor

@danleydmello can you make updates as per this #975 and let us know whether you get the right context URL.

@danleydmello
Copy link
Contributor Author

@ElizabethOkerio , Thanks for the update. I took your branch and ran the test using the ODataDynamicModel sample.
Query: http://localhost:4527/odata/mydatasource/Products/1/DetailInfo
Response:
{
"@odata.context": "http://localhost:4527/odata/mydatasource/$metadata#DetailInfos/$entity",
"ID": 88,
"Title": "abc_detailinfo"
}

Maybe it is correct, but I am not sure. I was expecting something like this:
{
"@odata.context": "http://localhost:4527/odata/mydatasource/$metadata#Products(1)/DetailInfos/$entity",
"ID": 88,
"Title": "abc_detailinfo"
}

I am using the OData specs reference to validate the response for this query:
http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_Entity

Thanks

@ElizabethOkerio
Copy link
Contributor
ElizabethOkerio commented Jul 6, 2023 •
edited
Loading

@danleydmello DetailInfo is not a contained navigation property..I added another property ContainedDetailInfo that is contained.. If you run this:

http://localhost:4527/odata/mydatasource/Products/1/ContainedDetailInfo

This will return this:

{
"@odata.context": "http://localhost:4527/odata/mydatasource/$metadata#Products(1)/ContainedDetailInfo/$entity",
"ID": 88,
"Title": "abc_containeddetailinfo"
}

@danleydmello
Copy link
Contributor Author

Ok, it works for containment navigation property, But what about simple navigation property with navigationproprtybinding e.g DetailInfo? Its not clear from OData specs whats the context url should be.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@xuzhg xuzhg

@ElizabethOkerio ElizabethOkerio

Labels
bug Something isn't working followup
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

update dynamic sample ElizabethOkerio/AspNetCoreOData
7 participants
@dnperfors @julealgon @mikepizzo @xuzhg @danleydmello @sfalik @ElizabethOkerio
0