Skip to content

Commit f000cb8

Browse files
bkoelmanbkoelman
committed
Auto-generated documentation from 7e864a2 
1 parent 5419f55 commit f000cb8

4 files changed

+38
-38
lines changed

‎api/JsonApiDotNetCore.Controllers.BaseJsonApiController-2.html‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
8787

8888
<h1 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiController`2" class="text-break">
8989
Class BaseJsonApiController&lt;TResource, TId&gt;
90-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L21"><i class="bi bi-code-slash"></i></a>
90+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L20"><i class="bi bi-code-slash"></i></a>
9191
</h1>
9292

9393
<div class="facts text-secondary">
@@ -697,7 +697,7 @@ <h2 class="section" id="constructors">Constructors
697697

698698
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_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.BaseJsonApiController`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})">
699699
BaseJsonApiController(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;?)
700-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L60"><i class="bi bi-code-slash"></i></a>
700+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L59"><i class="bi bi-code-slash"></i></a>
701701
</h3>
702702

703703
<div class="markdown level1 summary"><p>Creates an instance from separate services for the various individual read and write methods.</p>
@@ -753,7 +753,7 @@ <h4 class="section">Parameters</h4>
753753

754754
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2__ctor_JsonApiDotNetCore_Configuration_IJsonApiOptions_JsonApiDotNetCore_Configuration_IResourceGraph_Microsoft_Extensions_Logging_ILoggerFactory_JsonApiDotNetCore_Services_IResourceQueryService__0__1__JsonApiDotNetCore_Services_IResourceCommandService__0__1__" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiController`2.#ctor(JsonApiDotNetCore.Configuration.IJsonApiOptions,JsonApiDotNetCore.Configuration.IResourceGraph,Microsoft.Extensions.Logging.ILoggerFactory,JsonApiDotNetCore.Services.IResourceQueryService{`0,`1},JsonApiDotNetCore.Services.IResourceCommandService{`0,`1})">
755755
BaseJsonApiController(IJsonApiOptions, IResourceGraph, ILoggerFactory, IResourceQueryService&lt;TResource, TId&gt;?, IResourceCommandService&lt;TResource, TId&gt;?)
756-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L50"><i class="bi bi-code-slash"></i></a>
756+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L49"><i class="bi bi-code-slash"></i></a>
757757
</h3>
758758

759759
<div class="markdown level1 summary"><p>Creates an instance from separate services for reading and writing.</p>
@@ -793,7 +793,7 @@ <h4 class="section">Parameters</h4>
793793

794794
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2__ctor_JsonApiDotNetCore_Configuration_IJsonApiOptions_JsonApiDotNetCore_Configuration_IResourceGraph_Microsoft_Extensions_Logging_ILoggerFactory_JsonApiDotNetCore_Services_IResourceService__0__1__" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiController`2.#ctor(JsonApiDotNetCore.Configuration.IJsonApiOptions,JsonApiDotNetCore.Configuration.IResourceGraph,Microsoft.Extensions.Logging.ILoggerFactory,JsonApiDotNetCore.Services.IResourceService{`0,`1})">
795795
BaseJsonApiController(IJsonApiOptions, IResourceGraph, ILoggerFactory, IResourceService&lt;TResource, TId&gt;)
796-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L41"><i class="bi bi-code-slash"></i></a>
796+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L40"><i class="bi bi-code-slash"></i></a>
797797
</h3>
798798

799799
<div class="markdown level1 summary"><p>Creates an instance from a read/write service.</p>
@@ -835,7 +835,7 @@ <h2 class="section" id="methods">Methods
835835

836836
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2_DeleteAsync__1_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiController`2.DeleteAsync(`1,System.Threading.CancellationToken)">
837837
DeleteAsync(TId, CancellationToken)
838-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L341"><i class="bi bi-code-slash"></i></a>
838+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L339"><i class="bi bi-code-slash"></i></a>
839839
</h3>
840840

841841
<div class="markdown level1 summary"><p>Deletes an existing resource. Example: <pre><code class="lang-csharp">DELETE /articles/1 HTTP/1.1</code></pre>
@@ -874,7 +874,7 @@ <h4 class="section">Returns</h4>
874874

875875
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2_DeleteRelationshipAsync__1_System_String_System_Collections_Generic_ISet_JsonApiDotNetCore_Resources_IIdentifiable__System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiController`2.DeleteRelationshipAsync(`1,System.String,System.Collections.Generic.ISet{JsonApiDotNetCore.Resources.IIdentifiable},System.Threading.CancellationToken)">
876876
DeleteRelationshipAsync(TId, string, ISet&lt;IIdentifiable&gt;, CancellationToken)
877-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L375"><i class="bi bi-code-slash"></i></a>
877+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L373"><i class="bi bi-code-slash"></i></a>
878878
</h3>
879879

880880
<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>
@@ -921,7 +921,7 @@ <h4 class="section">Returns</h4>
921921

922922
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2_GetAsync_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiController`2.GetAsync(System.Threading.CancellationToken)">
923923
GetAsync(CancellationToken)
924-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L91"><i class="bi bi-code-slash"></i></a>
924+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L90"><i class="bi bi-code-slash"></i></a>
925925
</h3>
926926

927927
<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>
@@ -958,7 +958,7 @@ <h4 class="section">Returns</h4>
958958

959959
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2_GetAsync__1_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiController`2.GetAsync(`1,System.Threading.CancellationToken)">
960960
GetAsync(TId, CancellationToken)
961-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L110"><i class="bi bi-code-slash"></i></a>
961+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L109"><i class="bi bi-code-slash"></i></a>
962962
</h3>
963963

964964
<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>
@@ -997,7 +997,7 @@ <h4 class="section">Returns</h4>
997997

998998
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2_GetRelationshipAsync__1_System_String_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiController`2.GetRelationshipAsync(`1,System.String,System.Threading.CancellationToken)">
999999
GetRelationshipAsync(TId, string, CancellationToken)
1000-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L164"><i class="bi bi-code-slash"></i></a>
1000+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L163"><i class="bi bi-code-slash"></i></a>
10011001
</h3>
10021002

10031003
<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>
@@ -1040,7 +1040,7 @@ <h4 class="section">Returns</h4>
10401040

10411041
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2_GetSecondaryAsync__1_System_String_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiController`2.GetSecondaryAsync(`1,System.String,System.Threading.CancellationToken)">
10421042
GetSecondaryAsync(TId, string, CancellationToken)
1043-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L135"><i class="bi bi-code-slash"></i></a>
1043+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L134"><i class="bi bi-code-slash"></i></a>
10441044
</h3>
10451045

10461046
<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:
@@ -1082,7 +1082,7 @@ <h4 class="section">Returns</h4>
10821082

10831083
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2_PatchAsync__1__0_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiController`2.PatchAsync(`1,`0,System.Threading.CancellationToken)">
10841084
PatchAsync(TId, TResource, CancellationToken)
1085-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L268"><i class="bi bi-code-slash"></i></a>
1085+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L267"><i class="bi bi-code-slash"></i></a>
10861086
</h3>
10871087

10881088
<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
@@ -1124,7 +1124,7 @@ <h4 class="section">Returns</h4>
11241124

11251125
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2_PatchRelationshipAsync__1_System_String_System_Object_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiController`2.PatchRelationshipAsync(`1,System.String,System.Object,System.Threading.CancellationToken)">
11261126
PatchRelationshipAsync(TId, string, object?, CancellationToken)
1127-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L314"><i class="bi bi-code-slash"></i></a>
1127+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L313"><i class="bi bi-code-slash"></i></a>
11281128
</h3>
11291129

11301130
<div class="markdown level1 summary"><p>Performs a complete replacement of a relationship on an existing resource. Example:</p>
@@ -1173,7 +1173,7 @@ <h4 class="section">Returns</h4>
11731173

11741174
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2_PostAsync__0_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiController`2.PostAsync(`0,System.Threading.CancellationToken)">
11751175
PostAsync(TResource, CancellationToken)
1176-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L189"><i class="bi bi-code-slash"></i></a>
1176+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L188"><i class="bi bi-code-slash"></i></a>
11771177
</h3>
11781178

11791179
<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>
@@ -1212,7 +1212,7 @@ <h4 class="section">Returns</h4>
12121212

12131213
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2_PostRelationshipAsync__1_System_String_System_Collections_Generic_ISet_JsonApiDotNetCore_Resources_IIdentifiable__System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiController`2.PostRelationshipAsync(`1,System.String,System.Collections.Generic.ISet{JsonApiDotNetCore.Resources.IIdentifiable},System.Threading.CancellationToken)">
12141214
PostRelationshipAsync(TId, string, ISet&lt;IIdentifiable&gt;, CancellationToken)
1215-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L239"><i class="bi bi-code-slash"></i></a>
1215+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L238"><i class="bi bi-code-slash"></i></a>
12161216
</h3>
12171217

12181218
<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>
@@ -1259,7 +1259,7 @@ <h4 class="section">Returns</h4>
12591259
</article>
12601260

12611261
<div class="contribution d-print-none">
1262-
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L21" class="edit-link">Edit this page</a>
1262+
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L20" class="edit-link">Edit this page</a>
12631263
</div>
12641264

12651265

0 commit comments

Comments
 (0)