Skip to content

Commit 362e6e6

Browse files
bkoelmanbkoelman
committed
Auto-generated documentation from 980a67d 
1 parent 8cba2ec commit 362e6e6

File tree

2 files changed

+66
-7
lines changed

2 files changed

+66
-7
lines changed

‎api/JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.html

Lines changed: 50 additions & 7 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_Middleware_JsonApiContentNegotiator" data-uid="JsonApiDotNetCore.Middleware.JsonApiContentNegotiator" class="text-break">
88-
Class JsonApiContentNegotiator <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/JsonApiContentNegotiator.cs/#L11"><i class="bi bi-code-slash"></i></a>
88+
Class JsonApiContentNegotiator <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/JsonApiContentNegotiator.cs/#L12"><i class="bi bi-code-slash"></i></a>
8989
</h1>
9090

9191
<div class="facts text-secondary">
@@ -98,7 +98,8 @@ <h1 id="JsonApiDotNetCore_Middleware_JsonApiContentNegotiator" data-uid="JsonApi
9898
<div class="markdown conceptual"></div>
9999

100100
<div class="codewrapper">
101-
<pre><code class="lang-csharp hljs">public class JsonApiContentNegotiator : IJsonApiContentNegotiator</code></pre>
101+
<pre><code class="lang-csharp hljs">[PublicAPI]
102+
public class JsonApiContentNegotiator : IJsonApiContentNegotiator</code></pre>
102103
</div>
103104

104105

@@ -159,7 +160,7 @@ <h2 class="section" id="constructors">Constructors
159160

160161
<h3 id="JsonApiDotNetCore_Middleware_JsonApiContentNegotiator__ctor_JsonApiDotNetCore_Configuration_IJsonApiOptions_Microsoft_AspNetCore_Http_IHttpContextAccessor_" data-uid="JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.#ctor(JsonApiDotNetCore.Configuration.IJsonApiOptions,Microsoft.AspNetCore.Http.IHttpContextAccessor)">
161162
JsonApiContentNegotiator(IJsonApiOptions, IHttpContextAccessor)
162-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/JsonApiContentNegotiator.cs/#L29"><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/Middleware/JsonApiContentNegotiator.cs/#L31"><i class="bi bi-code-slash"></i></a>
163164
</h3>
164165

165166
<div class="markdown level1 summary"></div>
@@ -192,11 +193,53 @@ <h2 class="section" id="methods">Methods
192193
</h2>
193194

194195

196+
<a id="JsonApiDotNetCore_Middleware_JsonApiContentNegotiator_GetDefaultMediaType_" data-uid="JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.GetDefaultMediaType*"></a>
197+
198+
<h3 id="JsonApiDotNetCore_Middleware_JsonApiContentNegotiator_GetDefaultMediaType_System_Collections_Generic_IReadOnlyList_JsonApiDotNetCore_Middleware_JsonApiMediaType__JsonApiDotNetCore_Middleware_JsonApiMediaType_" data-uid="JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.GetDefaultMediaType(System.Collections.Generic.IReadOnlyList{JsonApiDotNetCore.Middleware.JsonApiMediaType},JsonApiDotNetCore.Middleware.JsonApiMediaType)">
199+
GetDefaultMediaType(IReadOnlyList&lt;JsonApiMediaType&gt;, JsonApiMediaType?)
200+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/JsonApiContentNegotiator.cs/#L166"><i class="bi bi-code-slash"></i></a>
201+
</h3>
202+
203+
<div class="markdown level1 summary"><p>Returns the JSON:API media type (possibly including extensions) to use when no Accept header was sent.</p>
204+
</div>
205+
<div class="markdown level1 conceptual"></div>
206+
207+
<div class="codewrapper">
208+
<pre><code class="lang-csharp hljs">protected virtual JsonApiMediaType? GetDefaultMediaType(IReadOnlyList&lt;JsonApiMediaType&gt; possibleMediaTypes, JsonApiMediaType? requestMediaType)</code></pre>
209+
</div>
210+
211+
<h4 class="section">Parameters</h4>
212+
<dl class="parameters">
213+
<dt><code>possibleMediaTypes</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1">IReadOnlyList</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaType.html">JsonApiMediaType</a>&gt;</dt>
214+
<dd><p>The media types returned from <a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.html#JsonApiDotNetCore_Middleware_JsonApiContentNegotiator_GetPossibleMediaTypes">GetPossibleMediaTypes()</a>.</p>
215+
</dd>
216+
<dt><code>requestMediaType</code> <a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaType.html">JsonApiMediaType</a></dt>
217+
<dd><p>The media type from in the Content-Type header.</p>
218+
</dd>
219+
</dl>
220+
221+
<h4 class="section">Returns</h4>
222+
<dl class="parameters">
223+
<dt><a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaType.html">JsonApiMediaType</a></dt>
224+
<dd><p>The default media type to use, or <code>null</code> if not available.</p>
225+
</dd>
226+
</dl>
227+
228+
229+
230+
231+
232+
233+
234+
235+
236+
237+
195238
<a id="JsonApiDotNetCore_Middleware_JsonApiContentNegotiator_GetPossibleMediaTypes_" data-uid="JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.GetPossibleMediaTypes*"></a>
196239

197240
<h3 id="JsonApiDotNetCore_Middleware_JsonApiContentNegotiator_GetPossibleMediaTypes" data-uid="JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.GetPossibleMediaTypes">
198241
GetPossibleMediaTypes()
199-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/JsonApiContentNegotiator.cs/#L161"><i class="bi bi-code-slash"></i></a>
242+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/JsonApiContentNegotiator.cs/#L180"><i class="bi bi-code-slash"></i></a>
200243
</h3>
201244

202245
<div class="markdown level1 summary"><p>Gets the list of possible combinations of JSON:API extensions that are available at the current endpoint. The set of extensions in the request body
@@ -234,7 +277,7 @@ <h4 class="section" id="JsonApiDotNetCore_Middleware_JsonApiContentNegotiator_Ge
234277

235278
<h3 id="JsonApiDotNetCore_Middleware_JsonApiContentNegotiator_IsOperationsEndpoint" data-uid="JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.IsOperationsEndpoint">
236279
IsOperationsEndpoint()
237-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/JsonApiContentNegotiator.cs/#L187"><i class="bi bi-code-slash"></i></a>
280+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/JsonApiContentNegotiator.cs/#L206"><i class="bi bi-code-slash"></i></a>
238281
</h3>
239282

240283
<div class="markdown level1 summary"></div>
@@ -265,7 +308,7 @@ <h4 class="section">Returns</h4>
265308

266309
<h3 id="JsonApiDotNetCore_Middleware_JsonApiContentNegotiator_Negotiate" data-uid="JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.Negotiate">
267310
Negotiate()
268-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/JsonApiContentNegotiator.cs/#L39"><i class="bi bi-code-slash"></i></a>
311+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/JsonApiContentNegotiator.cs/#L41"><i class="bi bi-code-slash"></i></a>
269312
</h3>
270313

271314
<div class="markdown level1 summary"><p>Validates the Content-Type and Accept HTTP headers from the incoming request. Throws a <a class="xref" href="JsonApiDotNetCore.Errors.JsonApiException.html">JsonApiException</a> if unsupported. Otherwise,
@@ -298,7 +341,7 @@ <h4 class="section">Returns</h4>
298341
</article>
299342

300343
<div class="contribution d-print-none">
301-
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/JsonApiContentNegotiator.cs/#L11" class="edit-link">Edit this page</a>
344+
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/JsonApiContentNegotiator.cs/#L12" class="edit-link">Edit this page</a>
302345
</div>
303346

304347

‎xrefmap.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5080,6 +5080,22 @@ references:
50805080
fullName.vb: JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.New
50815081
nameWithType: JsonApiContentNegotiator.JsonApiContentNegotiator
50825082
nameWithType.vb: JsonApiContentNegotiator.New
5083+
- uid: JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.GetDefaultMediaType(System.Collections.Generic.IReadOnlyList{JsonApiDotNetCore.Middleware.JsonApiMediaType},JsonApiDotNetCore.Middleware.JsonApiMediaType)
5084+
name: GetDefaultMediaType(IReadOnlyList<JsonApiMediaType>, JsonApiMediaType?)
5085+
href: api/JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.html#JsonApiDotNetCore_Middleware_JsonApiContentNegotiator_GetDefaultMediaType_System_Collections_Generic_IReadOnlyList_JsonApiDotNetCore_Middleware_JsonApiMediaType__JsonApiDotNetCore_Middleware_JsonApiMediaType_
5086+
commentId: M:JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.GetDefaultMediaType(System.Collections.Generic.IReadOnlyList{JsonApiDotNetCore.Middleware.JsonApiMediaType},JsonApiDotNetCore.Middleware.JsonApiMediaType)
5087+
name.vb: GetDefaultMediaType(IReadOnlyList(Of JsonApiMediaType), JsonApiMediaType)
5088+
fullName: JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.GetDefaultMediaType(System.Collections.Generic.IReadOnlyList<JsonApiDotNetCore.Middleware.JsonApiMediaType>, JsonApiDotNetCore.Middleware.JsonApiMediaType?)
5089+
fullName.vb: JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.GetDefaultMediaType(System.Collections.Generic.IReadOnlyList(Of JsonApiDotNetCore.Middleware.JsonApiMediaType), JsonApiDotNetCore.Middleware.JsonApiMediaType)
5090+
nameWithType: JsonApiContentNegotiator.GetDefaultMediaType(IReadOnlyList<JsonApiMediaType>, JsonApiMediaType?)
5091+
nameWithType.vb: JsonApiContentNegotiator.GetDefaultMediaType(IReadOnlyList(Of JsonApiMediaType), JsonApiMediaType)
5092+
- uid: JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.GetDefaultMediaType*
5093+
name: GetDefaultMediaType
5094+
href: api/JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.html#JsonApiDotNetCore_Middleware_JsonApiContentNegotiator_GetDefaultMediaType_
5095+
commentId: Overload:JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.GetDefaultMediaType
5096+
isSpec: "True"
5097+
fullName: JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.GetDefaultMediaType
5098+
nameWithType: JsonApiContentNegotiator.GetDefaultMediaType
50835099
- uid: JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.GetPossibleMediaTypes
50845100
name: GetPossibleMediaTypes()
50855101
href: api/JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.html#JsonApiDotNetCore_Middleware_JsonApiContentNegotiator_GetPossibleMediaTypes

0 commit comments

Comments
 (0)