Skip to content

Commit 528b6dd

Browse files
committed
Auto-generated documentation from 8323836
1 parent ae76f8f commit 528b6dd

14 files changed

+228
-216
lines changed

api/JsonApiDotNetCore.Configuration.IJsonApiOptions.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -424,13 +424,13 @@ <h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_Extensions" data-uid="Js
424424
</h3>
425425

426426
<div class="markdown level1 summary"><p>Lists the JSON:API extensions that are turned on. Empty by default, but if your project contains a controller that derives from
427-
<a class="xref" href="JsonApiDotNetCore.Controllers.BaseJsonApiOperationsController.html">BaseJsonApiOperationsController</a>, the <a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html#JsonApiDotNetCore_Middleware_JsonApiExtension_AtomicOperations">AtomicOperations</a> and
428-
<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html#JsonApiDotNetCore_Middleware_JsonApiExtension_RelaxedAtomicOperations">RelaxedAtomicOperations</a> extensions are automatically added.</p>
427+
<a class="xref" href="JsonApiDotNetCore.Controllers.BaseJsonApiOperationsController.html">BaseJsonApiOperationsController</a>, the <a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension.html#JsonApiDotNetCore_Middleware_JsonApiMediaTypeExtension_AtomicOperations">AtomicOperations</a> and
428+
<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension.html#JsonApiDotNetCore_Middleware_JsonApiMediaTypeExtension_RelaxedAtomicOperations">RelaxedAtomicOperations</a> extensions are automatically added.</p>
429429
</div>
430430
<div class="markdown level1 conceptual"></div>
431431

432432
<div class="codewrapper">
433-
<pre><code class="lang-csharp hljs">IReadOnlySet&lt;JsonApiExtension&gt; Extensions { get; }</code></pre>
433+
<pre><code class="lang-csharp hljs">IReadOnlySet&lt;JsonApiMediaTypeExtension&gt; Extensions { get; }</code></pre>
434434
</div>
435435

436436

@@ -439,7 +439,7 @@ <h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_Extensions" data-uid="Js
439439

440440
<h4 class="section">Property Value</h4>
441441
<dl class="parameters">
442-
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlyset-1">IReadOnlySet</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html">JsonApiExtension</a>&gt;</dt>
442+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlyset-1">IReadOnlySet</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension.html">JsonApiMediaTypeExtension</a>&gt;</dt>
443443
<dd></dd>
444444
</dl>
445445

api/JsonApiDotNetCore.Configuration.JsonApiOptions.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -489,13 +489,13 @@ <h3 id="JsonApiDotNetCore_Configuration_JsonApiOptions_Extensions" data-uid="Jso
489489
</h3>
490490

491491
<div class="markdown level1 summary"><p>Lists the JSON:API extensions that are turned on. Empty by default, but if your project contains a controller that derives from
492-
<a class="xref" href="JsonApiDotNetCore.Controllers.BaseJsonApiOperationsController.html">BaseJsonApiOperationsController</a>, the <a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html#JsonApiDotNetCore_Middleware_JsonApiExtension_AtomicOperations">AtomicOperations</a> and
493-
<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html#JsonApiDotNetCore_Middleware_JsonApiExtension_RelaxedAtomicOperations">RelaxedAtomicOperations</a> extensions are automatically added.</p>
492+
<a class="xref" href="JsonApiDotNetCore.Controllers.BaseJsonApiOperationsController.html">BaseJsonApiOperationsController</a>, the <a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension.html#JsonApiDotNetCore_Middleware_JsonApiMediaTypeExtension_AtomicOperations">AtomicOperations</a> and
493+
<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension.html#JsonApiDotNetCore_Middleware_JsonApiMediaTypeExtension_RelaxedAtomicOperations">RelaxedAtomicOperations</a> extensions are automatically added.</p>
494494
</div>
495495
<div class="markdown level1 conceptual"></div>
496496

497497
<div class="codewrapper">
498-
<pre><code class="lang-csharp hljs">public IReadOnlySet&lt;JsonApiExtension&gt; Extensions { get; set; }</code></pre>
498+
<pre><code class="lang-csharp hljs">public IReadOnlySet&lt;JsonApiMediaTypeExtension&gt; Extensions { get; set; }</code></pre>
499499
</div>
500500

501501

@@ -504,7 +504,7 @@ <h3 id="JsonApiDotNetCore_Configuration_JsonApiOptions_Extensions" data-uid="Jso
504504

505505
<h4 class="section">Property Value</h4>
506506
<dl class="parameters">
507-
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlyset-1">IReadOnlySet</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html">JsonApiExtension</a>&gt;</dt>
507+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlyset-1">IReadOnlySet</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension.html">JsonApiMediaTypeExtension</a>&gt;</dt>
508508
<dd></dd>
509509
</dl>
510510

@@ -1067,8 +1067,8 @@ <h2 class="section" id="methods">Methods
10671067

10681068
<a id="JsonApiDotNetCore_Configuration_JsonApiOptions_IncludeExtensions_" data-uid="JsonApiDotNetCore.Configuration.JsonApiOptions.IncludeExtensions*"></a>
10691069

1070-
<h3 id="JsonApiDotNetCore_Configuration_JsonApiOptions_IncludeExtensions_JsonApiDotNetCore_Middleware_JsonApiExtension___" data-uid="JsonApiDotNetCore.Configuration.JsonApiOptions.IncludeExtensions(JsonApiDotNetCore.Middleware.JsonApiExtension[])">
1071-
IncludeExtensions(params JsonApiExtension[])
1070+
<h3 id="JsonApiDotNetCore_Configuration_JsonApiOptions_IncludeExtensions_JsonApiDotNetCore_Middleware_JsonApiMediaTypeExtension___" data-uid="JsonApiDotNetCore.Configuration.JsonApiOptions.IncludeExtensions(JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension[])">
1071+
IncludeExtensions(params JsonApiMediaTypeExtension[])
10721072
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/JsonApiOptions.cs/#L145"><i class="bi bi-code-slash"></i></a>
10731073
</h3>
10741074

@@ -1077,12 +1077,12 @@ <h3 id="JsonApiDotNetCore_Configuration_JsonApiOptions_IncludeExtensions_JsonApi
10771077
<div class="markdown level1 conceptual"></div>
10781078

10791079
<div class="codewrapper">
1080-
<pre><code class="lang-csharp hljs">public void IncludeExtensions(params JsonApiExtension[] extensionsToAdd)</code></pre>
1080+
<pre><code class="lang-csharp hljs">public void IncludeExtensions(params JsonApiMediaTypeExtension[] extensionsToAdd)</code></pre>
10811081
</div>
10821082

10831083
<h4 class="section">Parameters</h4>
10841084
<dl class="parameters">
1085-
<dt><code>extensionsToAdd</code> <a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html">JsonApiExtension</a>[]</dt>
1085+
<dt><code>extensionsToAdd</code> <a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension.html">JsonApiMediaTypeExtension</a>[]</dt>
10861086
<dd><p>The JSON:API extensions to add.</p>
10871087
</dd>
10881088
</dl>

api/JsonApiDotNetCore.Middleware.IJsonApiContentNegotiator.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,13 +130,13 @@ <h3 id="JsonApiDotNetCore_Middleware_IJsonApiContentNegotiator_Negotiate" data-u
130130
<div class="markdown level1 conceptual"></div>
131131

132132
<div class="codewrapper">
133-
<pre><code class="lang-csharp hljs">IReadOnlySet&lt;JsonApiExtension&gt; Negotiate()</code></pre>
133+
<pre><code class="lang-csharp hljs">IReadOnlySet&lt;JsonApiMediaTypeExtension&gt; Negotiate()</code></pre>
134134
</div>
135135

136136

137137
<h4 class="section">Returns</h4>
138138
<dl class="parameters">
139-
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlyset-1">IReadOnlySet</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html">JsonApiExtension</a>&gt;</dt>
139+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlyset-1">IReadOnlySet</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension.html">JsonApiMediaTypeExtension</a>&gt;</dt>
140140
<dd></dd>
141141
</dl>
142142

api/JsonApiDotNetCore.Middleware.IJsonApiRequest.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ <h3 id="JsonApiDotNetCore_Middleware_IJsonApiRequest_Extensions" data-uid="JsonA
129129
<div class="markdown level1 conceptual"></div>
130130

131131
<div class="codewrapper">
132-
<pre><code class="lang-csharp hljs">IReadOnlySet&lt;JsonApiExtension&gt; Extensions { get; }</code></pre>
132+
<pre><code class="lang-csharp hljs">IReadOnlySet&lt;JsonApiMediaTypeExtension&gt; Extensions { get; }</code></pre>
133133
</div>
134134

135135

@@ -138,7 +138,7 @@ <h3 id="JsonApiDotNetCore_Middleware_IJsonApiRequest_Extensions" data-uid="JsonA
138138

139139
<h4 class="section">Property Value</h4>
140140
<dl class="parameters">
141-
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlyset-1">IReadOnlySet</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html">JsonApiExtension</a>&gt;</dt>
141+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlyset-1">IReadOnlySet</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension.html">JsonApiMediaTypeExtension</a>&gt;</dt>
142142
<dd></dd>
143143
</dl>
144144

api/JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,13 +274,13 @@ <h3 id="JsonApiDotNetCore_Middleware_JsonApiContentNegotiator_Negotiate" data-ui
274274
<div class="markdown level1 conceptual"></div>
275275

276276
<div class="codewrapper">
277-
<pre><code class="lang-csharp hljs">public IReadOnlySet&lt;JsonApiExtension&gt; Negotiate()</code></pre>
277+
<pre><code class="lang-csharp hljs">public IReadOnlySet&lt;JsonApiMediaTypeExtension&gt; Negotiate()</code></pre>
278278
</div>
279279

280280

281281
<h4 class="section">Returns</h4>
282282
<dl class="parameters">
283-
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlyset-1">IReadOnlySet</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html">JsonApiExtension</a>&gt;</dt>
283+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlyset-1">IReadOnlySet</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension.html">JsonApiMediaTypeExtension</a>&gt;</dt>
284284
<dd></dd>
285285
</dl>
286286

api/JsonApiDotNetCore.Middleware.JsonApiMediaType.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -146,21 +146,21 @@ <h2 class="section" id="constructors">Constructors
146146

147147
<a id="JsonApiDotNetCore_Middleware_JsonApiMediaType__ctor_" data-uid="JsonApiDotNetCore.Middleware.JsonApiMediaType.#ctor*"></a>
148148

149-
<h3 id="JsonApiDotNetCore_Middleware_JsonApiMediaType__ctor_System_Collections_Generic_IEnumerable_JsonApiDotNetCore_Middleware_JsonApiExtension__" data-uid="JsonApiDotNetCore.Middleware.JsonApiMediaType.#ctor(System.Collections.Generic.IEnumerable{JsonApiDotNetCore.Middleware.JsonApiExtension})">
150-
JsonApiMediaType(IEnumerable&lt;JsonApiExtension&gt;)
149+
<h3 id="JsonApiDotNetCore_Middleware_JsonApiMediaType__ctor_System_Collections_Generic_IEnumerable_JsonApiDotNetCore_Middleware_JsonApiMediaTypeExtension__" data-uid="JsonApiDotNetCore.Middleware.JsonApiMediaType.#ctor(System.Collections.Generic.IEnumerable{JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension})">
150+
JsonApiMediaType(IEnumerable&lt;JsonApiMediaTypeExtension&gt;)
151151
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/JsonApiMediaType.cs/#L41"><i class="bi bi-code-slash"></i></a>
152152
</h3>
153153

154154
<div class="markdown level1 summary"></div>
155155
<div class="markdown level1 conceptual"></div>
156156

157157
<div class="codewrapper">
158-
<pre><code class="lang-csharp hljs">public JsonApiMediaType(IEnumerable&lt;JsonApiExtension&gt; extensions)</code></pre>
158+
<pre><code class="lang-csharp hljs">public JsonApiMediaType(IEnumerable&lt;JsonApiMediaTypeExtension&gt; extensions)</code></pre>
159159
</div>
160160

161161
<h4 class="section">Parameters</h4>
162162
<dl class="parameters">
163-
<dt><code>extensions</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html">JsonApiExtension</a>&gt;</dt>
163+
<dt><code>extensions</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension.html">JsonApiMediaTypeExtension</a>&gt;</dt>
164164
<dd></dd>
165165
</dl>
166166

@@ -177,21 +177,21 @@ <h4 class="section">Parameters</h4>
177177

178178
<a id="JsonApiDotNetCore_Middleware_JsonApiMediaType__ctor_" data-uid="JsonApiDotNetCore.Middleware.JsonApiMediaType.#ctor*"></a>
179179

180-
<h3 id="JsonApiDotNetCore_Middleware_JsonApiMediaType__ctor_System_Collections_Generic_IReadOnlySet_JsonApiDotNetCore_Middleware_JsonApiExtension__" data-uid="JsonApiDotNetCore.Middleware.JsonApiMediaType.#ctor(System.Collections.Generic.IReadOnlySet{JsonApiDotNetCore.Middleware.JsonApiExtension})">
181-
JsonApiMediaType(IReadOnlySet&lt;JsonApiExtension&gt;)
180+
<h3 id="JsonApiDotNetCore_Middleware_JsonApiMediaType__ctor_System_Collections_Generic_IReadOnlySet_JsonApiDotNetCore_Middleware_JsonApiMediaTypeExtension__" data-uid="JsonApiDotNetCore.Middleware.JsonApiMediaType.#ctor(System.Collections.Generic.IReadOnlySet{JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension})">
181+
JsonApiMediaType(IReadOnlySet&lt;JsonApiMediaTypeExtension&gt;)
182182
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/JsonApiMediaType.cs/#L34"><i class="bi bi-code-slash"></i></a>
183183
</h3>
184184

185185
<div class="markdown level1 summary"></div>
186186
<div class="markdown level1 conceptual"></div>
187187

188188
<div class="codewrapper">
189-
<pre><code class="lang-csharp hljs">public JsonApiMediaType(IReadOnlySet&lt;JsonApiExtension&gt; extensions)</code></pre>
189+
<pre><code class="lang-csharp hljs">public JsonApiMediaType(IReadOnlySet&lt;JsonApiMediaTypeExtension&gt; extensions)</code></pre>
190190
</div>
191191

192192
<h4 class="section">Parameters</h4>
193193
<dl class="parameters">
194-
<dt><code>extensions</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlyset-1">IReadOnlySet</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html">JsonApiExtension</a>&gt;</dt>
194+
<dt><code>extensions</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlyset-1">IReadOnlySet</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension.html">JsonApiMediaTypeExtension</a>&gt;</dt>
195195
<dd></dd>
196196
</dl>
197197

@@ -318,7 +318,7 @@ <h3 id="JsonApiDotNetCore_Middleware_JsonApiMediaType_Extensions" data-uid="Json
318318
<div class="markdown level1 conceptual"></div>
319319

320320
<div class="codewrapper">
321-
<pre><code class="lang-csharp hljs">public IReadOnlySet&lt;JsonApiExtension&gt; Extensions { get; }</code></pre>
321+
<pre><code class="lang-csharp hljs">public IReadOnlySet&lt;JsonApiMediaTypeExtension&gt; Extensions { get; }</code></pre>
322322
</div>
323323

324324

@@ -327,7 +327,7 @@ <h3 id="JsonApiDotNetCore_Middleware_JsonApiMediaType_Extensions" data-uid="Json
327327

328328
<h4 class="section">Property Value</h4>
329329
<dl class="parameters">
330-
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlyset-1">IReadOnlySet</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html">JsonApiExtension</a>&gt;</dt>
330+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlyset-1">IReadOnlySet</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension.html">JsonApiMediaTypeExtension</a>&gt;</dt>
331331
<dd></dd>
332332
</dl>
333333

0 commit comments

Comments
 (0)