File tree Expand file tree Collapse file tree 1 file changed +7
-4
lines changed
src/JsonApiDotNetCore/Internal Expand file tree Collapse file tree 1 file changed +7
-4
lines changed Original file line number Diff line number Diff line change @@ -18,16 +18,19 @@ public interface IContextGraph
18
18
/// <code>
19
19
/// _graph.GetRelationship(todoItem, nameof(TodoItem.Owner));
20
20
/// </code>
21
+ /// </example>
21
22
/// <remarks>
22
- /// This method will not work with HasManyThrough relationships.
23
- /// You should instead use the <see cref="GetRelationshipValue" /> method instead.
23
+ /// In the case of a `HasManyThrough` relationship, it will not traverse the relationship
24
+ /// and will instead return the value of the shadow property (e.g. Articles.Tags).
25
+ /// If you want to traverse the relationship, you should use <see cref="GetRelationshipValue" />.
24
26
/// </remarks>
25
- /// </example>
26
27
object GetRelationship < TParent > ( TParent resource , string propertyName ) ;
27
28
28
29
/// <summary>
29
- /// Gets the value of the navigation property, defined by the relationshipName,
30
+ /// Gets the value of the navigation property ( defined by the <see cref="RelationshipAttribute" />)
30
31
/// on the provided instance.
32
+ /// In the case of `HasManyThrough` relationships, it will traverse the through entity and return the
33
+ /// value of the relationship on the other side of a join entity (e.g. Articles.ArticleTags.Tag).
31
34
/// </summary>
32
35
/// <param name="resource">The resource instance</param>
33
36
/// <param name="relationship">The attribute used to define the relationship.</param>
You can’t perform that action at this time.
0 commit comments