fix: errors retrieval and documentation (#6952)

Author: soyuka

Action/ErrorPageAction.php

@@ -115,7 +115,7 @@ public function load(array $configs, ContainerBuilder $container): void
         $jsonSchemaFormats = $config['jsonschema_formats'];
 
         if (!$jsonSchemaFormats) {
-            foreach (array_keys($formats) as $f) {
+            foreach (array_merge(array_keys($formats), array_keys($errorFormats)) as $f) {
                 // Distinct JSON-based formats must have names that start with 'json'
                 if (str_starts_with($f, 'json')) {
                     $jsonSchemaFormats[$f] = true;

Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -13,7 +13,6 @@
         <service id="api_platform.property_accessor" alias="property_accessor" public="false" />
         <service id="api_platform.property_info" alias="property_info" public="false" />
         <service id="api_platform.negotiator" class="Negotiation\Negotiator" public="false" />
-        <service id="api_platform.action.error_page" class="ApiPlatform\Symfony\Action\ErrorPageAction" public="true" />
 
         <service id="api_platform.resource_class_resolver" class="ApiPlatform\Metadata\ResourceClassResolver" public="false">
             <argument type="service" id="api_platform.metadata.resource.name_collection_factory" />
@@ -166,6 +165,7 @@
         <service id="api_platform.state.error_provider" class="ApiPlatform\State\ErrorProvider">
             <argument key="$debug">%kernel.debug%</argument>
             <argument type="service" key="$resourceClassResolver" id="api_platform.resource_class_resolver" />
+            <argument type="service" key="$resourceMetadataCollectionFactory" id="api_platform.metadata.resource.metadata_collection_factory" />
             <tag name="api_platform.state_provider" key="api_platform.state.error_provider" />
         </service>
 

Bundle/Resources/config/api.xml

@@ -93,6 +93,7 @@
             <argument type="service" id="api_platform.openapi.options" />
             <argument type="service" id="api_platform.pagination_options" />
             <argument type="service" id="api_platform.router" />
+            <argument>%api_platform.error_formats%</argument>
         </service>
 
         <service id="api_platform.cache.openapi" parent="cache.system" public="false">

Bundle/Resources/config/openapi.xml

@@ -5,12 +5,6 @@
         xsi:schemaLocation="http://symfony.com/schema/routing
         http://symfony.com/schema/routing/routing-1.0.xsd">
 
-    <route id="api_errors" path="/errors/{status}" methods="GET|HEAD">
-        <default key="_controller">api_platform.action.error_page</default>
-
-        <requirement key="status">\d+</requirement>
-    </route>
-
     <route id="api_validation_errors" path="/validation_errors/{id}" methods="GET|HEAD">
         <default key="_controller">api_platform.action.not_exposed</default>
     </route>

Bundle/Resources/config/routing/errors.xml

@@ -74,6 +74,7 @@ class: OpenApi::class,
 
         // save our operation
         $request->attributes->set('_api_operation', $swaggerUiOperation);
+
         $data = $this->openApiFactory->__invoke([
             'base_url' => $request->getBaseUrl() ?: '/',
             'filter_tags' => $request->query->all('filter_tags'),

Bundle/SwaggerUi/SwaggerUiProvider.php

@@ -13,7 +13,6 @@
 
 namespace ApiPlatform\Symfony\Controller;
 
-use ApiPlatform\Metadata\Error;
 use ApiPlatform\Metadata\Exception\InvalidIdentifierException;
 use ApiPlatform\Metadata\Exception\InvalidUriVariableException;
 use ApiPlatform\Metadata\Exception\RuntimeException;
@@ -48,12 +47,13 @@ public function __construct(
     public function __invoke(Request $request): Response
     {
         $operation = $this->initializeOperation($request);
+
         if (!$operation) {
             throw new RuntimeException('Not an API operation.');
         }
 
         $uriVariables = [];
-        if (!$operation instanceof Error) {
+        if (!$request->attributes->has('exception')) {
             try {
                 $uriVariables = $this->getOperationUriVariables($operation, $request->attributes->all(), $operation->getClass());
                 $request->attributes->set('_api_uri_variables', $uriVariables);
@@ -86,7 +86,7 @@ public function __invoke(Request $request): Response
         if ($request->attributes->get('_api_operation') !== $operation) {
             $operation = $this->initializeOperation($request);
 
-            if (!$operation instanceof Error) {
+            if (!$request->attributes->has('exception')) {
                 try {
                     $uriVariables = $this->getOperationUriVariables($operation, $request->attributes->all(), $operation->getClass());
                 } catch (InvalidIdentifierException|InvalidUriVariableException $e) {

Controller/MainController.php

@@ -13,7 +13,6 @@
 
 namespace ApiPlatform\Symfony\EventListener;
 
-use ApiPlatform\Metadata\Error;
 use ApiPlatform\Metadata\Exception\InvalidIdentifierException;
 use ApiPlatform\Metadata\Exception\InvalidUriVariableException;
 use ApiPlatform\Metadata\HttpOperation;
@@ -73,7 +72,7 @@ public function onKernelRequest(RequestEvent $event): void
         }
 
         $uriVariables = [];
-        if (!$operation instanceof Error && $operation instanceof HttpOperation) {
+        if (!$request->attributes->has('exception') && $operation instanceof HttpOperation) {
             try {
                 $uriVariables = $this->getOperationUriVariables($operation, $request->attributes->all(), $operation->getClass());
             } catch (InvalidIdentifierException|InvalidUriVariableException $e) {