Skip to content

Commit 2e0ff4c

Browse files
bkoelmanbkoelman
committed
Auto-generated documentation from 74059a6 
1 parent 4b9023c commit 2e0ff4c

5 files changed

+468
-460
lines changed

‎api/JsonApiDotNetCore.Configuration.ServiceCollectionExtensions.html‎

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

9393

9494
<h1 id="JsonApiDotNetCore_Configuration_ServiceCollectionExtensions" data-uid="JsonApiDotNetCore.Configuration.ServiceCollectionExtensions" class="text-break">
95-
Class ServiceCollectionExtensions <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ServiceCollectionExtensions.cs/#L11"><i class="bi bi-code-slash"></i></a>
95+
Class ServiceCollectionExtensions <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ServiceCollectionExtensions.cs/#L12"><i class="bi bi-code-slash"></i></a>
9696
</h1>
9797

9898
<div class="facts text-secondary">
@@ -160,7 +160,7 @@ <h2 class="section" id="methods">Methods
160160

161161
<h3 id="JsonApiDotNetCore_Configuration_ServiceCollectionExtensions_AddJsonApi_Microsoft_Extensions_DependencyInjection_IServiceCollection_System_Action_JsonApiDotNetCore_Configuration_JsonApiOptions__System_Action_JsonApiDotNetCore_Configuration_ServiceDiscoveryFacade__System_Action_JsonApiDotNetCore_Configuration_ResourceGraphBuilder__Microsoft_Extensions_DependencyInjection_IMvcCoreBuilder_System_Collections_Generic_ICollection_System_Type__" data-uid="JsonApiDotNetCore.Configuration.ServiceCollectionExtensions.AddJsonApi(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{JsonApiDotNetCore.Configuration.JsonApiOptions},System.Action{JsonApiDotNetCore.Configuration.ServiceDiscoveryFacade},System.Action{JsonApiDotNetCore.Configuration.ResourceGraphBuilder},Microsoft.Extensions.DependencyInjection.IMvcCoreBuilder,System.Collections.Generic.ICollection{System.Type})">
162162
AddJsonApi(IServiceCollection, Action&lt;JsonApiOptions&gt;?, Action&lt;ServiceDiscoveryFacade&gt;?, Action&lt;ResourceGraphBuilder&gt;?, IMvcCoreBuilder?, ICollection&lt;Type&gt;?)
163-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ServiceCollectionExtensions.cs/#L20"><i class="bi bi-code-slash"></i></a>
163+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ServiceCollectionExtensions.cs/#L31"><i class="bi bi-code-slash"></i></a>
164164
</h3>
165165

166166
<div class="markdown level1 summary"><p>Configures JsonApiDotNetCore by registering resources manually.</p>
@@ -207,7 +207,7 @@ <h4 class="section">Returns</h4>
207207

208208
<h3 id="JsonApiDotNetCore_Configuration_ServiceCollectionExtensions_AddJsonApi__1_Microsoft_Extensions_DependencyInjection_IServiceCollection_System_Action_JsonApiDotNetCore_Configuration_JsonApiOptions__System_Action_JsonApiDotNetCore_Configuration_ServiceDiscoveryFacade__System_Action_JsonApiDotNetCore_Configuration_ResourceGraphBuilder__Microsoft_Extensions_DependencyInjection_IMvcCoreBuilder_" data-uid="JsonApiDotNetCore.Configuration.ServiceCollectionExtensions.AddJsonApi``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{JsonApiDotNetCore.Configuration.JsonApiOptions},System.Action{JsonApiDotNetCore.Configuration.ServiceDiscoveryFacade},System.Action{JsonApiDotNetCore.Configuration.ResourceGraphBuilder},Microsoft.Extensions.DependencyInjection.IMvcCoreBuilder)">
209209
AddJsonApi&lt;TDbContext&gt;(IServiceCollection, Action&lt;JsonApiOptions&gt;?, Action&lt;ServiceDiscoveryFacade&gt;?, Action&lt;ResourceGraphBuilder&gt;?, IMvcCoreBuilder?)
210-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ServiceCollectionExtensions.cs/#L35"><i class="bi bi-code-slash"></i></a>
210+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ServiceCollectionExtensions.cs/#L20"><i class="bi bi-code-slash"></i></a>
211211
</h3>
212212

213213
<div class="markdown level1 summary"><p>Configures JsonApiDotNetCore by registering resources from an Entity Framework Core model.</p>
@@ -257,7 +257,7 @@ <h4 class="section">Type Parameters</h4>
257257

258258
<h3 id="JsonApiDotNetCore_Configuration_ServiceCollectionExtensions_AddResourceDefinition__1_Microsoft_Extensions_DependencyInjection_IServiceCollection_" data-uid="JsonApiDotNetCore.Configuration.ServiceCollectionExtensions.AddResourceDefinition``1(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
259259
AddResourceDefinition&lt;TResourceDefinition&gt;(IServiceCollection)
260-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ServiceCollectionExtensions.cs/#L86"><i class="bi bi-code-slash"></i></a>
260+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ServiceCollectionExtensions.cs/#L110"><i class="bi bi-code-slash"></i></a>
261261
</h3>
262262

263263
<div class="markdown level1 summary"><p>Adds IoC container registrations for the various JsonApiDotNetCore resource definition interfaces, such as
@@ -300,7 +300,7 @@ <h4 class="section">Type Parameters</h4>
300300

301301
<h3 id="JsonApiDotNetCore_Configuration_ServiceCollectionExtensions_AddResourceRepository__1_Microsoft_Extensions_DependencyInjection_IServiceCollection_" data-uid="JsonApiDotNetCore.Configuration.ServiceCollectionExtensions.AddResourceRepository``1(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
302302
AddResourceRepository&lt;TRepository&gt;(IServiceCollection)
303-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ServiceCollectionExtensions.cs/#L73"><i class="bi bi-code-slash"></i></a>
303+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ServiceCollectionExtensions.cs/#L97"><i class="bi bi-code-slash"></i></a>
304304
</h3>
305305

306306
<div class="markdown level1 summary"><p>Adds IoC container registrations for the various JsonApiDotNetCore resource repository interfaces, such as
@@ -343,7 +343,7 @@ <h4 class="section">Type Parameters</h4>
343343

344344
<h3 id="JsonApiDotNetCore_Configuration_ServiceCollectionExtensions_AddResourceService__1_Microsoft_Extensions_DependencyInjection_IServiceCollection_" data-uid="JsonApiDotNetCore.Configuration.ServiceCollectionExtensions.AddResourceService``1(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
345345
AddResourceService&lt;TService&gt;(IServiceCollection)
346-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ServiceCollectionExtensions.cs/#L60"><i class="bi bi-code-slash"></i></a>
346+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ServiceCollectionExtensions.cs/#L84"><i class="bi bi-code-slash"></i></a>
347347
</h3>
348348

349349
<div class="markdown level1 summary"><p>Adds IoC container registrations for the various JsonApiDotNetCore resource service interfaces, such as <a class="xref" href="JsonApiDotNetCore.Services.IGetAllService-2.html">IGetAllService&lt;TResource, TId&gt;</a>,
@@ -386,7 +386,7 @@ <h4 class="section">Type Parameters</h4>
386386
</article>
387387

388388
<div class="contribution d-print-none">
389-
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ServiceCollectionExtensions.cs/#L11" class="edit-link">Edit this page</a>
389+
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ServiceCollectionExtensions.cs/#L12" class="edit-link">Edit this page</a>
390390
</div>
391391

392392

‎api/JsonApiDotNetCore.Middleware.AsyncConvertEmptyActionResultFilter.html‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta name="viewport" content="width=device-width, initial-scale=1.0">
77
<meta name="title" content="Class AsyncConvertEmptyActionResultFilter ">
88

9-
<meta name="description" content="Converts action result without parameters into action result with null parameter. return NotFound() -&amp;gt; return NotFound(null) This ensures our formatter is invoked, where we&#39;ll build a JSON:API compliant response. For details, see: https://github.com/dotnet/aspnetcore/issues/16969">
9+
<meta name="description" content="Converts action result without parameters into action result with null parameter.">
1010
<link rel="icon" href="../favicon.ico">
1111
<link rel="stylesheet" href="../public/docfx.min.css">
1212
<link rel="stylesheet" href="../public/main.css">
@@ -100,11 +100,7 @@ <h1 id="JsonApiDotNetCore_Middleware_AsyncConvertEmptyActionResultFilter" data-u
100100
<dl><dt>Assembly</dt><dd>JsonApiDotNetCore.dll</dd></dl>
101101
</div>
102102

103-
<div class="markdown summary"><p>Converts action result without parameters into action result with null parameter.
104-
<example>
105-
<pre><code class="lang-csharp">return NotFound() -&gt; return NotFound(null)</code></pre></example>
106-
This ensures our formatter is invoked, where we'll build a JSON:API compliant response. For details, see:
107-
<a href="https://github.com/dotnet/aspnetcore/issues/16969">https://github.com/dotnet/aspnetcore/issues/16969</a></p>
103+
<div class="markdown summary"><p>Converts action result without parameters into action result with null parameter.</p>
108104
</div>
109105
<div class="markdown conceptual"></div>
110106

@@ -160,6 +156,18 @@ <h1 id="JsonApiDotNetCore_Middleware_AsyncConvertEmptyActionResultFilter" data-u
160156

161157

162158

159+
<h2 id="JsonApiDotNetCore_Middleware_AsyncConvertEmptyActionResultFilter_remarks">Remarks</h2>
160+
<div class="markdown level0 remarks"><p>This basically turns calls such as
161+
<code>
162+
return NotFound()
163+
</code>
164+
into
165+
<code>
166+
return NotFound(null)
167+
</code>
168+
, so that our formatter is invoked, where we'll build a JSON:API compliant response. For details, see:
169+
<a href="https://github.com/dotnet/aspnetcore/issues/16969">https://github.com/dotnet/aspnetcore/issues/16969</a></p>
170+
</div>
163171

164172

165173
<h2 class="section" id="methods">Methods

‎api/JsonApiDotNetCore.Middleware.IAsyncConvertEmptyActionResultFilter.html‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta name="viewport" content="width=device-width, initial-scale=1.0">
77
<meta name="title" content="Interface IAsyncConvertEmptyActionResultFilter ">
88

9-
<meta name="description" content="Converts action result without parameters into action result with null parameter. return NotFound() -&amp;gt; return NotFound(null) This ensures our formatter is invoked, where we&#39;ll build a JSON:API compliant response. For details, see: https://github.com/dotnet/aspnetcore/issues/16969">
9+
<meta name="description" content="Converts action result without parameters into action result with null parameter.">
1010
<link rel="icon" href="../favicon.ico">
1111
<link rel="stylesheet" href="../public/docfx.min.css">
1212
<link rel="stylesheet" href="../public/main.css">
@@ -92,19 +92,15 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
9292

9393

9494
<h1 id="JsonApiDotNetCore_Middleware_IAsyncConvertEmptyActionResultFilter" data-uid="JsonApiDotNetCore.Middleware.IAsyncConvertEmptyActionResultFilter" class="text-break">
95-
Interface IAsyncConvertEmptyActionResultFilter <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/IAsyncConvertEmptyActionResultFilter.cs/#L16"><i class="bi bi-code-slash"></i></a>
95+
Interface IAsyncConvertEmptyActionResultFilter <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/IAsyncConvertEmptyActionResultFilter.cs/#L21"><i class="bi bi-code-slash"></i></a>
9696
</h1>
9797

9898
<div class="facts text-secondary">
9999
<dl><dt>Namespace</dt><dd><a class="xref" href="JsonApiDotNetCore.html">JsonApiDotNetCore</a>.<a class="xref" href="JsonApiDotNetCore.Middleware.html">Middleware</a></dd></dl>
100100
<dl><dt>Assembly</dt><dd>JsonApiDotNetCore.dll</dd></dl>
101101
</div>
102102

103-
<div class="markdown summary"><p>Converts action result without parameters into action result with null parameter.
104-
<example>
105-
<pre><code class="lang-csharp">return NotFound() -&gt; return NotFound(null)</code></pre></example>
106-
This ensures our formatter is invoked, where we'll build a JSON:API compliant response. For details, see:
107-
<a href="https://github.com/dotnet/aspnetcore/issues/16969">https://github.com/dotnet/aspnetcore/issues/16969</a></p>
103+
<div class="markdown summary"><p>Converts action result without parameters into action result with null parameter.</p>
108104
</div>
109105
<div class="markdown conceptual"></div>
110106

@@ -130,13 +126,25 @@ <h1 id="JsonApiDotNetCore_Middleware_IAsyncConvertEmptyActionResultFilter" data-
130126

131127

132128

129+
<h2 id="JsonApiDotNetCore_Middleware_IAsyncConvertEmptyActionResultFilter_remarks">Remarks</h2>
130+
<div class="markdown level0 remarks"><p>This basically turns calls such as
131+
<code>
132+
return NotFound()
133+
</code>
134+
into
135+
<code>
136+
return NotFound(null)
137+
</code>
138+
, so that our formatter is invoked, where we'll build a JSON:API compliant response. For details, see:
139+
<a href="https://github.com/dotnet/aspnetcore/issues/16969">https://github.com/dotnet/aspnetcore/issues/16969</a></p>
140+
</div>
133141

134142

135143

136144
</article>
137145

138146
<div class="contribution d-print-none">
139-
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/IAsyncConvertEmptyActionResultFilter.cs/#L16" class="edit-link">Edit this page</a>
147+
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/IAsyncConvertEmptyActionResultFilter.cs/#L21" class="edit-link">Edit this page</a>
140148
</div>
141149

142150

‎api/JsonApiDotNetCore.Middleware.html‎

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,7 @@ <h3 id="classes">
9999
</h3>
100100
<dl class="jumplist">
101101
<dt><a class="xref" href="JsonApiDotNetCore.Middleware.AsyncConvertEmptyActionResultFilter.html">AsyncConvertEmptyActionResultFilter</a></dt>
102-
<dd><p>Converts action result without parameters into action result with null parameter.
103-
<example>
104-
<pre><code class="lang-csharp">return NotFound() -&gt; return NotFound(null)</code></pre></example>
105-
This ensures our formatter is invoked, where we'll build a JSON:API compliant response. For details, see:
106-
<a href="https://github.com/dotnet/aspnetcore/issues/16969">https://github.com/dotnet/aspnetcore/issues/16969</a></p>
102+
<dd><p>Converts action result without parameters into action result with null parameter.</p>
107103
</dd>
108104
</dl>
109105
<dl class="jumplist">
@@ -176,11 +172,7 @@ <h3 id="interfaces">
176172
</h3>
177173
<dl class="jumplist">
178174
<dt><a class="xref" href="JsonApiDotNetCore.Middleware.IAsyncConvertEmptyActionResultFilter.html">IAsyncConvertEmptyActionResultFilter</a></dt>
179-
<dd><p>Converts action result without parameters into action result with null parameter.
180-
<example>
181-
<pre><code class="lang-csharp">return NotFound() -&gt; return NotFound(null)</code></pre></example>
182-
This ensures our formatter is invoked, where we'll build a JSON:API compliant response. For details, see:
183-
<a href="https://github.com/dotnet/aspnetcore/issues/16969">https://github.com/dotnet/aspnetcore/issues/16969</a></p>
175+
<dd><p>Converts action result without parameters into action result with null parameter.</p>
184176
</dd>
185177
</dl>
186178
<dl class="jumplist">

0 commit comments

Comments
 (0)