Auto-generated documentation from 8323836

json-api-dotnet · Nov 12, 2024 · 528b6dd · 528b6dd
1 parent ae76f8f
commit 528b6dd
Show file tree

Hide file tree

Showing 14 changed files with 228 additions and 216 deletions.
diff --git a/api/JsonApiDotNetCore.Configuration.IJsonApiOptions.html b/api/JsonApiDotNetCore.Configuration.IJsonApiOptions.html
@@ -424,13 +424,13 @@ <h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_Extensions" data-uid="Js
   </h3>
 
   <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
-<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
-<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html#JsonApiDotNetCore_Middleware_JsonApiExtension_RelaxedAtomicOperations">RelaxedAtomicOperations</a> extensions are automatically added.</p>
+<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
+<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension.html#JsonApiDotNetCore_Middleware_JsonApiMediaTypeExtension_RelaxedAtomicOperations">RelaxedAtomicOperations</a> extensions are automatically added.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
 
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">IReadOnlySet&lt;JsonApiExtension&gt; Extensions { get; }</code></pre>
+    <pre><code class="lang-csharp hljs">IReadOnlySet&lt;JsonApiMediaTypeExtension&gt; Extensions { get; }</code></pre>
   </div>
 
 
@@ -439,7 +439,7 @@ <h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_Extensions" data-uid="Js
 
   <h4 class="section">Property Value</h4>
   <dl class="parameters">
-    <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>
+    <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>
     <dd></dd>
   </dl>
 

diff --git a/api/JsonApiDotNetCore.Configuration.JsonApiOptions.html b/api/JsonApiDotNetCore.Configuration.JsonApiOptions.html
@@ -489,13 +489,13 @@ <h3 id="JsonApiDotNetCore_Configuration_JsonApiOptions_Extensions" data-uid="Jso
   </h3>
 
   <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
-<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
-<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html#JsonApiDotNetCore_Middleware_JsonApiExtension_RelaxedAtomicOperations">RelaxedAtomicOperations</a> extensions are automatically added.</p>
+<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
+<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension.html#JsonApiDotNetCore_Middleware_JsonApiMediaTypeExtension_RelaxedAtomicOperations">RelaxedAtomicOperations</a> extensions are automatically added.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
 
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public IReadOnlySet&lt;JsonApiExtension&gt; Extensions { get; set; }</code></pre>
+    <pre><code class="lang-csharp hljs">public IReadOnlySet&lt;JsonApiMediaTypeExtension&gt; Extensions { get; set; }</code></pre>
   </div>
 
 
@@ -504,7 +504,7 @@ <h3 id="JsonApiDotNetCore_Configuration_JsonApiOptions_Extensions" data-uid="Jso
 
   <h4 class="section">Property Value</h4>
   <dl class="parameters">
-    <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>
+    <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>
     <dd></dd>
   </dl>
 
@@ -1067,8 +1067,8 @@ <h2 class="section" id="methods">Methods
 
   <a id="JsonApiDotNetCore_Configuration_JsonApiOptions_IncludeExtensions_" data-uid="JsonApiDotNetCore.Configuration.JsonApiOptions.IncludeExtensions*"></a>
 
-  <h3 id="JsonApiDotNetCore_Configuration_JsonApiOptions_IncludeExtensions_JsonApiDotNetCore_Middleware_JsonApiExtension___" data-uid="JsonApiDotNetCore.Configuration.JsonApiOptions.IncludeExtensions(JsonApiDotNetCore.Middleware.JsonApiExtension[])">
-  IncludeExtensions(params JsonApiExtension[])
+  <h3 id="JsonApiDotNetCore_Configuration_JsonApiOptions_IncludeExtensions_JsonApiDotNetCore_Middleware_JsonApiMediaTypeExtension___" data-uid="JsonApiDotNetCore.Configuration.JsonApiOptions.IncludeExtensions(JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension[])">
+  IncludeExtensions(params JsonApiMediaTypeExtension[])
   <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>
   </h3>
 
@@ -1077,12 +1077,12 @@ <h3 id="JsonApiDotNetCore_Configuration_JsonApiOptions_IncludeExtensions_JsonApi
   <div class="markdown level1 conceptual"></div>
 
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public void IncludeExtensions(params JsonApiExtension[] extensionsToAdd)</code></pre>
+    <pre><code class="lang-csharp hljs">public void IncludeExtensions(params JsonApiMediaTypeExtension[] extensionsToAdd)</code></pre>
   </div>
 
   <h4 class="section">Parameters</h4>
   <dl class="parameters">
-    <dt><code>extensionsToAdd</code> <a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html">JsonApiExtension</a>[]</dt>
+    <dt><code>extensionsToAdd</code> <a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiMediaTypeExtension.html">JsonApiMediaTypeExtension</a>[]</dt>
     <dd><p>The JSON:API extensions to add.</p>
 </dd>
   </dl>

diff --git a/api/JsonApiDotNetCore.Middleware.IJsonApiContentNegotiator.html b/api/JsonApiDotNetCore.Middleware.IJsonApiContentNegotiator.html
@@ -130,13 +130,13 @@ <h3 id="JsonApiDotNetCore_Middleware_IJsonApiContentNegotiator_Negotiate" data-u
   <div class="markdown level1 conceptual"></div>
 
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">IReadOnlySet&lt;JsonApiExtension&gt; Negotiate()</code></pre>
+    <pre><code class="lang-csharp hljs">IReadOnlySet&lt;JsonApiMediaTypeExtension&gt; Negotiate()</code></pre>
   </div>
 
 
   <h4 class="section">Returns</h4>
   <dl class="parameters">
-    <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>
+    <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>
     <dd></dd>
   </dl>
 

diff --git a/api/JsonApiDotNetCore.Middleware.IJsonApiRequest.html b/api/JsonApiDotNetCore.Middleware.IJsonApiRequest.html
@@ -129,7 +129,7 @@ <h3 id="JsonApiDotNetCore_Middleware_IJsonApiRequest_Extensions" data-uid="JsonA
   <div class="markdown level1 conceptual"></div>
 
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">IReadOnlySet&lt;JsonApiExtension&gt; Extensions { get; }</code></pre>
+    <pre><code class="lang-csharp hljs">IReadOnlySet&lt;JsonApiMediaTypeExtension&gt; Extensions { get; }</code></pre>
   </div>
 
 
@@ -138,7 +138,7 @@ <h3 id="JsonApiDotNetCore_Middleware_IJsonApiRequest_Extensions" data-uid="JsonA
 
   <h4 class="section">Property Value</h4>
   <dl class="parameters">
-    <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>
+    <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>
     <dd></dd>
   </dl>
 

diff --git a/api/JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.html b/api/JsonApiDotNetCore.Middleware.JsonApiContentNegotiator.html
@@ -274,13 +274,13 @@ <h3 id="JsonApiDotNetCore_Middleware_JsonApiContentNegotiator_Negotiate" data-ui
   <div class="markdown level1 conceptual"></div>
 
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public IReadOnlySet&lt;JsonApiExtension&gt; Negotiate()</code></pre>
+    <pre><code class="lang-csharp hljs">public IReadOnlySet&lt;JsonApiMediaTypeExtension&gt; Negotiate()</code></pre>
   </div>
 
 
   <h4 class="section">Returns</h4>
   <dl class="parameters">
-    <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>
+    <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>
     <dd></dd>
   </dl>
 

diff --git a/api/JsonApiDotNetCore.Middleware.JsonApiMediaType.html b/api/JsonApiDotNetCore.Middleware.JsonApiMediaType.html
@@ -146,21 +146,21 @@ <h2 class="section" id="constructors">Constructors
 
   <a id="JsonApiDotNetCore_Middleware_JsonApiMediaType__ctor_" data-uid="JsonApiDotNetCore.Middleware.JsonApiMediaType.#ctor*"></a>
 
-  <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})">
-  JsonApiMediaType(IEnumerable&lt;JsonApiExtension&gt;)
+  <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})">
+  JsonApiMediaType(IEnumerable&lt;JsonApiMediaTypeExtension&gt;)
   <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>
   </h3>
 
   <div class="markdown level1 summary"></div>
   <div class="markdown level1 conceptual"></div>
 
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public JsonApiMediaType(IEnumerable&lt;JsonApiExtension&gt; extensions)</code></pre>
+    <pre><code class="lang-csharp hljs">public JsonApiMediaType(IEnumerable&lt;JsonApiMediaTypeExtension&gt; extensions)</code></pre>
   </div>
 
   <h4 class="section">Parameters</h4>
   <dl class="parameters">
-    <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>
+    <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>
     <dd></dd>
   </dl>
 
@@ -177,21 +177,21 @@ <h4 class="section">Parameters</h4>
 
   <a id="JsonApiDotNetCore_Middleware_JsonApiMediaType__ctor_" data-uid="JsonApiDotNetCore.Middleware.JsonApiMediaType.#ctor*"></a>
 
-  <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})">
-  JsonApiMediaType(IReadOnlySet&lt;JsonApiExtension&gt;)
+  <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})">
+  JsonApiMediaType(IReadOnlySet&lt;JsonApiMediaTypeExtension&gt;)
   <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>
   </h3>
 
   <div class="markdown level1 summary"></div>
   <div class="markdown level1 conceptual"></div>
 
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public JsonApiMediaType(IReadOnlySet&lt;JsonApiExtension&gt; extensions)</code></pre>
+    <pre><code class="lang-csharp hljs">public JsonApiMediaType(IReadOnlySet&lt;JsonApiMediaTypeExtension&gt; extensions)</code></pre>
   </div>
 
   <h4 class="section">Parameters</h4>
   <dl class="parameters">
-    <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>
+    <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>
     <dd></dd>
   </dl>
 
@@ -318,7 +318,7 @@ <h3 id="JsonApiDotNetCore_Middleware_JsonApiMediaType_Extensions" data-uid="Json
   <div class="markdown level1 conceptual"></div>
 
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public IReadOnlySet&lt;JsonApiExtension&gt; Extensions { get; }</code></pre>
+    <pre><code class="lang-csharp hljs">public IReadOnlySet&lt;JsonApiMediaTypeExtension&gt; Extensions { get; }</code></pre>
   </div>
 
 
@@ -327,7 +327,7 @@ <h3 id="JsonApiDotNetCore_Middleware_JsonApiMediaType_Extensions" data-uid="Json
 
   <h4 class="section">Property Value</h4>
   <dl class="parameters">
-    <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>
+    <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>
     <dd></dd>
   </dl>