You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
/// Configures which links to show in the <see cref="Serialization.Objects.TopLevelLinks" /> object for this resource type. Defaults to
52
-
/// <see cref="LinkTypes.NotConfigured" />, which falls back to <see cref="IJsonApiOptions.TopLevelLinks" />.
51
+
/// Configures which links to write in the top-level links object for this resource type. Defaults to <see cref="LinkTypes.NotConfigured" />, which falls
52
+
/// back to TopLevelLinks in global options.
53
53
/// </summary>
54
54
/// <remarks>
55
55
/// In the process of building the resource graph, this value is set based on <see cref="ResourceLinksAttribute.TopLevelLinks" /> usage.
56
56
/// </remarks>
57
57
publicLinkTypesTopLevelLinks{get;}
58
58
59
59
/// <summary>
60
-
/// Configures which links to show in the <see cref="Serialization.Objects.ResourceLinks" /> object for this resource type. Defaults to
61
-
/// <see cref="LinkTypes.NotConfigured" />, which falls back to <see cref="IJsonApiOptions.ResourceLinks" />.
60
+
/// Configures which links to write in the resource-level links object for this resource type. Defaults to <see cref="LinkTypes.NotConfigured" />, which
61
+
/// falls back to ResourceLinks in global options.
62
62
/// </summary>
63
63
/// <remarks>
64
64
/// In the process of building the resource graph, this value is set based on <see cref="ResourceLinksAttribute.ResourceLinks" /> usage.
65
65
/// </remarks>
66
66
publicLinkTypesResourceLinks{get;}
67
67
68
68
/// <summary>
69
-
/// Configures which links to show in the <see cref="Serialization.Objects.RelationshipLinks" /> object for all relationships of this resource type.
70
-
/// Defaults to <see cref="LinkTypes.NotConfigured" />, which falls back to <see cref="IJsonApiOptions.RelationshipLinks" />. This can be overruled per
71
-
/// relationship by setting <see cref="RelationshipAttribute.Links" />.
69
+
/// Configures which links to write in the relationship-level links object for all relationships of this resource type. Defaults to
70
+
/// <see cref="LinkTypes.NotConfigured" />, which falls back to RelationshipLinks in global options. This can be overruled per relationship by setting
71
+
/// <see cref="RelationshipAttribute.Links" />.
72
72
/// </summary>
73
73
/// <remarks>
74
74
/// In the process of building the resource graph, this value is set based on <see cref="ResourceLinksAttribute.RelationshipLinks" /> usage.
/// Configures which links to show in the <see cref="Serialization.Objects.TopLevelLinks" /> object for this resource type. Defaults to
14
-
/// <see cref="LinkTypes.NotConfigured" />, which falls back to <see cref="IJsonApiOptions.TopLevelLinks" />.
13
+
/// Configures which links to write in the top-level links object for this resource type. Defaults to <see cref="LinkTypes.NotConfigured" />, which falls
/// Configures which links to show in the <see cref="Serialization.Objects.ResourceLinks" /> object for this resource type. Defaults to
20
-
/// <see cref="LinkTypes.NotConfigured" />, which falls back to <see cref="IJsonApiOptions.ResourceLinks" />.
19
+
/// Configures which links to write in the resource-level links object for this resource type. Defaults to <see cref="LinkTypes.NotConfigured" />, which
20
+
/// falls back to ResourceLinks in global options.
/// Configures which links to show in the <see cref="Serialization.Objects.RelationshipLinks" /> object for all relationships of this resource type.
26
-
/// Defaults to <see cref="LinkTypes.NotConfigured" />, which falls back to <see cref="IJsonApiOptions.RelationshipLinks" />. This can be overruled per
27
-
/// relationship by setting <see cref="RelationshipAttribute.Links" />.
25
+
/// Configures which links to write in the relationship-level links object for all relationships of this resource type. Defaults to
26
+
/// <see cref="LinkTypes.NotConfigured" />, which falls back to RelationshipLinks in global options. This can be overruled per relationship by setting
Copy file name to clipboardExpand all lines: src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -63,19 +63,19 @@ public interface IJsonApiOptions
63
63
boolUseRelativeLinks{get;}
64
64
65
65
/// <summary>
66
-
/// Configures which links to show in the <see cref="Serialization.Objects.TopLevelLinks" /> object. Defaults to <see cref="LinkTypes.All" />. This
66
+
/// Configures which links to write in the <see cref="Serialization.Objects.TopLevelLinks" /> object. Defaults to <see cref="LinkTypes.All" />. This
67
67
/// setting can be overruled per resource type by adding <see cref="ResourceLinksAttribute" /> on the class definition of a resource.
68
68
/// </summary>
69
69
LinkTypesTopLevelLinks{get;}
70
70
71
71
/// <summary>
72
-
/// Configures which links to show in the <see cref="Serialization.Objects.ResourceLinks" /> object. Defaults to <see cref="LinkTypes.All" />. This
72
+
/// Configures which links to write in the <see cref="Serialization.Objects.ResourceLinks" /> object. Defaults to <see cref="LinkTypes.All" />. This
73
73
/// setting can be overruled per resource type by adding <see cref="ResourceLinksAttribute" /> on the class definition of a resource.
74
74
/// </summary>
75
75
LinkTypesResourceLinks{get;}
76
76
77
77
/// <summary>
78
-
/// Configures which links to show in the <see cref="Serialization.Objects.RelationshipLinks" /> object. Defaults to <see cref="LinkTypes.All" />. This
78
+
/// Configures which links to write in the <see cref="Serialization.Objects.RelationshipLinks" /> object. Defaults to <see cref="LinkTypes.All" />. This
79
79
/// setting can be overruled for all relationships per resource type by adding <see cref="ResourceLinksAttribute" /> on the class definition of a
80
80
/// resource. This can be further overruled per relationship by setting <see cref="RelationshipAttribute.Links" />.
0 commit comments