minor #20475 [HttpKernel] [MapQueryString] Add docs for new key option (feymo)

javiereguiluz · javiereguiluz · commit 8059ecee45a0 · 2024-12-19T17:43:40.000+01:00
This PR was merged into the 7.3 branch. Discussion ---------- [HttpKernel] [MapQueryString] Add docs for new key option Will fix #20463 Add documentation for the new `key` option added to `MapQueryString` attribute added in symfony/symfony#59157 Commits ------- 2fdd0db docs(controller): add docs for key option in MapQueryString
diff --git a/controller.rst b/controller.rst
@@ -443,6 +443,27 @@ HTTP status to return if the validation fails::
 
 The default status code returned if the validation fails is 404.
 
+If you want to map your object to a nested array in your query with a specific key,
+you can use the ``key`` option in your :class:`Symfony\\Component\\HttpKernel\\Attribute\\MapQueryString`
+attribute::
+
+    use App\Model\SearchDto;
+    use Symfony\Component\HttpFoundation\Response;
+    use Symfony\Component\HttpKernel\Attribute\MapQueryString;
+
+    // ...
+
+    public function dashboard(
+        #[MapQueryString(key: 'search')] SearchDto $searchDto
+    ): Response
+    {
+        // ...
+    }
+
+.. versionadded:: 7.3
+
+    The ``key`` option of ``#[MapQueryString]`` was introduced in Symfony 7.3.
+
 If you need a valid DTO even when the request query string is empty, set a
 default value for your controller arguments::
 
