Merge branch 'master' into master-into-openapi

Author: Bart Koelman

.config/dotnet-tools.json

@@ -9,7 +9,7 @@
       ]
     },
     "regitlint": {
-      "version": "2.1.4",
+      "version": "6.0.6",
       "commands": [
         "regitlint"
       ]

Build.ps1

@@ -8,7 +8,7 @@ function CheckLastExitCode {
 
 function RunInspectCode {
     $outputPath = [System.IO.Path]::Combine([System.IO.Path]::GetTempPath(), 'jetbrains-inspectcode-results.xml')
-    dotnet jb inspectcode JsonApiDotNetCore.sln --no-build --output="$outputPath" --profile=WarningSeverities.DotSettings --properties:Configuration=Release --severity=WARNING --verbosity=WARN -dsl=GlobalAll -dsl=SolutionPersonal -dsl=ProjectPersonal
+    dotnet jb inspectcode JsonApiDotNetCore.sln --no-build --output="$outputPath" --profile=WarningSeverities.DotSettings --properties:Configuration=Release --severity=WARNING --verbosity=WARN -dsl=GlobalAll -dsl=GlobalPerProduct -dsl=SolutionPersonal -dsl=ProjectPersonal
     CheckLastExitCode
 
     [xml]$xml = Get-Content "$outputPath"
@@ -47,7 +47,7 @@ function RunCleanupCode {
         $mergeCommitHash = git rev-parse "HEAD"
         $targetCommitHash = git rev-parse "$env:APPVEYOR_REPO_BRANCH"
 
-        dotnet regitlint -s JsonApiDotNetCore.sln --print-command --jb --profile --jb --profile='\"JADNC Full Cleanup\"' --jb --properties:Configuration=Release --jb --verbosity=WARN -f commits -a $mergeCommitHash -b $targetCommitHash --fail-on-diff --print-diff
+        dotnet regitlint -s JsonApiDotNetCore.sln --print-command --disable-jb-path-hack --jb --profile='\"JADNC Full Cleanup\"' --jb --properties:Configuration=Release --jb --verbosity=WARN -f commits -a $mergeCommitHash -b $targetCommitHash --fail-on-diff --print-diff
         CheckLastExitCode
     }
 }
@@ -73,10 +73,10 @@ function CreateNuGetPackage {
         $versionSuffix = $suffixSegments -join "-"
     }
     else {
-        # Get the version suffix from the auto-incrementing build number. Example: "123" => "pre-0123".
+        # Get the version suffix from the auto-incrementing build number. Example: "123" => "master-0123".
         if ($env:APPVEYOR_BUILD_NUMBER) {
             $revision = "{0:D4}" -f [convert]::ToInt32($env:APPVEYOR_BUILD_NUMBER, 10)
-            $versionSuffix = "pre-$revision"
+            $versionSuffix = "$($env:APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH ?? $env:APPVEYOR_REPO_BRANCH)-$revision"
         }
         else {
             $versionSuffix = "pre-0001"

README.md

@@ -43,21 +43,23 @@ See [our documentation](https://www.jsonapi.net/) for detailed usage.
 ### Models
 
 ```c#
-public class Article : Identifiable
+#nullable enable
+
+public class Article : Identifiable<int>
 {
     [Attr]
-    public string Name { get; set; }
+    public string Name { get; set; } = null!;
 }
 ```
 
 ### Controllers
 
 ```c#
-public class ArticlesController : JsonApiController<Article>
+public class ArticlesController : JsonApiController<Article, int>
 {
-    public ArticlesController(IJsonApiOptions options, ILoggerFactory loggerFactory,
-        IResourceService<Article> resourceService,)
-        : base(options, loggerFactory, resourceService)
+    public ArticlesController(IJsonApiOptions options, IResourceGraph resourceGraph,
+        ILoggerFactory loggerFactory, IResourceService<Article, int> resourceService)
+        : base(options, resourceGraph, loggerFactory, resourceService)
     {
     }
 }
@@ -87,13 +89,16 @@ public class Startup
 The following chart should help you pick the best version, based on your environment.
 See also our [versioning policy](./VERSIONING_POLICY.md).
 
-| .NET version | Entity Framework Core version | JsonApiDotNetCore version |
-| ------------ | ----------------------------- | ------------------------- |
-| Core 2.x     | 2.x                           | 3.x                       |
-| Core 3.1     | 3.1                           | 4.x                       |
-| Core 3.1     | 5                             | 4.x                       |
-| 5            | 5                             | 4.x or 5.x                |
-| 6            | 6                             | 5.x                       |
+| JsonApiDotNetCore | .NET     | Entity Framework Core | Status                     |
+| ----------------- | -------- | --------------------- | -------------------------- |
+| 3.x               | Core 2.x | 2.x                   | Released                   |
+| 4.x               | Core 3.1 | 3.1                   | Released                   |
+|                   | Core 3.1 | 5                     |                            |
+|                   | 5        | 5                     |                            |
+|                   | 6        | 5                     |                            |
+| v5.x (pending)    | 5        | 5                     | On AppVeyor, to-be-dropped |
+|                   | 6        | 5                     | On AppVeyor, to-be-dropped |
+|                   | 6        | 6                     | Requires build from master |
 
 ## Contributing
 

ROADMAP.md

@@ -13,7 +13,7 @@ We've completed active development on v4.x, but we'll still fix important bugs o
 The need for breaking changes has blocked several efforts in the v4.x release, so now that we're starting work on v5, we're going to catch up.
 
 - [x] Remove Resource Hooks [#1025](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1025)
-- [x] Update to .NET/EFCORE 5 [#1026](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1026)
+- [x] Update to .NET 5 with EF Core 5 [#1026](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1026)
 - [x] Native many-to-many [#935](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/935)
 - [x] Refactorings [#1027](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1027) [#944](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/944)
 - [x] Tweak trace logging [#1033](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1033)
@@ -24,6 +24,7 @@ The need for breaking changes has blocked several efforts in the v4.x release, s
 - [x] Nullable reference types [#1029](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1029)
 - [x] Improved paging links [#1010](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1010)
 - [x] Configuration validation [#170](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/170)
+- [ ] Support .NET 6 with EF Core 6 [#1109](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1109)
 
 Aside from the list above, we have interest in the following topics. It's too soon yet to decide whether they'll make it into v5.x or in a later major version.
 

appveyor.yml

@@ -1,6 +1,6 @@
 image:
   - Ubuntu
-  - Visual Studio 2019
+  - Visual Studio 2022
 
 version: '{build}'
 
@@ -33,7 +33,7 @@ for:
 -
   matrix:
     only:
-    - image: Visual Studio 2019
+    - image: Visual Studio 2022
   services:
   - postgresql13
   # REF: https://github.com/docascode/docfx-seed/blob/master/appveyor.yml
@@ -43,9 +43,7 @@ for:
             # https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html
             git checkout $env:APPVEYOR_REPO_BRANCH -q
         }
-        # Pinning to previous version, because zip of v2.58.8 (released 2d ago) is corrupt.
-        # Tracked at https://github.com/dotnet/docfx/issues/7689
-        choco install docfx -y --version 2.58.5
+        choco install docfx -y
         if ($lastexitcode -ne 0) {
             throw "docfx install failed with exit code $lastexitcode."
         }

benchmarks/Deserialization/DeserializationBenchmarkBase.cs

@@ -21,7 +21,7 @@ public abstract class DeserializationBenchmarkBase
         protected DeserializationBenchmarkBase()
         {
             var options = new JsonApiOptions();
-            IResourceGraph resourceGraph = new ResourceGraphBuilder(options, NullLoggerFactory.Instance).Add<IncomingResource>().Build();
+            IResourceGraph resourceGraph = new ResourceGraphBuilder(options, NullLoggerFactory.Instance).Add<IncomingResource, int>().Build();
             options.SerializerOptions.Converters.Add(new ResourceObjectConverter(resourceGraph));
             SerializerReadOptions = ((IJsonApiOptions)options).SerializerReadOptions;
 

benchmarks/QueryString/QueryStringParserBenchmarks.cs

@@ -29,7 +29,8 @@ public QueryStringParserBenchmarks()
                 EnableLegacyFilterNotation = true
             };
 
-            IResourceGraph resourceGraph = new ResourceGraphBuilder(options, NullLoggerFactory.Instance).Add<QueryableResource>("alt-resource-name").Build();
+            IResourceGraph resourceGraph =
+                new ResourceGraphBuilder(options, NullLoggerFactory.Instance).Add<QueryableResource, int>("alt-resource-name").Build();
 
             var request = new JsonApiRequest
             {

benchmarks/Serialization/SerializationBenchmarkBase.cs

@@ -40,7 +40,7 @@ protected SerializationBenchmarkBase()
                 }
             };
 
-            ResourceGraph = new ResourceGraphBuilder(options, NullLoggerFactory.Instance).Add<OutgoingResource>().Build();
+            ResourceGraph = new ResourceGraphBuilder(options, NullLoggerFactory.Instance).Add<OutgoingResource, int>().Build();
             SerializerWriteOptions = ((IJsonApiOptions)options).SerializerWriteOptions;
 
             // ReSharper disable VirtualMemberCallInConstructor
@@ -229,15 +229,15 @@ public TopLevelLinks GetTopLevelLinks()
                 };
             }
 
-            public ResourceLinks GetResourceLinks(ResourceType resourceType, string id)
+            public ResourceLinks GetResourceLinks(ResourceType resourceType, IIdentifiable resource)
             {
                 return new ResourceLinks
                 {
                     Self = "Resource:Self"
                 };
             }
 
-            public RelationshipLinks GetRelationshipLinks(RelationshipAttribute relationship, string leftId)
+            public RelationshipLinks GetRelationshipLinks(RelationshipAttribute relationship, IIdentifiable leftResource)
             {
                 return new RelationshipLinks
                 {

cleanupcode.ps1

@@ -14,4 +14,4 @@ if ($LASTEXITCODE -ne 0) {
     throw "Package restore failed with exit code $LASTEXITCODE"
 }
 
-dotnet regitlint -s JsonApiDotNetCore.sln --print-command --jb --profile --jb --profile='\"JADNC Full Cleanup\"' --jb --properties:Configuration=Release --jb --verbosity=WARN
+dotnet regitlint -s JsonApiDotNetCore.sln --print-command --disable-jb-path-hack --jb --profile='\"JADNC Full Cleanup\"' --jb --properties:Configuration=Release --jb --verbosity=WARN

docs/getting-started/step-by-step.md

@@ -38,10 +38,12 @@ Define your domain models such that they implement `IIdentifiable<TId>`.
 The easiest way to do this is to inherit from `Identifiable<TId>`.
 
 ```c#
+#nullable enable
+
 public class Person : Identifiable<int>
 {
     [Attr]
-    public string Name { get; set; }
+    public string Name { get; set; } = null!;
 }
 ```
 
@@ -52,12 +54,12 @@ Nothing special here, just an ordinary `DbContext`.
 ```
 public class AppDbContext : DbContext
 {
+    public DbSet<Person> People => Set<Person>();
+
     public AppDbContext(DbContextOptions<AppDbContext> options)
         : base(options)
     {
     }
-
-    public DbSet<Person> People { get; set; }
 }
 ```
 

docs/home/index.html

@@ -142,31 +142,35 @@ <h2>Example usage</h2>
                      <div class="icon"><i class='bx bx-detail'></i></div>
                      <h4 class="title">Resource</h4>
                      <pre>
-<code>public class Article : Identifiable
+<code>#nullable enable
+
+public class Article : Identifiable&lt;long&gt;
 {
     [Attr]
-    [Required, MaxLength(30)]
-    public string Title { get; set; }
+    [MaxLength(30)]
+    public string Title { get; set; } = null!;
 
     [Attr(Capabilities = AttrCapabilities.AllowFilter)]
-    public string Summary { get; set; }
+    public string? Summary { get; set; }
 
     [Attr(PublicName = "websiteUrl")]
-    public string Url { get; set; }
+    public string? Url { get; set; }
+
+    [Attr]
+    [Required]
+    public int? WordCount { get; set; }
 
     [Attr(Capabilities = AttrCapabilities.AllowView)]
     public DateTimeOffset LastModifiedAt { get; set; }
 
     [HasOne]
-    public Person Author { get; set; }
+    public Person Author { get; set; } = null!;
 
-    [HasMany]
-    public ICollection&lt;Revision&gt; Revisions { get; set; }  
+    [HasOne]
+    public Person? Reviewer { get; set; }
 
-    [HasManyThrough(nameof(ArticleTags))]
-    [NotMapped]
-    public ICollection&lt;Tag&gt; Tags { get; set; }
-    public ICollection&lt;ArticleTag&gt; ArticleTags { get; set; }
+    [HasMany]
+    public ICollection&lt;Tag&gt; Tags { get; set; } = new HashSet&lt;Tag&gt;();
 }</code>
                      </pre>
                   </div>
@@ -179,7 +183,7 @@ <h4 class="title">Resource</h4>
                      <h4 class="title">Request</h4>
                      <pre>
 <code>
-GET /articles?filter=contains(summary,'web')&sort=-lastModifiedAt&fields=title,summary&include=author HTTP/1.1
+GET /articles?filter=contains(summary,'web')&sort=-lastModifiedAt&fields[articles]=title,summary&include=author HTTP/1.1
 </code>
                      </pre>
                   </div>
@@ -197,9 +201,9 @@ <h4 class="title">Response</h4>
     "totalResources": 1
   },
   "links": {
-    "self": "/articles?filter=contains(summary,'web')&sort=-lastModifiedAt&fields=title,summary&include=author",
-    "first": "/articles?filter=contains(summary,'web')&sort=-lastModifiedAt&fields=title,summary&include=author",
-    "last": "/articles?filter=contains(summary,'web')&sort=-lastModifiedAt&fields=title,summary&include=author"
+    "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"
   },
   "data": [
     {

docs/usage/errors.md

@@ -10,7 +10,7 @@ From a controller method:
 return Conflict(new Error(HttpStatusCode.Conflict)
 {
     Title = "Target resource was modified by another user.",
-    Detail = $"User {userName} changed the {resourceField} field on the {resourceName} resource."
+    Detail = $"User {userName} changed the {resourceField} field on {resourceName} resource."
 });
 ```
 
@@ -20,7 +20,7 @@ From other code:
 throw new JsonApiException(new Error(HttpStatusCode.Conflict)
 {
     Title = "Target resource was modified by another user.",
-    Detail = $"User {userName} changed the {resourceField} field on the {resourceName} resource."
+    Detail = $"User {userName} changed the {resourceField} field on {resourceName} resource."
 });
 ```
 
@@ -69,18 +69,22 @@ public class CustomExceptionHandler : ExceptionHandler
         return base.GetLogMessage(exception);
     }
 
-    protected override ErrorDocument CreateErrorDocument(Exception exception)
+    protected override IReadOnlyList<ErrorObject> CreateErrorResponse(Exception exception)
     {
         if (exception is ProductOutOfStockException productOutOfStock)
         {
-            return new ErrorDocument(new Error(HttpStatusCode.Conflict)
+            return new[]
             {
-                Title = "Product is temporarily available.",
-                Detail = $"Product {productOutOfStock.ProductId} cannot be ordered at the moment."
-            });
+                new Error(HttpStatusCode.Conflict)
+                {
+                    Title = "Product is temporarily available.",
+                    Detail = $"Product {productOutOfStock.ProductId} " +
+                        "cannot be ordered at the moment."
+                }
+            };
         }
 
-        return base.CreateErrorDocument(exception);
+        return base.CreateErrorResponse(exception);
     }
 }