fix: json formatted resource should not get xml errors #7287

Author: soyuka

src/State/ApiResource/Error.php

@@ -38,7 +38,6 @@
             routeName: '_api_errors',
             outputFormats: [
                 'json' => ['application/problem+json', 'application/json'],
-                'xml' => ['application/xml', 'text/xml'],
             ],
             hideHydraOperation: true,
             normalizationContext: [
@@ -75,6 +74,21 @@
                 'ignored_attributes' => ['trace', 'file', 'line', 'code', 'message', 'traceAsString', 'previous'],
             ],
         ),
+        new Operation(
+            errors: [],
+            name: '_api_errors_xml',
+            routeName: '_api_errors',
+            outputFormats: [
+                'xml' => ['application/xml', 'text/xml'],
+            ],
+            hideHydraOperation: true,
+            normalizationContext: [
+                SchemaFactory::OPENAPI_DEFINITION_NAME => '',
+                'groups' => ['jsonproblem'],
+                'skip_null_values' => true,
+                'ignored_attributes' => ['trace', 'file', 'line', 'code', 'message', 'traceAsString', 'previous'],
+            ],
+        ),
         new Operation(
             name: '_api_errors',
             hideHydraOperation: true,

src/Validator/Exception/ValidationException.php

@@ -51,7 +51,6 @@
             name: '_api_validation_errors_problem',
             outputFormats: [
                 'json' => ['application/problem+json'],
-                'xml' => ['application/xml', 'text/xml'],
             ],
             normalizationContext: [
                 'groups' => ['json'],
@@ -79,6 +78,17 @@
                 'ignored_attributes' => ['trace', 'file', 'line', 'code', 'message', 'traceAsString', 'previous'],
             ]
         ),
+        new ErrorOperation(
+            name: '_api_validation_errors_problem',
+            outputFormats: [
+                'xml' => ['application/xml', 'text/xml'],
+            ],
+            normalizationContext: [
+                'groups' => ['json'],
+                'ignored_attributes' => ['trace', 'file', 'line', 'code', 'message', 'traceAsString', 'previous'],
+                'skip_null_values' => true,
+            ]
+        ),
     ],
     graphQlOperations: []
 )]

tests/Fixtures/TestBundle/ApiResource/Issue7287/OperationWithDefaultFormat.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue7287;
+
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\GetCollection;
+use ApiPlatform\Metadata\NotExposed;
+
+#[ApiResource(
+    outputFormats: ['jsonld'],
+    operations: [
+        new GetCollection(provider: [self::class, 'provide']),
+        new NotExposed(uriVariables: ['id']),
+    ]
+)]
+class OperationWithDefaultFormat
+{
+    public function __construct(
+        public string $id,
+    ) {
+    }
+
+    public static function provide(): array
+    {
+        return [new self('1')];
+    }
+}

tests/Functional/ErrorTest.php

@@ -15,6 +15,7 @@
 
 use ApiPlatform\State\ApiResource\Error;
 use ApiPlatform\Symfony\Bundle\Test\ApiTestCase;
+use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue7287\OperationWithDefaultFormat;
 use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\XmlWithJsonError;
 use ApiPlatform\Tests\SetupClassResourcesTrait;
 use PHPUnit\Framework\Attributes\DataProvider;
@@ -30,7 +31,7 @@ final class ErrorTest extends ApiTestCase
      */
     public static function getResources(): array
     {
-        return [Error::class, XmlWithJsonError::class];
+        return [Error::class, XmlWithJsonError::class, OperationWithDefaultFormat::class];
     }
 
     #[DataProvider('formatsProvider')]
@@ -108,4 +109,14 @@ public function testXmlError(): void
         $this->assertResponseStatusCodeSame(404);
         $this->assertResponseHeaderSame('content-type', 'application/xml; charset=utf-8');
     }
+
+    public function testNotAcceptableXml(): void
+    {
+        self::createClient()->request('GET', '/operation_with_default_formats', [
+            'headers' => ['accept' => 'text/xml'],
+        ]);
+
+        $this->assertJsonContains(['detail' => 'Requested format "text/xml" is not supported. Supported MIME types are "application/ld+json".']);
+        $this->assertResponseStatusCodeSame(406);
+    }
 }