Add error ID member support

Author: tobyzerner

CHANGELOG.md

@@ -37,6 +37,7 @@ and this project adheres to
 - Add `Resource::links()` method for defining custom resource-level links
   (including `describedby`)
 - Add `Schema\Link` class for defining rich link objects with metadata
+- Add `JsonApiError::id(string $id)` method for setting error IDs
 - Add full support for JSON:API profiles:
     - Parse profile URIs from `Accept` header
     - `Context::profileRequested(string $uri): bool` - check if a profile was

src/Exception/Concerns/JsonApiError.php

@@ -48,6 +48,13 @@ public function links(array $links): static
         return $this;
     }
 
+    public function id(string $id): static
+    {
+        $this->error['id'] = $id;
+
+        return $this;
+    }
+
     public function getJsonApiError(): array
     {
         $class = (new ReflectionClass($this))->getShortName();

tests/feature/ErrorTest.php

@@ -154,4 +154,44 @@ public function test_multiple_errors_most_applicable_status()
 
         $this->assertEquals(500, $response->getStatusCode());
     }
+
+    public function test_error_id_can_be_set_via_fluent_method()
+    {
+        $response = $this->api->error((new MockErrorException())->id('error-12345'));
+
+        $this->assertJsonApiDocumentSubset(
+            [
+                'errors' => [
+                    [
+                        'id' => 'error-12345',
+                        'status' => '400',
+                    ],
+                ],
+            ],
+            $response->getBody(),
+        );
+    }
+
+    public function test_error_id_can_be_set_via_customization()
+    {
+        $this->api->errors([
+            MockErrorException::class => [
+                'id' => 'custom-error-id',
+            ],
+        ]);
+
+        $response = $this->api->error(new MockErrorException());
+
+        $this->assertJsonApiDocumentSubset(
+            [
+                'errors' => [
+                    [
+                        'id' => 'custom-error-id',
+                        'status' => '400',
+                    ],
+                ],
+            ],
+            $response->getBody(),
+        );
+    }
 }