Skip to content

Commit bbc17ef

Browse files
bkoelmanbkoelman
committed
Auto-generated documentation from ae5d0d1 
1 parent eccd22d commit bbc17ef

5 files changed

+70
-25
lines changed

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

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

8686

8787
<h1 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiController`2" class="text-break">
88-
Class BaseJsonApiController&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/BaseJsonApiController.cs/#L20"><i class="bi bi-code-slash"></i></a>
88+
Class BaseJsonApiController&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/BaseJsonApiController.cs/#L22"><i class="bi bi-code-slash"></i></a>
8989
</h1>
9090

9191
<div class="facts text-secondary">
@@ -695,7 +695,7 @@ <h2 class="section" id="constructors">Constructors
695695

696696
<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})">
697697
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;?)
698-
<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>
698+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L61"><i class="bi bi-code-slash"></i></a>
699699
</h3>
700700

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

752752
<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})">
753753
BaseJsonApiController(IJsonApiOptions, IResourceGraph, ILoggerFactory, IResourceQueryService&lt;TResource, TId&gt;?, IResourceCommandService&lt;TResource, TId&gt;?)
754-
<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>
754+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L51"><i class="bi bi-code-slash"></i></a>
755755
</h3>
756756

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

792792
<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})">
793793
BaseJsonApiController(IJsonApiOptions, IResourceGraph, ILoggerFactory, IResourceService&lt;TResource, TId&gt;)
794-
<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>
794+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L42"><i class="bi bi-code-slash"></i></a>
795795
</h3>
796796

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

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

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

873873
<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)">
874874
DeleteRelationshipAsync(TId, string, ISet&lt;IIdentifiable&gt;, CancellationToken)
875-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L374"><i class="bi bi-code-slash"></i></a>
875+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L385"><i class="bi bi-code-slash"></i></a>
876876
</h3>
877877

878878
<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>
@@ -919,7 +919,7 @@ <h4 class="section">Returns</h4>
919919

920920
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2_GetAsync_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiController`2.GetAsync(System.Threading.CancellationToken)">
921921
GetAsync(CancellationToken)
922-
<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>
922+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L92"><i class="bi bi-code-slash"></i></a>
923923
</h3>
924924

925925
<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>
@@ -956,7 +956,7 @@ <h4 class="section">Returns</h4>
956956

957957
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2_GetAsync__1_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiController`2.GetAsync(`1,System.Threading.CancellationToken)">
958958
GetAsync(TId, CancellationToken)
959-
<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>
959+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L111"><i class="bi bi-code-slash"></i></a>
960960
</h3>
961961

962962
<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>
@@ -995,7 +995,7 @@ <h4 class="section">Returns</h4>
995995

996996
<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)">
997997
GetRelationshipAsync(TId, string, CancellationToken)
998-
<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>
998+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L165"><i class="bi bi-code-slash"></i></a>
999999
</h3>
10001000

10011001
<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>
@@ -1038,7 +1038,7 @@ <h4 class="section">Returns</h4>
10381038

10391039
<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)">
10401040
GetSecondaryAsync(TId, string, CancellationToken)
1041-
<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>
1041+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L136"><i class="bi bi-code-slash"></i></a>
10421042
</h3>
10431043

10441044
<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:
@@ -1080,7 +1080,7 @@ <h4 class="section">Returns</h4>
10801080

10811081
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2_PatchAsync__1__0_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiController`2.PatchAsync(`1,`0,System.Threading.CancellationToken)">
10821082
PatchAsync(TId, TResource, CancellationToken)
1083-
<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>
1083+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L278"><i class="bi bi-code-slash"></i></a>
10841084
</h3>
10851085

10861086
<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
@@ -1122,7 +1122,7 @@ <h4 class="section">Returns</h4>
11221122

11231123
<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)">
11241124
PatchRelationshipAsync(TId, string, object?, CancellationToken)
1125-
<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>
1125+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L324"><i class="bi bi-code-slash"></i></a>
11261126
</h3>
11271127

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

11721172
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2_PostAsync__0_System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiController`2.PostAsync(`0,System.Threading.CancellationToken)">
11731173
PostAsync(TResource, CancellationToken)
1174-
<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>
1174+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L190"><i class="bi bi-code-slash"></i></a>
11751175
</h3>
11761176

11771177
<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>
@@ -1210,7 +1210,7 @@ <h4 class="section">Returns</h4>
12101210

12111211
<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)">
12121212
PostRelationshipAsync(TId, string, ISet&lt;IIdentifiable&gt;, CancellationToken)
1213-
<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>
1213+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L249"><i class="bi bi-code-slash"></i></a>
12141214
</h3>
12151215

12161216
<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>
@@ -1257,7 +1257,7 @@ <h4 class="section">Returns</h4>
12571257
</article>
12581258

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

12631263

0 commit comments

Comments
 (0)