Merge branch 'release/4.2.0'

CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file. This projec
 
 ## Unreleased
 
+## [4.2.0] - 2024-08-21
+
+### Added
+
+- Response classes now have a `withoutHeaders()` method to remove headers from the response.
+
+### Fixed
+
+- [#18](https://github.com/laravel-json-api/core/pull/18) Ensure headers are merged when using the `withHeaders()`
+  method on the JSON:API response classes. This was previously not merging headers, which was not correct and therefore
+  this is a bug fix. If you were relying on this behaviour, use the new `withoutHeaders()` method to remove any headers.
+
 ## [4.1.0] - 2024-06-26
 
 ### Fixed

src/Core/Responses/Concerns/IsResponsable.php

@@ -158,7 +158,22 @@ public function withHeader(string $name, string $value = null): self
      */
     public function withHeaders(array $headers): self
     {
-        $this->headers = $headers;
+        $this->headers = array_merge($this->headers, $headers);
+
+        return $this;
+    }
+
+    /**
+     * Remove response headers.
+     *
+     * @param string ...$headers
+     * @return $this
+     */
+    public function withoutHeaders(string ...$headers): self
+    {
+        foreach ($headers as $header) {
+            unset($this->headers[$header]);
+        }
 
         return $this;
     }
@@ -170,7 +185,7 @@ protected function headers(): array
     {
         return array_merge(
             ['Content-Type' => 'application/vnd.api+json'],
-            $this->headers ?: [],
+            $this->headers,
         );
     }