Auto-generated documentation from 453aa2a

bkoelman · bkoelman · commit 24e820fb11c9 · 2026-02-14T16:18:26.000Z
diff --git a/api/JsonApiDotNetCore.AtomicOperations.Processors.CreateProcessor-2.html b/api/JsonApiDotNetCore.AtomicOperations.Processors.CreateProcessor-2.html
@@ -6,7 +6,7 @@
       <meta name="viewport" content="width=device-width, initial-scale=1.0">
       <meta name="title" content="Class CreateProcessor&lt;TResource, TId&gt; ">
       
-      <meta name="description" content="Processes a single operation to create a new resource with attributes, relationships or both.">
+      <meta name="description" content="Processes a single operation to create a new resource with attributes, relationships, or both.">
       <link rel="icon" href="../favicon.ico">
       <link rel="stylesheet" href="../public/docfx.min.css">
       <link rel="stylesheet" href="../public/main.css">
@@ -100,7 +100,7 @@ <h1 id="JsonApiDotNetCore_AtomicOperations_Processors_CreateProcessor_2" data-ui
   <dl><dt>Assembly</dt><dd>JsonApiDotNetCore.dll</dd></dl>
   </div>
 
-  <div class="markdown summary"><p>Processes a single operation to create a new resource with attributes, relationships or both.</p>
+  <div class="markdown summary"><p>Processes a single operation to create a new resource with attributes, relationships, or both.</p>
 </div>
   <div class="markdown conceptual"></div>
 
diff --git a/api/JsonApiDotNetCore.AtomicOperations.Processors.ICreateProcessor-2.html b/api/JsonApiDotNetCore.AtomicOperations.Processors.ICreateProcessor-2.html
@@ -6,7 +6,7 @@
       <meta name="viewport" content="width=device-width, initial-scale=1.0">
       <meta name="title" content="Interface ICreateProcessor&lt;TResource, TId&gt; ">
       
-      <meta name="description" content="Processes a single operation to create a new resource with attributes, relationships or both.">
+      <meta name="description" content="Processes a single operation to create a new resource with attributes, relationships, or both.">
       <link rel="icon" href="../favicon.ico">
       <link rel="stylesheet" href="../public/docfx.min.css">
       <link rel="stylesheet" href="../public/main.css">
@@ -100,7 +100,7 @@ <h1 id="JsonApiDotNetCore_AtomicOperations_Processors_ICreateProcessor_2" data-u
   <dl><dt>Assembly</dt><dd>JsonApiDotNetCore.dll</dd></dl>
   </div>
 
-  <div class="markdown summary"><p>Processes a single operation to create a new resource with attributes, relationships or both.</p>
+  <div class="markdown summary"><p>Processes a single operation to create a new resource with attributes, relationships, or both.</p>
 </div>
   <div class="markdown conceptual"></div>
 
diff --git a/api/JsonApiDotNetCore.AtomicOperations.Processors.html b/api/JsonApiDotNetCore.AtomicOperations.Processors.html
@@ -104,7 +104,7 @@ <h3 id="classes">
     </dl>
     <dl class="jumplist">
       <dt><a class="xref" href="JsonApiDotNetCore.AtomicOperations.Processors.CreateProcessor-2.html">CreateProcessor&lt;TResource, TId&gt;</a></dt>
-      <dd><p>Processes a single operation to create a new resource with attributes, relationships or both.</p>
+      <dd><p>Processes a single operation to create a new resource with attributes, relationships, or both.</p>
 </dd>
     </dl>
     <dl class="jumplist">
@@ -138,7 +138,7 @@ <h3 id="interfaces">
     </dl>
     <dl class="jumplist">
       <dt><a class="xref" href="JsonApiDotNetCore.AtomicOperations.Processors.ICreateProcessor-2.html">ICreateProcessor&lt;TResource, TId&gt;</a></dt>
-      <dd><p>Processes a single operation to create a new resource with attributes, relationships or both.</p>
+      <dd><p>Processes a single operation to create a new resource with attributes, relationships, or both.</p>
 </dd>
     </dl>
     <dl class="jumplist">
diff --git a/api/JsonApiDotNetCore.Controllers.BaseJsonApiController-2.html b/api/JsonApiDotNetCore.Controllers.BaseJsonApiController-2.html
@@ -1023,7 +1023,7 @@ <h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2_GetRelationshipAsy
   <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L178"><i class="bi bi-code-slash"></i></a>
   </h3>
 
-  <div class="markdown level1 summary"><p>Gets a relationship value, which can be a <code>null</code>, a single object or a collection.</p>
+  <div class="markdown level1 summary"><p>Gets a relationship value, which can be <code>null</code>, a single object or a collection.</p>
 <p>
 Example endpoints: <pre><code class="lang-http">GET /articles/1/relationships/author HTTP/1.1</code></pre>
 <pre><code class="lang-http">GET /articles/1/relationships/revisions HTTP/1.1</code></pre>
@@ -1209,7 +1209,7 @@ <h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiController_2_PostAsync__0_Syste
   <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs/#L207"><i class="bi bi-code-slash"></i></a>
   </h3>
 
-  <div class="markdown level1 summary"><p>Creates a new resource with attributes, relationships or both.</p>
+  <div class="markdown level1 summary"><p>Creates a new resource with attributes, relationships, or both.</p>
 <p>
 Example endpoint: <pre><code class="lang-http">POST /articles HTTP/1.1</code></pre>
 
diff --git a/api/JsonApiDotNetCore.Controllers.JsonApiController-2.html b/api/JsonApiDotNetCore.Controllers.JsonApiController-2.html
@@ -1022,7 +1022,7 @@ <h3 id="JsonApiDotNetCore_Controllers_JsonApiController_2_GetRelationshipAsync__
   <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L71"><i class="bi bi-code-slash"></i></a>
   </h3>
 
-  <div class="markdown level1 summary"><p>Gets a relationship value, which can be a <code>null</code>, a single object or a collection.</p>
+  <div class="markdown level1 summary"><p>Gets a relationship value, which can be <code>null</code>, a single object or a collection.</p>
 <p>
 Example endpoints: <pre><code class="lang-http">GET /articles/1/relationships/author HTTP/1.1</code></pre>
 <pre><code class="lang-http">GET /articles/1/relationships/revisions HTTP/1.1</code></pre>
@@ -1214,7 +1214,7 @@ <h3 id="JsonApiDotNetCore_Controllers_JsonApiController_2_PostAsync__0_System_Th
   <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs/#L80"><i class="bi bi-code-slash"></i></a>
   </h3>
 
-  <div class="markdown level1 summary"><p>Creates a new resource with attributes, relationships or both.</p>
+  <div class="markdown level1 summary"><p>Creates a new resource with attributes, relationships, or both.</p>
 <p>
 Example endpoint: <pre><code class="lang-http">POST /articles HTTP/1.1</code></pre>
 
diff --git a/api/JsonApiDotNetCore.Controllers.JsonApiEndpoints.html b/api/JsonApiDotNetCore.Controllers.JsonApiEndpoints.html
@@ -6,7 +6,7 @@
       <meta name="viewport" content="width=device-width, initial-scale=1.0">
       <meta name="title" content="Enum JsonApiEndpoints ">
       
-      
+      <meta name="description" content="Lists the built-in JSON:API endpoints, described at https://jsonapi.org/format.">
       <link rel="icon" href="../favicon.ico">
       <link rel="stylesheet" href="../public/docfx.min.css">
       <link rel="stylesheet" href="../public/main.css">
@@ -93,15 +93,16 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
 
 
   <h1 id="JsonApiDotNetCore_Controllers_JsonApiEndpoints" data-uid="JsonApiDotNetCore.Controllers.JsonApiEndpoints" class="text-break">
-Enum JsonApiEndpoints  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore.Annotations/Controllers/JsonApiEndpoints.shared.cs/#L6"><i class="bi bi-code-slash"></i></a>
+Enum JsonApiEndpoints  <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore.Annotations/Controllers/JsonApiEndpoints.shared.cs/#L8"><i class="bi bi-code-slash"></i></a>
   </h1>
 
   <div class="facts text-secondary">
     <dl><dt>Namespace</dt><dd><a class="xref" href="JsonApiDotNetCore.html">JsonApiDotNetCore</a>.<a class="xref" href="JsonApiDotNetCore.Controllers.html">Controllers</a></dd></dl>
   <dl><dt>Assembly</dt><dd>JsonApiDotNetCore.Annotations.dll</dd></dl>
   </div>
 
-  <div class="markdown summary"></div>
+  <div class="markdown summary"><p>Lists the built-in JSON:API endpoints, described at <a href="https://jsonapi.org/format">https://jsonapi.org/format</a>.</p>
+</div>
   <div class="markdown conceptual"></div>
 
   <div class="codewrapper">
@@ -123,54 +124,101 @@ <h2 id="fields">Fields
   <dl class="parameters">
     <dt id="JsonApiDotNetCore_Controllers_JsonApiEndpoints_All"><code>All = Query | Command</code></dt>
   
-  <dd></dd>
+  <dd><p>Represents all JSON:API endpoints.</p>
+</dd>
     <dt id="JsonApiDotNetCore_Controllers_JsonApiEndpoints_Command"><code>Command = Post | PostRelationship | Patch | PatchRelationship | Delete | DeleteRelationship</code></dt>
   
-  <dd></dd>
+  <dd><p>Represents the set of JSON:API endpoints to change resources and relationships.</p>
+</dd>
     <dt id="JsonApiDotNetCore_Controllers_JsonApiEndpoints_Delete"><code>Delete = 256</code></dt>
   
-  <dd></dd>
+  <dd><p>Represents the endpoint to delete an existing resource.</p>
+<p>
+Example endpoint: <pre><code class="lang-http">DELETE /articles/1 HTTP/1.1</code></pre>
+
+</dd>
     <dt id="JsonApiDotNetCore_Controllers_JsonApiEndpoints_DeleteRelationship"><code>DeleteRelationship = 512</code></dt>
   
-  <dd></dd>
+  <dd><p>Represents the endpoint to remove resources from a to-many relationship.</p>
+<p>
+Example endpoint: <pre><code class="lang-http">DELETE /articles/1/relationships/revisions HTTP/1.1</code></pre>
+
+</dd>
     <dt id="JsonApiDotNetCore_Controllers_JsonApiEndpoints_GetCollection"><code>GetCollection = 1</code></dt>
   
-  <dd></dd>
+  <dd><p>Represents the endpoint to get a collection of primary resources.</p>
+<p>
+Example endpoint: <pre><code class="lang-http">GET /articles HTTP/1.1</code></pre>
+
+</dd>
     <dt id="JsonApiDotNetCore_Controllers_JsonApiEndpoints_GetRelationship"><code>GetRelationship = 8</code></dt>
   
-  <dd></dd>
+  <dd><p>Represents the endpoint to get a relationship value.</p>
+<p>
+Example endpoints: <pre><code class="lang-http">GET /articles/1/relationships/author HTTP/1.1</code></pre>
+<pre><code class="lang-http">GET /articles/1/relationships/revisions HTTP/1.1</code></pre>
+
+</dd>
     <dt id="JsonApiDotNetCore_Controllers_JsonApiEndpoints_GetSecondary"><code>GetSecondary = 4</code></dt>
   
-  <dd></dd>
+  <dd><p>Represents the endpoint to get a secondary resource or collection of secondary resources.</p>
+<p>
+Example endpoints: <pre><code class="lang-http">GET /articles/1/author HTTP/1.1</code></pre>
+<pre><code class="lang-http">GET /articles/1/revisions HTTP/1.1</code></pre>
+
+</dd>
     <dt id="JsonApiDotNetCore_Controllers_JsonApiEndpoints_GetSingle"><code>GetSingle = 2</code></dt>
   
-  <dd></dd>
+  <dd><p>Represents the endpoint to get a single primary resource by ID.</p>
+<p>
+Example endpoint: <pre><code class="lang-http">GET /articles/1 HTTP/1.1</code></pre>
+
+</dd>
     <dt id="JsonApiDotNetCore_Controllers_JsonApiEndpoints_None"><code>None = 0</code></dt>
   
-  <dd></dd>
+  <dd><p>Represents none of the JSON:API endpoints.</p>
+</dd>
     <dt id="JsonApiDotNetCore_Controllers_JsonApiEndpoints_Patch"><code>Patch = 64</code></dt>
   
-  <dd></dd>
+  <dd><p>Represents the endpoint to update the attributes and/or relationships of an existing resource.</p>
+<p>
+Example endpoint: <pre><code class="lang-http">PATCH /articles/1 HTTP/1.1</code></pre>
+
+</dd>
     <dt id="JsonApiDotNetCore_Controllers_JsonApiEndpoints_PatchRelationship"><code>PatchRelationship = 128</code></dt>
   
-  <dd></dd>
+  <dd><p>Represents the endpoint to perform a complete replacement of a relationship on an existing resource.</p>
+<p>
+Example endpoints: <pre><code class="lang-http">PATCH /articles/1/relationships/author HTTP/1.1</code></pre>
+<pre><code class="lang-http">PATCH /articles/1/relationships/revisions HTTP/1.1</code></pre>
+
+</dd>
     <dt id="JsonApiDotNetCore_Controllers_JsonApiEndpoints_Post"><code>Post = 16</code></dt>
   
-  <dd></dd>
+  <dd><p>Represents the endpoint to create a new resource with attributes, relationships, or both.</p>
+<p>
+Example endpoint: <pre><code class="lang-http">POST /articles HTTP/1.1</code></pre>
+
+</dd>
     <dt id="JsonApiDotNetCore_Controllers_JsonApiEndpoints_PostRelationship"><code>PostRelationship = 32</code></dt>
   
-  <dd></dd>
+  <dd><p>Represents the endpoint to add resources to a to-many relationship.</p>
+<p>
+Example endpoint: <pre><code class="lang-http">POST /articles/1/revisions HTTP/1.1</code></pre>
+
+</dd>
     <dt id="JsonApiDotNetCore_Controllers_JsonApiEndpoints_Query"><code>Query = GetCollection | GetSingle | GetSecondary | GetRelationship</code></dt>
   
-  <dd></dd>
+  <dd><p>Represents the set of JSON:API endpoints to query resources and relationships.</p>
+</dd>
   </dl>
 
 
 
 </article>
 
         <div class="contribution d-print-none">
-          <a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore.Annotations/Controllers/JsonApiEndpoints.shared.cs/#L6" class="edit-link">Edit this page</a>
+          <a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore.Annotations/Controllers/JsonApiEndpoints.shared.cs/#L8" class="edit-link">Edit this page</a>
         </div>
 
 
diff --git a/api/JsonApiDotNetCore.Controllers.html b/api/JsonApiDotNetCore.Controllers.html
@@ -146,7 +146,8 @@ <h3 id="enums">
 </h3>
     <dl class="jumplist">
       <dt><a class="xref" href="JsonApiDotNetCore.Controllers.JsonApiEndpoints.html">JsonApiEndpoints</a></dt>
-      <dd></dd>
+      <dd><p>Lists the built-in JSON:API endpoints, described at <a href="https://jsonapi.org/format">https://jsonapi.org/format</a>.</p>
+</dd>
     </dl>
 
 
diff --git a/api/JsonApiDotNetCore.Middleware.WriteOperationKind.html b/api/JsonApiDotNetCore.Middleware.WriteOperationKind.html
@@ -127,7 +127,7 @@ <h2 id="fields">Fields
 </dd>
     <dt id="JsonApiDotNetCore_Middleware_WriteOperationKind_CreateResource"><code>CreateResource = 0</code></dt>
   
-  <dd><p>Create a new resource with attributes, relationships or both.</p>
+  <dd><p>Create a new resource with attributes, relationships, or both.</p>
 </dd>
     <dt id="JsonApiDotNetCore_Middleware_WriteOperationKind_DeleteResource"><code>DeleteResource = 2</code></dt>
   
diff --git a/api/JsonApiDotNetCore.Services.ICreateService-2.html b/api/JsonApiDotNetCore.Services.ICreateService-2.html
@@ -137,7 +137,7 @@ <h3 id="JsonApiDotNetCore_Services_ICreateService_2_CreateAsync__0_System_Thread
   <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Services/ICreateService.cs/#L12"><i class="bi bi-code-slash"></i></a>
   </h3>
 
-  <div class="markdown level1 summary"><p>Handles a JSON:API request to create a new resource with attributes, relationships or both.</p>
+  <div class="markdown level1 summary"><p>Handles a JSON:API request to create a new resource with attributes, relationships, or both.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
 
diff --git a/api/JsonApiDotNetCore.Services.JsonApiResourceService-2.html b/api/JsonApiDotNetCore.Services.JsonApiResourceService-2.html
@@ -401,7 +401,7 @@ <h3 id="JsonApiDotNetCore_Services_JsonApiResourceService_2_CreateAsync__0_Syste
   <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Services/JsonApiResourceService.cs/#L221"><i class="bi bi-code-slash"></i></a>
   </h3>
 
-  <div class="markdown level1 summary"><p>Handles a JSON:API request to create a new resource with attributes, relationships or both.</p>
+  <div class="markdown level1 summary"><p>Handles a JSON:API request to create a new resource with attributes, relationships, or both.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
 
diff --git a/manifest.json b/manifest.json
@@ -229,7 +229,7 @@
       "Uid": null,
       "IsMRef": true,
       "Title": "JsonApiDotNetCore.AtomicOperations.Processors.CreateProcessor<TResource, TId>",
-      "Summary": "<p sourcefile=\"api/JsonApiDotNetCore.AtomicOperations.Processors.CreateProcessor-2.yml\" sourcestartlinenumber=\"1\">Processes a single operation to create a new resource with attributes, relationships or both.</p>\n"
+      "Summary": "<p sourcefile=\"api/JsonApiDotNetCore.AtomicOperations.Processors.CreateProcessor-2.yml\" sourcestartlinenumber=\"1\">Processes a single operation to create a new resource with attributes, relationships, or both.</p>\n"
     },
     {
       "type": "ManagedReference",
@@ -271,7 +271,7 @@
       "Uid": null,
       "IsMRef": true,
       "Title": "JsonApiDotNetCore.AtomicOperations.Processors.ICreateProcessor<TResource, TId>",
-      "Summary": "<p sourcefile=\"api/JsonApiDotNetCore.AtomicOperations.Processors.ICreateProcessor-2.yml\" sourcestartlinenumber=\"1\">Processes a single operation to create a new resource with attributes, relationships or both.</p>\n"
+      "Summary": "<p sourcefile=\"api/JsonApiDotNetCore.AtomicOperations.Processors.ICreateProcessor-2.yml\" sourcestartlinenumber=\"1\">Processes a single operation to create a new resource with attributes, relationships, or both.</p>\n"
     },
     {
       "type": "ManagedReference",
@@ -767,7 +767,7 @@
       "Uid": null,
       "IsMRef": true,
       "Title": "JsonApiDotNetCore.Controllers.JsonApiEndpoints",
-      "Summary": null
+      "Summary": "<p sourcefile=\"api/JsonApiDotNetCore.Controllers.JsonApiEndpoints.yml\" sourcestartlinenumber=\"1\">Lists the built-in JSON:API endpoints, described at <a href=\"https://jsonapi.org/format\" sourcefile=\"api/JsonApiDotNetCore.Controllers.JsonApiEndpoints.yml\" sourcestartlinenumber=\"1\">https://jsonapi.org/format</a>.</p>\n"
     },
     {
       "type": "ManagedReference",
diff --git a/sitemap.xml b/sitemap.xml
