documentation update

DependencyInjection/NelmioApiDocExtension.php

@@ -181,7 +181,7 @@ public function load(array $configs, ContainerBuilder $container): void
         }
 
         if (PHP_VERSION_ID > 80100) {
-            // Add autoconfiguration for inline parameter describer
+            // Add autoconfiguration for route argument describer
             $container->registerForAutoconfiguration(RouteArgumentDescriberInterface::class)
                 ->addTag('nelmio_api_doc.route_argument_describer');
 

Processors/MapQueryStringProcessor.php

@@ -14,7 +14,7 @@
 
 /**
  * A processor that adds query parameters to operations that have a MapQueryString attribute.
- * A processor is used to ensure that a Model is created.
+ * A processor is used to ensure that a Model has been created.
  *
  * @see SymfonyMapQueryStringDescriber
  */

Processors/MapRequestPayloadProcessor.php

@@ -14,7 +14,7 @@
 
 /**
  * A processor that adds query parameters to operations that have a MapRequestPayload attribute.
- * A processor is used to ensure that a Model is created.
+ * A processor is used to ensure that a Model has been created.
  *
  * @see SymfonyMapRequestPayloadDescriber
  */

Resources/doc/symfony_attributes.rst

@@ -149,11 +149,52 @@ Complete example
             }
         }
 
+Customization
+----------------------
+
+Imagine you want to add, modify, or remove some documentation for a route argument. For that you will have to create your own describer which implements the :class:`RouteArgumentDescriberInterface`_ interface.
+
+Register your route argument describer
+~~~~~~~
+
+Before you can use your custom describer you must register it in your route argument describer as a service and tag it with ``nelmio_api_doc.route_argument_describer``.
+Services implementing the :class:`RouteArgumentDescriberInterface`_ interface are automatically detected and used by NelmioApiDocBundle.
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        # config/services.yaml
+        services:
+            App\Describer\CustomRouteArgumentDescriber:
+                tags:
+                    - { name: nelmio_api_doc.route_argument_describer }
+
+    .. code-block:: xml
+
+        <!-- config/services.xml -->
+        <service id="App\Describer\CustomRouteArgumentDescriber">
+            <tag name="nelmio_api_doc.route_argument_describer" />
+        </service>
+
+    .. code-block:: php
+
+        // config/services.php
+        use App\Describer\CustomRouteArgumentDescriber;
+
+        return function (ContainerConfigurator $container) {
+            $container->services()
+                ->set(CustomRouteArgumentDescriber::class)
+                ->tag('nelmio_api_doc.route_argument_describer')
+            ;
+        };
+
 Disclaimer
 ----------------------
 
-Make sure to use at least php 8 (annotations) to make use of this functionality
+Make sure to use at least php 8.1 (attribute support) to make use of this functionality.
 
 .. _`Symfony MapQueryString`: https://symfony.com/doc/current/controller.html#mapping-the-whole-query-string
 .. _`Symfony MapQueryParameter`: https://symfony.com/doc/current/controller.html#mapping-query-parameters-individually
 .. _`Symfony MapRequestPayload`: https://symfony.com/doc/current/controller.html#mapping-request-payload
+.. _`RouteArgumentDescriberInterface`: https://github.com/DjordyKoert/NelmioApiDocBundle/blob/master/RouteDescriber/RouteArgumentDescriber/SymfonyMapQueryParameterDescriber.php