Removed resource ID from error message, as the error is unrelated to any specific record

Author: bkoelman

src/JsonApiDotNetCore/Errors/CannotClearRequiredRelationshipException.cs

@@ -10,12 +10,11 @@ namespace JsonApiDotNetCore.Errors;
 [PublicAPI]
 public sealed class CannotClearRequiredRelationshipException : JsonApiException
 {
-    public CannotClearRequiredRelationshipException(string relationshipName, string resourceId, string resourceType)
+    public CannotClearRequiredRelationshipException(string relationshipName, string resourceType)
         : base(new ErrorObject(HttpStatusCode.BadRequest)
         {
             Title = "Failed to clear a required relationship.",
-            Detail = $"The relationship '{relationshipName}' on resource type '{resourceType}' " +
-                $"with ID '{resourceId}' cannot be cleared because it is a required relationship."
+            Detail = $"The relationship '{relationshipName}' on resource type '{resourceType}' cannot be cleared because it is a required relationship."
         })
     {
     }

src/JsonApiDotNetCore/Repositories/EntityFrameworkCoreRepository.cs

@@ -269,7 +269,7 @@ public virtual async Task UpdateAsync(TResource resourceFromRequest, TResource r
             object? rightValueEvaluated = await VisitSetRelationshipAsync(resourceFromDatabase, relationship, rightValue, WriteOperationKind.UpdateResource,
                 cancellationToken);
 
-            AssertIsNotClearingRequiredToOneRelationship(relationship, resourceFromDatabase, rightValueEvaluated);
+            AssertIsNotClearingRequiredToOneRelationship(relationship, rightValueEvaluated);
 
             await UpdateRelationshipAsync(relationship, resourceFromDatabase, rightValueEvaluated, cancellationToken);
         }
@@ -288,7 +288,7 @@ public virtual async Task UpdateAsync(TResource resourceFromRequest, TResource r
         _dbContext.ResetChangeTracker();
     }
 
-    protected void AssertIsNotClearingRequiredToOneRelationship(RelationshipAttribute relationship, TResource leftResource, object? rightValue)
+    protected void AssertIsNotClearingRequiredToOneRelationship(RelationshipAttribute relationship, object? rightValue)
     {
         if (relationship is HasOneAttribute)
         {
@@ -300,7 +300,7 @@ protected void AssertIsNotClearingRequiredToOneRelationship(RelationshipAttribut
             if (isRelationshipRequired && isClearingRelationship)
             {
                 string resourceName = _resourceGraph.GetResourceType<TResource>().PublicName;
-                throw new CannotClearRequiredRelationshipException(relationship.PublicName, leftResource.StringId!, resourceName);
+                throw new CannotClearRequiredRelationshipException(relationship.PublicName, resourceName);
             }
         }
     }
@@ -403,7 +403,7 @@ public virtual async Task SetRelationshipAsync(TResource leftResource, object? r
         object? rightValueEvaluated =
             await VisitSetRelationshipAsync(leftResource, relationship, rightValue, WriteOperationKind.SetRelationship, cancellationToken);
 
-        AssertIsNotClearingRequiredToOneRelationship(relationship, leftResource, rightValueEvaluated);
+        AssertIsNotClearingRequiredToOneRelationship(relationship, rightValueEvaluated);
 
         await UpdateRelationshipAsync(relationship, leftResource, rightValueEvaluated, cancellationToken);
 

test/JsonApiDotNetCoreTests/IntegrationTests/InputValidation/ModelState/NoModelStateValidationTests.cs

@@ -128,8 +128,6 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
         ErrorObject error = responseDocument.Errors[0];
         error.StatusCode.Should().Be(HttpStatusCode.BadRequest);
         error.Title.Should().Be("Failed to clear a required relationship.");
-
-        error.Detail.Should().Be($"The relationship 'rootDirectory' on resource type 'systemVolumes' with ID '{existingVolume.StringId}' " +
-            "cannot be cleared because it is a required relationship.");
+        error.Detail.Should().Be("The relationship 'rootDirectory' on resource type 'systemVolumes' cannot be cleared because it is a required relationship.");
     }
 }

test/JsonApiDotNetCoreTests/IntegrationTests/RequiredRelationships/DefaultBehaviorTests.cs

@@ -256,9 +256,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
         ErrorObject error = responseDocument.Errors[0];
         error.StatusCode.Should().Be(HttpStatusCode.BadRequest);
         error.Title.Should().Be("Failed to clear a required relationship.");
-
-        error.Detail.Should().Be($"The relationship 'customer' on resource type 'orders' with ID '{existingOrder.StringId}' " +
-            "cannot be cleared because it is a required relationship.");
+        error.Detail.Should().Be("The relationship 'customer' on resource type 'orders' cannot be cleared because it is a required relationship.");
     }
 
     [Fact]