Auto-generated documentation from 977346d

Author: bkoelman

api/JsonApiDotNetCore.Controllers.BaseJsonApiController-2.html

@@ -85,7 +85,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
 
 
   <h1 id="JsonApiDotNetCore_Controllers_JsonApiController_2" data-uid="JsonApiDotNetCore.Controllers.JsonApiController`2" class="text-break">
-Class JsonApiController&lt;TResource, TId&gt;  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L20"><i class="bi bi-code-slash"></i></a>
+Class JsonApiController&lt;TResource, TId&gt;  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L21"><i class="bi bi-code-slash"></i></a>
   </h1>
 
   <div class="facts text-secondary">
@@ -728,7 +728,7 @@ <h2 class="section" id="constructors">Constructors
 
   <h3 id="JsonApiDotNetCore_Controllers_JsonApiController_2__ctor_JsonApiDotNetCore_Configuration_IJsonApiOptions_JsonApiDotNetCore_Configuration_IResourceGraph_Microsoft_Extensions_Logging_ILoggerFactory_JsonApiDotNetCore_Services_IGetAllService__0__1__JsonApiDotNetCore_Services_IGetByIdService__0__1__JsonApiDotNetCore_Services_IGetSecondaryService__0__1__JsonApiDotNetCore_Services_IGetRelationshipService__0__1__JsonApiDotNetCore_Services_ICreateService__0__1__JsonApiDotNetCore_Services_IAddToRelationshipService__0__1__JsonApiDotNetCore_Services_IUpdateService__0__1__JsonApiDotNetCore_Services_ISetRelationshipService__0__1__JsonApiDotNetCore_Services_IDeleteService__0__1__JsonApiDotNetCore_Services_IRemoveFromRelationshipService__0__1__" data-uid="JsonApiDotNetCore.Controllers.JsonApiController`2.#ctor(JsonApiDotNetCore.Configuration.IJsonApiOptions,JsonApiDotNetCore.Configuration.IResourceGraph,Microsoft.Extensions.Logging.ILoggerFactory,JsonApiDotNetCore.Services.IGetAllService{`0,`1},JsonApiDotNetCore.Services.IGetByIdService{`0,`1},JsonApiDotNetCore.Services.IGetSecondaryService{`0,`1},JsonApiDotNetCore.Services.IGetRelationshipService{`0,`1},JsonApiDotNetCore.Services.ICreateService{`0,`1},JsonApiDotNetCore.Services.IAddToRelationshipService{`0,`1},JsonApiDotNetCore.Services.IUpdateService{`0,`1},JsonApiDotNetCore.Services.ISetRelationshipService{`0,`1},JsonApiDotNetCore.Services.IDeleteService{`0,`1},JsonApiDotNetCore.Services.IRemoveFromRelationshipService{`0,`1})">
   JsonApiController(IJsonApiOptions, IResourceGraph, ILoggerFactory, IGetAllService&lt;TResource, TId&gt;?, IGetByIdService&lt;TResource, TId&gt;?, IGetSecondaryService&lt;TResource, TId&gt;?, IGetRelationshipService&lt;TResource, TId&gt;?, ICreateService&lt;TResource, TId&gt;?, IAddToRelationshipService&lt;TResource, TId&gt;?, IUpdateService&lt;TResource, TId&gt;?, ISetRelationshipService&lt;TResource, TId&gt;?, IDeleteService&lt;TResource, TId&gt;?, IRemoveFromRelationshipService&lt;TResource, TId&gt;?)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L31"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L32"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Creates an instance from separate services for the various individual read and write methods.</p>
@@ -784,7 +784,7 @@ <h4 class="section">Parameters</h4>
 
   <h3 id="JsonApiDotNetCore_Controllers_JsonApiController_2__ctor_JsonApiDotNetCore_Configuration_IJsonApiOptions_JsonApiDotNetCore_Configuration_IResourceGraph_Microsoft_Extensions_Logging_ILoggerFactory_JsonApiDotNetCore_Services_IResourceService__0__1__" data-uid="JsonApiDotNetCore.Controllers.JsonApiController`2.#ctor(JsonApiDotNetCore.Configuration.IJsonApiOptions,JsonApiDotNetCore.Configuration.IResourceGraph,Microsoft.Extensions.Logging.ILoggerFactory,JsonApiDotNetCore.Services.IResourceService{`0,`1})">
   JsonApiController(IJsonApiOptions, IResourceGraph, ILoggerFactory, IResourceService&lt;TResource, TId&gt;)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L24"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L25"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Creates an instance from a read/write service.</p>
@@ -826,7 +826,7 @@ <h2 class="section" id="methods">Methods
 
   <h3 id="JsonApiDotNetCore_Controllers_JsonApiController_2_DeleteAsync__1_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.JsonApiController`2.DeleteAsync(`1,System.Threading.CancellationToken)">
   DeleteAsync(TId, CancellationToken)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L106"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L109"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Deletes an existing resource. Example: <pre><code class="lang-csharp">DELETE /articles/1 HTTP/1.1</code></pre>
@@ -866,7 +866,7 @@ <h4 class="section">Returns</h4>
 
   <h3 id="JsonApiDotNetCore_Controllers_JsonApiController_2_DeleteRelationshipAsync__1_System_String_System_Collections_Generic_ISet_JsonApiDotNetCore_Resources_IIdentifiable__System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.JsonApiController`2.DeleteRelationshipAsync(`1,System.String,System.Collections.Generic.ISet{JsonApiDotNetCore.Resources.IIdentifiable},System.Threading.CancellationToken)">
   DeleteRelationshipAsync(TId, string, ISet&lt;IIdentifiable&gt;, CancellationToken)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L113"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L116"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Removes resources from a to-many relationship. Example: <pre><code class="lang-csharp">DELETE /articles/1/relationships/revisions HTTP/1.1</code></pre>
@@ -914,7 +914,7 @@ <h4 class="section">Returns</h4>
 
   <h3 id="JsonApiDotNetCore_Controllers_JsonApiController_2_GetAsync_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.JsonApiController`2.GetAsync(System.Threading.CancellationToken)">
   GetAsync(CancellationToken)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L43"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L44"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Gets a collection of primary resources. Example: <pre><code class="lang-csharp">GET /articles HTTP/1.1</code></pre>
@@ -953,7 +953,7 @@ <h4 class="section">Returns</h4>
 
   <h3 id="JsonApiDotNetCore_Controllers_JsonApiController_2_GetAsync__1_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.JsonApiController`2.GetAsync(`1,System.Threading.CancellationToken)">
   GetAsync(TId, CancellationToken)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L51"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L52"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Gets a single primary resource by ID. Example: <pre><code class="lang-csharp">GET /articles/1 HTTP/1.1</code></pre>
@@ -994,7 +994,7 @@ <h4 class="section">Returns</h4>
 
   <h3 id="JsonApiDotNetCore_Controllers_JsonApiController_2_GetRelationshipAsync__1_System_String_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.JsonApiController`2.GetRelationshipAsync(`1,System.String,System.Threading.CancellationToken)">
   GetRelationshipAsync(TId, string, CancellationToken)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L67"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L69"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Gets a relationship value, which can be a <code>null</code>, a single object or a collection. Example:</p>
@@ -1039,7 +1039,7 @@ <h4 class="section">Returns</h4>
 
   <h3 id="JsonApiDotNetCore_Controllers_JsonApiController_2_GetSecondaryAsync__1_System_String_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.JsonApiController`2.GetSecondaryAsync(`1,System.String,System.Threading.CancellationToken)">
   GetSecondaryAsync(TId, string, CancellationToken)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L59"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L60"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Gets a secondary resource or collection of secondary resources. Example: <pre><code class="lang-csharp">GET /articles/1/author HTTP/1.1</code></pre> Example:
@@ -1083,7 +1083,7 @@ <h4 class="section">Returns</h4>
 
   <h3 id="JsonApiDotNetCore_Controllers_JsonApiController_2_PatchAsync__1__0_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.JsonApiController`2.PatchAsync(`1,`0,System.Threading.CancellationToken)">
   PatchAsync(TId, TResource, CancellationToken)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L90"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L93"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Updates the attributes and/or relationships of an existing resource. Only the values of sent attributes are replaced. And only the values of sent
@@ -1126,7 +1126,7 @@ <h4 class="section">Returns</h4>
 
   <h3 id="JsonApiDotNetCore_Controllers_JsonApiController_2_PatchRelationshipAsync__1_System_String_System_Object_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.JsonApiController`2.PatchRelationshipAsync(`1,System.String,System.Object,System.Threading.CancellationToken)">
   PatchRelationshipAsync(TId, string, object?, CancellationToken)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L97"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L100"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Performs a complete replacement of a relationship on an existing resource. Example:</p>
@@ -1176,7 +1176,7 @@ <h4 class="section">Returns</h4>
 
   <h3 id="JsonApiDotNetCore_Controllers_JsonApiController_2_PostAsync__0_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.JsonApiController`2.PostAsync(`0,System.Threading.CancellationToken)">
   PostAsync(TResource, CancellationToken)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L75"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L78"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Creates a new resource with attributes, relationships or both. Example: <pre><code class="lang-csharp">POST /articles HTTP/1.1</code></pre>
@@ -1216,7 +1216,7 @@ <h4 class="section">Returns</h4>
 
   <h3 id="JsonApiDotNetCore_Controllers_JsonApiController_2_PostRelationshipAsync__1_System_String_System_Collections_Generic_ISet_JsonApiDotNetCore_Resources_IIdentifiable__System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.JsonApiController`2.PostRelationshipAsync(`1,System.String,System.Collections.Generic.ISet{JsonApiDotNetCore.Resources.IIdentifiable},System.Threading.CancellationToken)">
   PostRelationshipAsync(TId, string, ISet&lt;IIdentifiable&gt;, CancellationToken)
-  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L82"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L85"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Adds resources to a to-many relationship. Example: <pre><code class="lang-csharp">POST /articles/1/revisions HTTP/1.1</code></pre>
@@ -1264,7 +1264,7 @@ <h4 class="section">Returns</h4>
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L20" class="edit-link">Edit this page</a>
+          <a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L21" class="edit-link">Edit this page</a>
         </div>