Breaking: Renamed "total-resources" meta key to "total" because thats what Ember.js expects it to be named (see https://guides.emberjs.com/release/models/handling-metadata/)

Bart Koelman · Bart Koelman · commit 5f42cf33be88 · 2021-09-10T10:19:03.000+02:00
diff --git a/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs b/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs
@@ -79,7 +79,7 @@ public interface IJsonApiOptions
         LinkTypes RelationshipLinks { get; }
 
         /// <summary>
-        /// Whether or not the total resource count should be included in all document-level meta objects. False by default.
+        /// Whether or not the total resource count should be included in top-level meta objects. This requires an additional database query. False by default.
         /// </summary>
         bool IncludeTotalResourceCount { get; }
 
diff --git a/src/JsonApiDotNetCore/Serialization/Building/MetaBuilder.cs b/src/JsonApiDotNetCore/Serialization/Building/MetaBuilder.cs
@@ -40,7 +40,7 @@ public IDictionary<string, object> Build()
         {
             if (_paginationContext.TotalResourceCount != null)
             {
-                const string keyName = "TotalResources";
+                const string keyName = "Total";
 
                 string key = _options.SerializerOptions.DictionaryKeyPolicy == null
                     ? keyName
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/Meta/TopLevelCountTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/Meta/TopLevelCountTests.cs
@@ -54,7 +54,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             httpResponse.Should().HaveStatusCode(HttpStatusCode.OK);
 
             responseDocument.Meta.Should().NotBeNull();
-            responseDocument.Meta["totalResources"].Should().Be(1);
+            responseDocument.Meta["total"].Should().Be(1);
         }
 
         [Fact]
@@ -75,7 +75,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             httpResponse.Should().HaveStatusCode(HttpStatusCode.OK);
 
             responseDocument.Meta.Should().NotBeNull();
-            responseDocument.Meta["totalResources"].Should().Be(0);
+            responseDocument.Meta["total"].Should().Be(0);
         }
 
         [Fact]
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/NamingConventions/KebabCasingTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/NamingConventions/KebabCasingTests.cs
@@ -57,7 +57,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             responseDocument.Included[0].Relationships.Should().BeNull();
             responseDocument.Included[0].Links.Self.Should().Be($"/public-api/diving-boards/{pools[1].DivingBoards[0].StringId}");
 
-            responseDocument.Meta["total-resources"].Should().Be(2);
+            responseDocument.Meta["total"].Should().Be(2);
         }
 
         [Fact]
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/NamingConventions/PascalCasingTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/NamingConventions/PascalCasingTests.cs
@@ -57,7 +57,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             responseDocument.Included[0].Relationships.Should().BeNull();
             responseDocument.Included[0].Links.Self.Should().Be($"/PublicApi/DivingBoards/{pools[1].DivingBoards[0].StringId}");
 
-            responseDocument.Meta["TotalResources"].Should().Be(2);
+            responseDocument.Meta["Total"].Should().Be(2);
         }
 
         [Fact]
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/ResourceDefinitions/Reading/ResourceDefinitionReadTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/ResourceDefinitions/Reading/ResourceDefinitionReadTests.cs
@@ -159,7 +159,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             responseDocument.ManyData[0].Id.Should().Be(planets[1].StringId);
             responseDocument.ManyData[1].Id.Should().Be(planets[3].StringId);
 
-            responseDocument.Meta["totalResources"].Should().Be(2);
+            responseDocument.Meta["total"].Should().Be(2);
 
             hitCounter.HitExtensibilityPoints.Should().BeEquivalentTo(new[]
             {
@@ -208,7 +208,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             responseDocument.ManyData.Should().HaveCount(1);
             responseDocument.ManyData[0].Id.Should().Be(planets[3].StringId);
 
-            responseDocument.Meta["totalResources"].Should().Be(1);
+            responseDocument.Meta["total"].Should().Be(1);
 
             hitCounter.HitExtensibilityPoints.Should().BeEquivalentTo(new[]
             {

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public IDictionary<string, object> Build()`
`40`	`40`	`{`
`41`	`41`	`if (_paginationContext.TotalResourceCount != null)`
`42`	`42`	`{`
`43`		`- const string keyName = "TotalResources";`
	`43`	`+ const string keyName = "Total";`
`44`	`44`
`45`	`45`	`string key = _options.SerializerOptions.DictionaryKeyPolicy == null`
`46`	`46`	`? keyName`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>`
`54`	`54`	`httpResponse.Should().HaveStatusCode(HttpStatusCode.OK);`
`55`	`55`
`56`	`56`	`responseDocument.Meta.Should().NotBeNull();`
`57`		`- responseDocument.Meta["totalResources"].Should().Be(1);`
	`57`	`+ responseDocument.Meta["total"].Should().Be(1);`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`[Fact]`
`@@ -75,7 +75,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>`
`75`	`75`	`httpResponse.Should().HaveStatusCode(HttpStatusCode.OK);`
`76`	`76`
`77`	`77`	`responseDocument.Meta.Should().NotBeNull();`
`78`		`- responseDocument.Meta["totalResources"].Should().Be(0);`
	`78`	`+ responseDocument.Meta["total"].Should().Be(0);`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`[Fact]`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>`
`57`	`57`	`responseDocument.Included[0].Relationships.Should().BeNull();`
`58`	`58`	`responseDocument.Included[0].Links.Self.Should().Be($"/public-api/diving-boards/{pools[1].DivingBoards[0].StringId}");`
`59`	`59`
`60`		`- responseDocument.Meta["total-resources"].Should().Be(2);`
	`60`	`+ responseDocument.Meta["total"].Should().Be(2);`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`[Fact]`
Original file line number	Diff line number	Diff line change
`@@ -159,7 +159,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>`
`159`	`159`	`responseDocument.ManyData[0].Id.Should().Be(planets[1].StringId);`
`160`	`160`	`responseDocument.ManyData[1].Id.Should().Be(planets[3].StringId);`
`161`	`161`
`162`		`- responseDocument.Meta["totalResources"].Should().Be(2);`
	`162`	`+ responseDocument.Meta["total"].Should().Be(2);`
`163`	`163`
`164`	`164`	`hitCounter.HitExtensibilityPoints.Should().BeEquivalentTo(new[]`
`165`	`165`	`{`
`@@ -208,7 +208,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>`
`208`	`208`	`responseDocument.ManyData.Should().HaveCount(1);`
`209`	`209`	`responseDocument.ManyData[0].Id.Should().Be(planets[3].StringId);`
`210`	`210`
`211`		`- responseDocument.Meta["totalResources"].Should().Be(1);`
	`211`	`+ responseDocument.Meta["total"].Should().Be(1);`
`212`	`212`
`213`	`213`	`hitCounter.HitExtensibilityPoints.Should().BeEquivalentTo(new[]`
`214`	`214`	`{`