Fill error.source.header where applicable

Bart Koelman · Bart Koelman · commit 8227a852abe3 · 2021-09-10T12:20:28.000+02:00
diff --git a/src/JsonApiDotNetCore/Middleware/JsonApiMiddleware.cs b/src/JsonApiDotNetCore/Middleware/JsonApiMiddleware.cs
@@ -108,7 +108,11 @@ private async Task<bool> ValidateIfMatchHeaderAsync(HttpContext httpContext, Jso
             {
                 await FlushResponseAsync(httpContext.Response, serializerSettings, new ErrorObject(HttpStatusCode.PreconditionFailed)
                 {
-                    Title = "Detection of mid-air edit collisions using ETags is not supported."
+                    Title = "Detection of mid-air edit collisions using ETags is not supported.",
+                    Source = new ErrorSource
+                    {
+                        Header = "If-Match"
+                    }
                 });
 
                 return false;
@@ -149,7 +153,11 @@ private static async Task<bool> ValidateContentTypeHeaderAsync(string allowedCon
                 await FlushResponseAsync(httpContext.Response, serializerSettings, new ErrorObject(HttpStatusCode.UnsupportedMediaType)
                 {
                     Title = "The specified Content-Type header value is not supported.",
-                    Detail = $"Please specify '{allowedContentType}' instead of '{contentType}' for the Content-Type header value."
+                    Detail = $"Please specify '{allowedContentType}' instead of '{contentType}' for the Content-Type header value.",
+                    Source = new ErrorSource
+                    {
+                        Header = "Content-Type"
+                    }
                 });
 
                 return false;
@@ -195,7 +203,11 @@ private static async Task<bool> ValidateAcceptHeaderAsync(MediaTypeHeaderValue a
                 await FlushResponseAsync(httpContext.Response, serializerSettings, new ErrorObject(HttpStatusCode.NotAcceptable)
                 {
                     Title = "The specified Accept header value does not contain any supported media types.",
-                    Detail = $"Please include '{allowedMediaTypeValue}' in the Accept header values."
+                    Detail = $"Please include '{allowedMediaTypeValue}' in the Accept header values.",
+                    Source = new ErrorSource
+                    {
+                        Header = "Accept"
+                    }
                 });
 
                 return false;
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/ContentNegotiation/AcceptHeaderTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/ContentNegotiation/AcceptHeaderTests.cs
@@ -198,6 +198,7 @@ public async Task Denies_JsonApi_with_parameters_in_Accept_headers()
             error.StatusCode.Should().Be(HttpStatusCode.NotAcceptable);
             error.Title.Should().Be("The specified Accept header value does not contain any supported media types.");
             error.Detail.Should().Be("Please include 'application/vnd.api+json' in the Accept header values.");
+            error.Source.Header.Should().Be("Accept");
         }
 
         [Fact]
@@ -244,6 +245,7 @@ public async Task Denies_JsonApi_in_Accept_headers_at_operations_endpoint()
             error.StatusCode.Should().Be(HttpStatusCode.NotAcceptable);
             error.Title.Should().Be("The specified Accept header value does not contain any supported media types.");
             error.Detail.Should().Be("Please include 'application/vnd.api+json; ext=\"https://jsonapi.org/ext/atomic\"' in the Accept header values.");
+            error.Source.Header.Should().Be("Accept");
         }
     }
 }
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/ContentNegotiation/ContentTypeHeaderTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/ContentNegotiation/ContentTypeHeaderTests.cs
@@ -99,6 +99,7 @@ public async Task Denies_unknown_ContentType_header()
             error.StatusCode.Should().Be(HttpStatusCode.UnsupportedMediaType);
             error.Title.Should().Be("The specified Content-Type header value is not supported.");
             error.Detail.Should().Be("Please specify 'application/vnd.api+json' instead of 'text/html' for the Content-Type header value.");
+            error.Source.Header.Should().Be("Content-Type");
         }
 
         [Fact]
@@ -192,6 +193,7 @@ public async Task Denies_JsonApi_ContentType_header_with_profile()
             error.StatusCode.Should().Be(HttpStatusCode.UnsupportedMediaType);
             error.Title.Should().Be("The specified Content-Type header value is not supported.");
             error.Detail.Should().Be($"Please specify 'application/vnd.api+json' instead of '{contentType}' for the Content-Type header value.");
+            error.Source.Header.Should().Be("Content-Type");
         }
 
         [Fact]
@@ -225,6 +227,7 @@ public async Task Denies_JsonApi_ContentType_header_with_extension()
             error.StatusCode.Should().Be(HttpStatusCode.UnsupportedMediaType);
             error.Title.Should().Be("The specified Content-Type header value is not supported.");
             error.Detail.Should().Be($"Please specify 'application/vnd.api+json' instead of '{contentType}' for the Content-Type header value.");
+            error.Source.Header.Should().Be("Content-Type");
         }
 
         [Fact]
@@ -258,6 +261,7 @@ public async Task Denies_JsonApi_ContentType_header_with_AtomicOperations_extens
             error.StatusCode.Should().Be(HttpStatusCode.UnsupportedMediaType);
             error.Title.Should().Be("The specified Content-Type header value is not supported.");
             error.Detail.Should().Be($"Please specify 'application/vnd.api+json' instead of '{contentType}' for the Content-Type header value.");
+            error.Source.Header.Should().Be("Content-Type");
         }
 
         [Fact]
@@ -291,6 +295,7 @@ public async Task Denies_JsonApi_ContentType_header_with_CharSet()
             error.StatusCode.Should().Be(HttpStatusCode.UnsupportedMediaType);
             error.Title.Should().Be("The specified Content-Type header value is not supported.");
             error.Detail.Should().Be($"Please specify 'application/vnd.api+json' instead of '{contentType}' for the Content-Type header value.");
+            error.Source.Header.Should().Be("Content-Type");
         }
 
         [Fact]
@@ -324,6 +329,7 @@ public async Task Denies_JsonApi_ContentType_header_with_unknown_parameter()
             error.StatusCode.Should().Be(HttpStatusCode.UnsupportedMediaType);
             error.Title.Should().Be("The specified Content-Type header value is not supported.");
             error.Detail.Should().Be($"Please specify 'application/vnd.api+json' instead of '{contentType}' for the Content-Type header value.");
+            error.Source.Header.Should().Be("Content-Type");
         }
 
         [Fact]
@@ -367,6 +373,7 @@ public async Task Denies_JsonApi_ContentType_header_at_operations_endpoint()
             error.StatusCode.Should().Be(HttpStatusCode.UnsupportedMediaType);
             error.Title.Should().Be("The specified Content-Type header value is not supported.");
             error.Detail.Should().Be(detail);
+            error.Source.Header.Should().Be("Content-Type");
         }
     }
 }
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/Serialization/ETagTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/Serialization/ETagTests.cs
@@ -175,6 +175,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             error.StatusCode.Should().Be(HttpStatusCode.PreconditionFailed);
             error.Title.Should().Be("Detection of mid-air edit collisions using ETags is not supported.");
             error.Detail.Should().BeNull();
+            error.Source.Header.Should().Be("If-Match");
         }
 
         [Fact]

Original file line number	Diff line number	Diff line change
`@@ -198,6 +198,7 @@ public async Task Denies_JsonApi_with_parameters_in_Accept_headers()`
`198`	`198`	`error.StatusCode.Should().Be(HttpStatusCode.NotAcceptable);`
`199`	`199`	`error.Title.Should().Be("The specified Accept header value does not contain any supported media types.");`
`200`	`200`	`error.Detail.Should().Be("Please include 'application/vnd.api+json' in the Accept header values.");`
	`201`	`+ error.Source.Header.Should().Be("Accept");`
`201`	`202`	`}`
`202`	`203`
`203`	`204`	`[Fact]`
`@@ -244,6 +245,7 @@ public async Task Denies_JsonApi_in_Accept_headers_at_operations_endpoint()`
`244`	`245`	`error.StatusCode.Should().Be(HttpStatusCode.NotAcceptable);`
`245`	`246`	`error.Title.Should().Be("The specified Accept header value does not contain any supported media types.");`
`246`	`247`	`error.Detail.Should().Be("Please include 'application/vnd.api+json; ext=\"https://jsonapi.org/ext/atomic\"' in the Accept header values.");`
	`248`	`+ error.Source.Header.Should().Be("Accept");`
`247`	`249`	`}`
`248`	`250`	`}`
`249`	`251`	`}`
Original file line number	Diff line number	Diff line change
`@@ -99,6 +99,7 @@ public async Task Denies_unknown_ContentType_header()`
`99`	`99`	`error.StatusCode.Should().Be(HttpStatusCode.UnsupportedMediaType);`
`100`	`100`	`error.Title.Should().Be("The specified Content-Type header value is not supported.");`
`101`	`101`	`error.Detail.Should().Be("Please specify 'application/vnd.api+json' instead of 'text/html' for the Content-Type header value.");`
	`102`	`+ error.Source.Header.Should().Be("Content-Type");`
`102`	`103`	`}`
`103`	`104`
`104`	`105`	`[Fact]`
`@@ -192,6 +193,7 @@ public async Task Denies_JsonApi_ContentType_header_with_profile()`
`192`	`193`	`error.StatusCode.Should().Be(HttpStatusCode.UnsupportedMediaType);`
`193`	`194`	`error.Title.Should().Be("The specified Content-Type header value is not supported.");`
`194`	`195`	`error.Detail.Should().Be($"Please specify 'application/vnd.api+json' instead of '{contentType}' for the Content-Type header value.");`
	`196`	`+ error.Source.Header.Should().Be("Content-Type");`
`195`	`197`	`}`
`196`	`198`
`197`	`199`	`[Fact]`
`@@ -225,6 +227,7 @@ public async Task Denies_JsonApi_ContentType_header_with_extension()`
`225`	`227`	`error.StatusCode.Should().Be(HttpStatusCode.UnsupportedMediaType);`
`226`	`228`	`error.Title.Should().Be("The specified Content-Type header value is not supported.");`
`227`	`229`	`error.Detail.Should().Be($"Please specify 'application/vnd.api+json' instead of '{contentType}' for the Content-Type header value.");`
	`230`	`+ error.Source.Header.Should().Be("Content-Type");`
`228`	`231`	`}`
`229`	`232`
`230`	`233`	`[Fact]`
`@@ -258,6 +261,7 @@ public async Task Denies_JsonApi_ContentType_header_with_AtomicOperations_extens`
`258`	`261`	`error.StatusCode.Should().Be(HttpStatusCode.UnsupportedMediaType);`
`259`	`262`	`error.Title.Should().Be("The specified Content-Type header value is not supported.");`
`260`	`263`	`error.Detail.Should().Be($"Please specify 'application/vnd.api+json' instead of '{contentType}' for the Content-Type header value.");`
	`264`	`+ error.Source.Header.Should().Be("Content-Type");`
`261`	`265`	`}`
`262`	`266`
`263`	`267`	`[Fact]`
`@@ -291,6 +295,7 @@ public async Task Denies_JsonApi_ContentType_header_with_CharSet()`
`291`	`295`	`error.StatusCode.Should().Be(HttpStatusCode.UnsupportedMediaType);`
`292`	`296`	`error.Title.Should().Be("The specified Content-Type header value is not supported.");`
`293`	`297`	`error.Detail.Should().Be($"Please specify 'application/vnd.api+json' instead of '{contentType}' for the Content-Type header value.");`
	`298`	`+ error.Source.Header.Should().Be("Content-Type");`
`294`	`299`	`}`
`295`	`300`
`296`	`301`	`[Fact]`
`@@ -324,6 +329,7 @@ public async Task Denies_JsonApi_ContentType_header_with_unknown_parameter()`
`324`	`329`	`error.StatusCode.Should().Be(HttpStatusCode.UnsupportedMediaType);`
`325`	`330`	`error.Title.Should().Be("The specified Content-Type header value is not supported.");`
`326`	`331`	`error.Detail.Should().Be($"Please specify 'application/vnd.api+json' instead of '{contentType}' for the Content-Type header value.");`
	`332`	`+ error.Source.Header.Should().Be("Content-Type");`
`327`	`333`	`}`
`328`	`334`
`329`	`335`	`[Fact]`
`@@ -367,6 +373,7 @@ public async Task Denies_JsonApi_ContentType_header_at_operations_endpoint()`
`367`	`373`	`error.StatusCode.Should().Be(HttpStatusCode.UnsupportedMediaType);`
`368`	`374`	`error.Title.Should().Be("The specified Content-Type header value is not supported.");`
`369`	`375`	`error.Detail.Should().Be(detail);`
	`376`	`+ error.Source.Header.Should().Be("Content-Type");`
`370`	`377`	`}`
`371`	`378`	`}`
`372`	`379`	`}`
Original file line number	Diff line number	Diff line change
`@@ -175,6 +175,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>`
`175`	`175`	`error.StatusCode.Should().Be(HttpStatusCode.PreconditionFailed);`
`176`	`176`	`error.Title.Should().Be("Detection of mid-air edit collisions using ETags is not supported.");`
`177`	`177`	`error.Detail.Should().BeNull();`
	`178`	`+ error.Source.Header.Should().Be("If-Match");`
`178`	`179`	`}`
`179`	`180`
`180`	`181`	`[Fact]`