Skip to content

Commit d273716

Browse files
committed
Auto-generated documentation from bf1b968
1 parent 34f7ced commit d273716

7 files changed

Lines changed: 477 additions & 472 deletions

api/JsonApiDotNetCore.Queries.IQueryLayerComposer.html

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ <h2 class="section" id="methods">Methods
128128

129129
<h3 id="JsonApiDotNetCore_Queries_IQueryLayerComposer_ComposeForGetById__1___0_JsonApiDotNetCore_Configuration_ResourceType_JsonApiDotNetCore_Queries_TopFieldSelection_" data-uid="JsonApiDotNetCore.Queries.IQueryLayerComposer.ComposeForGetById``1(``0,JsonApiDotNetCore.Configuration.ResourceType,JsonApiDotNetCore.Queries.TopFieldSelection)">
130130
ComposeForGetById&lt;TId&gt;(TId, ResourceType, TopFieldSelection)
131-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/IQueryLayerComposer.cs/#L32"><i class="bi bi-code-slash"></i></a>
131+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/IQueryLayerComposer.cs/#L34"><i class="bi bi-code-slash"></i></a>
132132
</h3>
133133

134134
<div class="markdown level1 summary"><p>Collects constraints and builds a <a class="xref" href="JsonApiDotNetCore.Queries.QueryLayer.html">QueryLayer</a> out of them, used to retrieve one resource.</p>
@@ -174,7 +174,7 @@ <h4 class="section">Type Parameters</h4>
174174

175175
<h3 id="JsonApiDotNetCore_Queries_IQueryLayerComposer_ComposeForGetRelationshipRightIds_JsonApiDotNetCore_Resources_Annotations_RelationshipAttribute_System_Collections_Generic_ICollection_JsonApiDotNetCore_Resources_IIdentifiable__" data-uid="JsonApiDotNetCore.Queries.IQueryLayerComposer.ComposeForGetRelationshipRightIds(JsonApiDotNetCore.Resources.Annotations.RelationshipAttribute,System.Collections.Generic.ICollection{JsonApiDotNetCore.Resources.IIdentifiable})">
176176
ComposeForGetRelationshipRightIds(RelationshipAttribute, ICollection&lt;IIdentifiable&gt;)
177-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/IQueryLayerComposer.cs/#L59"><i class="bi bi-code-slash"></i></a>
177+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/IQueryLayerComposer.cs/#L61"><i class="bi bi-code-slash"></i></a>
178178
</h3>
179179

180180
<div class="markdown level1 summary"><p>Builds a query for the specified relationship with a filter to match on its right resource IDs.</p>
@@ -213,7 +213,7 @@ <h4 class="section">Returns</h4>
213213

214214
<h3 id="JsonApiDotNetCore_Queries_IQueryLayerComposer_ComposeForGetTargetedSecondaryResourceIds_JsonApiDotNetCore_Resources_IIdentifiable_" data-uid="JsonApiDotNetCore.Queries.IQueryLayerComposer.ComposeForGetTargetedSecondaryResourceIds(JsonApiDotNetCore.Resources.IIdentifiable)">
215215
ComposeForGetTargetedSecondaryResourceIds(IIdentifiable)
216-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/IQueryLayerComposer.cs/#L54"><i class="bi bi-code-slash"></i></a>
216+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/IQueryLayerComposer.cs/#L56"><i class="bi bi-code-slash"></i></a>
217217
</h3>
218218

219219
<div class="markdown level1 summary"><p>Builds a query for each targeted relationship with a filter to match on its right resource IDs.</p>
@@ -250,7 +250,7 @@ <h4 class="section">Returns</h4>
250250

251251
<h3 id="JsonApiDotNetCore_Queries_IQueryLayerComposer_ComposeForHasMany__1_JsonApiDotNetCore_Resources_Annotations_HasManyAttribute___0_System_Collections_Generic_ICollection_JsonApiDotNetCore_Resources_IIdentifiable__" data-uid="JsonApiDotNetCore.Queries.IQueryLayerComposer.ComposeForHasMany``1(JsonApiDotNetCore.Resources.Annotations.HasManyAttribute,``0,System.Collections.Generic.ICollection{JsonApiDotNetCore.Resources.IIdentifiable})">
252252
ComposeForHasMany&lt;TId&gt;(HasManyAttribute, TId, ICollection&lt;IIdentifiable&gt;)
253-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/IQueryLayerComposer.cs/#L64"><i class="bi bi-code-slash"></i></a>
253+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/IQueryLayerComposer.cs/#L66"><i class="bi bi-code-slash"></i></a>
254254
</h3>
255255

256256
<div class="markdown level1 summary"><p>Builds a query for a to-many relationship with a filter to match on its left and right resource IDs.</p>
@@ -296,7 +296,7 @@ <h4 class="section">Type Parameters</h4>
296296

297297
<h3 id="JsonApiDotNetCore_Queries_IQueryLayerComposer_ComposeForUpdate__1___0_JsonApiDotNetCore_Configuration_ResourceType_" data-uid="JsonApiDotNetCore.Queries.IQueryLayerComposer.ComposeForUpdate``1(``0,JsonApiDotNetCore.Configuration.ResourceType)">
298298
ComposeForUpdate&lt;TId&gt;(TId, ResourceType)
299-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/IQueryLayerComposer.cs/#L49"><i class="bi bi-code-slash"></i></a>
299+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/IQueryLayerComposer.cs/#L51"><i class="bi bi-code-slash"></i></a>
300300
</h3>
301301

302302
<div class="markdown level1 summary"><p>Builds a query that retrieves the primary resource, including all of its attributes and all targeted relationships, during a create/update/delete
@@ -341,7 +341,7 @@ <h4 class="section">Type Parameters</h4>
341341

342342
<h3 id="JsonApiDotNetCore_Queries_IQueryLayerComposer_ComposeFromConstraints_JsonApiDotNetCore_Configuration_ResourceType_" data-uid="JsonApiDotNetCore.Queries.IQueryLayerComposer.ComposeFromConstraints(JsonApiDotNetCore.Configuration.ResourceType)">
343343
ComposeFromConstraints(ResourceType)
344-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/IQueryLayerComposer.cs/#L27"><i class="bi bi-code-slash"></i></a>
344+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/IQueryLayerComposer.cs/#L29"><i class="bi bi-code-slash"></i></a>
345345
</h3>
346346

347347
<div class="markdown level1 summary"><p>Collects constraints and builds a <a class="xref" href="JsonApiDotNetCore.Queries.QueryLayer.html">QueryLayer</a> out of them, used to retrieve the actual resources.</p>
@@ -378,7 +378,7 @@ <h4 class="section">Returns</h4>
378378

379379
<h3 id="JsonApiDotNetCore_Queries_IQueryLayerComposer_ComposeSecondaryLayerForRelationship_JsonApiDotNetCore_Configuration_ResourceType_" data-uid="JsonApiDotNetCore.Queries.IQueryLayerComposer.ComposeSecondaryLayerForRelationship(JsonApiDotNetCore.Configuration.ResourceType)">
380380
ComposeSecondaryLayerForRelationship(ResourceType)
381-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/IQueryLayerComposer.cs/#L37"><i class="bi bi-code-slash"></i></a>
381+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/IQueryLayerComposer.cs/#L39"><i class="bi bi-code-slash"></i></a>
382382
</h3>
383383

384384
<div class="markdown level1 summary"><p>Collects constraints and builds the secondary layer for a relationship endpoint.</p>
@@ -423,7 +423,8 @@ <h3 id="JsonApiDotNetCore_Queries_IQueryLayerComposer_GetPrimaryFilterFromConstr
423423
<div class="markdown level1 conceptual"></div>
424424

425425
<div class="codewrapper">
426-
<pre><code class="lang-csharp hljs">FilterExpression? GetPrimaryFilterFromConstraints(ResourceType primaryResourceType)</code></pre>
426+
<pre><code class="lang-csharp hljs">[Obsolete(&quot;This method is no longer used and will be removed in a future version.&quot;)]
427+
FilterExpression? GetPrimaryFilterFromConstraints(ResourceType primaryResourceType)</code></pre>
427428
</div>
428429

429430
<h4 class="section">Parameters</h4>
@@ -452,7 +453,7 @@ <h4 class="section">Returns</h4>
452453

453454
<h3 id="JsonApiDotNetCore_Queries_IQueryLayerComposer_GetSecondaryFilterFromConstraints__1___0_JsonApiDotNetCore_Resources_Annotations_HasManyAttribute_" data-uid="JsonApiDotNetCore.Queries.IQueryLayerComposer.GetSecondaryFilterFromConstraints``1(``0,JsonApiDotNetCore.Resources.Annotations.HasManyAttribute)">
454455
GetSecondaryFilterFromConstraints&lt;TId&gt;(TId, HasManyAttribute)
455-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/IQueryLayerComposer.cs/#L22"><i class="bi bi-code-slash"></i></a>
456+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/IQueryLayerComposer.cs/#L24"><i class="bi bi-code-slash"></i></a>
456457
</h3>
457458

458459
<div class="markdown level1 summary"><p>Builds a filter from constraints, used to determine total resource count on a secondary collection endpoint.</p>
@@ -496,7 +497,7 @@ <h4 class="section">Type Parameters</h4>
496497

497498
<h3 id="JsonApiDotNetCore_Queries_IQueryLayerComposer_WrapLayerForSecondaryEndpoint__1_JsonApiDotNetCore_Queries_QueryLayer_JsonApiDotNetCore_Configuration_ResourceType___0_JsonApiDotNetCore_Resources_Annotations_RelationshipAttribute_" data-uid="JsonApiDotNetCore.Queries.IQueryLayerComposer.WrapLayerForSecondaryEndpoint``1(JsonApiDotNetCore.Queries.QueryLayer,JsonApiDotNetCore.Configuration.ResourceType,``0,JsonApiDotNetCore.Resources.Annotations.RelationshipAttribute)">
498499
WrapLayerForSecondaryEndpoint&lt;TId&gt;(QueryLayer, ResourceType, TId, RelationshipAttribute)
499-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/IQueryLayerComposer.cs/#L42"><i class="bi bi-code-slash"></i></a>
500+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/IQueryLayerComposer.cs/#L44"><i class="bi bi-code-slash"></i></a>
500501
</h3>
501502

502503
<div class="markdown level1 summary"><p>Wraps a layer for a secondary endpoint into a primary layer, rewriting top-level includes.</p>

0 commit comments

Comments
 (0)