Auto-generated documentation from 4da3f25

Author: bkoelman

index.html

@@ -4,15 +4,15 @@
   <meta charset="utf-8">
   <meta content="width=device-width, initial-scale=1.0" name="viewport">
   <title>JsonApiDotNetCore documentation</title>
-  <meta content="A framework for building JSON:API compliant REST APIs using .NET Core and Entity Framework Core. Includes support for Atomic Operations." name="description">
+  <meta content="A framework for building JSON:API compliant REST APIs using ASP.NET Core and Entity Framework Core. Includes support for the Atomic Operations extension." name="description">
   <meta content="jsonapidotnetcore jsonapi json:api dotnet asp.net" name="keywords">
   <link href="favicon.ico" rel="icon">
   <link href="favicon.ico" rel="apple-touch-icon">
   <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,600,600i,700,700i|Raleway:300,300i,400,400i,600,600i,700,700i" rel="stylesheet">
   <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.5.0/css/bootstrap.min.css" rel="stylesheet">
   <link href="https://cdnjs.cloudflare.com/ajax/libs/bootstrap-icons/1.11.3/font/bootstrap-icons.min.css" rel="stylesheet">
   <link href="https://unpkg.com/[email protected]/css/boxicons.min.css" rel="stylesheet">
-  <link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.4.0/styles/default.min.css" rel="stylesheet">
+  <link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" rel="stylesheet">
   <link href="https://cdnjs.cloudflare.com/ajax/libs/aos/2.3.4/aos.css" rel="stylesheet">
   <link href="styles/home.css" rel="stylesheet">
   <link href="styles/icofont.min.css" rel="stylesheet">
@@ -51,8 +51,8 @@
         <div class="col-lg-7 pt-5 pt-lg-0 order-2 order-lg-1">
           <h1>JsonApiDotNetCore</h1>
           <h2>
-            A framework for building <a href="https://jsonapi.org/" target="_blank">JSON:API</a> compliant REST APIs using .NET Core and Entity Framework Core.
-            Includes support for <a href="https://jsonapi.org/ext/atomic/" target="_blank">Atomic Operations</a>.
+            A framework for building <a href="https://jsonapi.org/" target="_blank">JSON:API</a> compliant REST APIs using ASP.NET Core and Entity Framework Core.
+            Includes support for the <a href="https://jsonapi.org/ext/atomic/" target="_blank">Atomic Operations</a> extension.
           </h2>
           <a href="#about" class="btn-get-started scrollto">Read more</a>
           <a href="../../getting-started/install.html" class="btn-get-started">Getting started</a>
@@ -82,7 +82,9 @@ <h3 data-aos="fade-up">Objectives</h3>
               <div class="col-md-6" data-aos="fade-up" data-aos-delay="100">
                 <i class="bx bxs-package"></i>
                 <h4>Eliminate boilerplate</h4>
-                <p>We strive to eliminate as much boilerplate as possible by offering out-of-the-box features such as sorting, filtering and pagination.</p>
+                <p>
+                  The ultimate goal of this library is to eliminate as much boilerplate as possible by offering out-of-the-box features, such as sorting, filtering, pagination, sparse fieldset selection, and side-loading related resources.
+                </p>
               </div>
               <div class="col-md-6" data-aos="fade-up" data-aos-delay="200">
                 <i class="bx bx-category-alt"></i>
@@ -112,7 +114,7 @@ <h4 class="title">Filtering</h4>
             <div class="icon-box">
               <div class="icon"><i class="bx bx-sort-a-z"></i></div>
               <h4 class="title">Sorting</h4>
-              <p class="description">Order resources on one or multiple attributes using the <code>sort</code> query string parameter</p>
+              <p class="description">Order resources on multiple attributes using the <code>sort</code> query string parameter</p>
             </div>
           </div>
           <div feature class="col-md-6 col-lg-3 d-flex align-items-stretch" data-aos="zoom-in" data-aos-delay="300" id="pagination">
@@ -174,7 +176,7 @@ <h2>Example usage</h2>
               <div class="icon"><i class="bx bx-detail"></i></div>
               <h4 class="title">Resource</h4>
               <pre>
-<code>#nullable enable
+<code class="language-csharp">#nullable enable
 
 public class Article : Identifiable&lt;long&gt;
 {
@@ -213,7 +215,7 @@ <h4 class="title">Resource</h4>
             <div class="icon-box code-example">
               <div class="icon"><i class="bx bx-message-rounded-detail"></i></div>
               <h4 class="title">Request</h4>
-              <pre><code>GET /articles?filter=contains(summary,'web')&sort=-lastModifiedAt&fields[articles]=title,summary&include=author HTTP/1.1</code></pre>
+              <pre><code class="language-http">GET /articles?filter=contains(summary,'web')&amp;sort=-lastModifiedAt&amp;fields[articles]=title,summary&amp;include=author HTTP/1.1</code></pre>
             </div>
           </div>
         </div>
@@ -223,14 +225,14 @@ <h4 class="title">Request</h4>
               <div class="icon"><i class="bx bx-message-rounded-detail bx-flip-horizontal"></i></div>
               <h4 class="title">Response</h4>
               <pre>
-<code>{
+<code class="language-json">{
   "meta": {
     "totalResources": 1
   },
   "links": {
-    "self": "/articles?filter=contains(summary,'web')&sort=-lastModifiedAt&fields%5Barticles%5D=title,summary&include=author",
-    "first": "/articles?filter=contains(summary,'web')&sort=-lastModifiedAt&fields%5Barticles%5D=title,summary&include=author",
-    "last": "/articles?filter=contains(summary,'web')&sort=-lastModifiedAt&fields%5Barticles%5D=title,summary&include=author"
+    "self": "/articles?filter=contains(summary,'web')&amp;sort=-lastModifiedAt&amp;fields%5Barticles%5D=title,summary&amp;include=author",
+    "first": "/articles?filter=contains(summary,'web')&amp;sort=-lastModifiedAt&amp;fields%5Barticles%5D=title,summary&amp;include=author",
+    "last": "/articles?filter=contains(summary,'web')&amp;sort=-lastModifiedAt&amp;fields%5Barticles%5D=title,summary&amp;include=author"
   },
   "data": [
     {