renaming Body attribute with Payload

Author: yceruto

README.md

@@ -27,15 +27,15 @@ Define your OpenAPI spec and endpoint at the same time:
 namespace Api\Catalog\Controller\Post;
 
 use Api\Catalog\Model\Product;
-use OpenSolid\OpenApiBundle\Attribute\Body;
+use OpenSolid\OpenApiBundle\Attribute\Payload;
 use OpenSolid\OpenApiBundle\Routing\Attribute\Post;
 
 class PostProductAction
 {
     #[Post('/products')]
-    public function __invoke(#[Body] PostProductBody $body): Product
+    public function __invoke(#[Payload] PostProductPayload $Payload): Product
     {
-        return new Product($body->name, $body->price);
+        return new Product($body->name, $Payload->price);
     }
 }
 ```
@@ -52,7 +52,7 @@ class PostProductAction
 - [x] Conditional OpenAPI Path/Route definition:
   - Example: `#[Get('/me', when: 'service("toggle_me").isEnabled()')]`
 - [x] Symfony attributes abbreviations:
-  - `#[Body]` instead of `#[MapRequestPayload]`
+  - `#[Payload]` instead of `#[MapRequestPayload]`
   - `#[Query]` instead of `#[MapQueryString]`
 - [x] OpenAPI attributes abbreviations:
   - `#[Path]` instead of `#[PathParameter]`

composer.json

@@ -7,7 +7,7 @@
     "authors": [
         {
             "name": "Yonel Ceruto",
-            "email": "yonelceruto@gmail.com"
+            "email": "open@yceruto.dev"
         }
     ],
     "require": {

src/Attribute/Body.php src/Attribute/Payload.phpsrc/Attribute/Body.php renamed to src/Attribute/Payload.php

@@ -8,7 +8,7 @@
 use Symfony\Component\Validator\Constraints\GroupSequence;
 
 #[\Attribute(\Attribute::TARGET_PARAMETER)]
-class Body extends MapRequestPayload
+class Payload extends MapRequestPayload
 {
     public function __construct(
         array|string|null $acceptFormat = null,

src/HttpKernel/Controller/ArgumentResolver/RequestPayloadArrayResolver.php

@@ -2,7 +2,7 @@
 
 namespace OpenSolid\OpenApiBundle\HttpKernel\Controller\ArgumentResolver;
 
-use OpenSolid\OpenApiBundle\Attribute\Body;
+use OpenSolid\OpenApiBundle\Attribute\Payload;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -69,7 +69,7 @@ public function resolve(Request $request, ArgumentMetadata $argument): iterable
             return [$attribute];
         }
 
-        if ($attribute instanceof Body && null !== $attribute->itemsType) {
+        if ($attribute instanceof Payload && null !== $attribute->itemsType) {
             $attribute->metadata = new ArgumentMetadata(
                 $argument->getName(),
                 $attribute->itemsType.'[]',

src/OpenApi/Analyser/Guesser/Operation/OperationRequestBodyGuesser.php

@@ -7,7 +7,7 @@
 use OpenApi\Attributes as OA;
 use OpenApi\Context;
 use OpenApi\Generator;
-use OpenSolid\OpenApiBundle\Attribute\Body;
+use OpenSolid\OpenApiBundle\Attribute\Payload;
 use OpenSolid\OpenApiBundle\OpenApi\Analyser\Guesser\AnalyserGuesserInterface;
 
 class OperationRequestBodyGuesser implements AnalyserGuesserInterface
@@ -27,7 +27,7 @@ public function guess(\Reflector $reflector, AbstractAnnotation $annotation, Con
         }
 
         foreach ($reflector->getParameters() as $rp) {
-            foreach ($rp->getAttributes(Body::class, \ReflectionAttribute::IS_INSTANCEOF) as $attribute) {
+            foreach ($rp->getAttributes(Payload::class, \ReflectionAttribute::IS_INSTANCEOF) as $attribute) {
                 $type = (($rnt = $rp->getType()) && $rnt instanceof \ReflectionNamedType) ? $rnt->getName() : null;
 
                 if (null === $type) {

tests/Functional/App/CustomResponseSpec/Controller/PostResourceAction.php

@@ -2,13 +2,13 @@
 
 namespace OpenSolid\Tests\OpenApiBundle\Functional\App\CustomResponseSpec\Controller;
 
-use OpenSolid\OpenApiBundle\Attribute\Body;
+use OpenSolid\OpenApiBundle\Attribute\Payload;
 use OpenSolid\OpenApiBundle\Routing\Attribute\Post;
 
 class PostResourceAction
 {
     #[Post('/resources')]
-    public function __invoke(#[Body] PostResourceBody $body): void
+    public function __invoke(#[Payload] PostResourcePayload $payload): void
     {
     }
 }

…onseSpec/Controller/PostResourceBody.php …eSpec/Controller/PostResourcePayload.phptests/Functional/App/CustomResponseSpec/Controller/PostResourceBody.php renamed to tests/Functional/App/CustomResponseSpec/Controller/PostResourcePayload.php tests/Functional/App/CustomResponseSpec/Controller/PostResourceBody.php renamed to tests/Functional/App/CustomResponseSpec/Controller/PostResourcePayload.php

@@ -6,7 +6,7 @@
 use OpenSolid\OpenApiBundle\Attribute\Property;
 
 #[Schema(writeOnly: true)]
-class PostResourceBody
+class PostResourcePayload
 {
     #[Property(minLength: 3)]
     public string $name;

tests/Functional/App/CustomResponseSpec/Output/doc.json

@@ -18,7 +18,7 @@
                     "content": {
                         "application/json": {
                             "schema": {
-                                "$ref": "#/components/schemas/PostResourceBody"
+                                "$ref": "#/components/schemas/PostResourcePayload"
                             }
                         }
                     }
@@ -39,7 +39,7 @@
     },
     "components": {
         "schemas": {
-            "PostResourceBody": {
+            "PostResourcePayload": {
                 "required": [
                     "name"
                 ],
@@ -149,4 +149,4 @@
             }
         }
     }
-}
+}

tests/Functional/App/PatchResourceAction/Controller/PatchResourceAction.php

@@ -2,15 +2,15 @@
 
 namespace OpenSolid\Tests\OpenApiBundle\Functional\App\PatchResourceAction\Controller;
 
-use OpenSolid\OpenApiBundle\Attribute\Body;
+use OpenSolid\OpenApiBundle\Attribute\Payload;
 use OpenSolid\OpenApiBundle\Routing\Attribute\Patch;
 use OpenSolid\Tests\OpenApiBundle\Functional\App\PatchResourceAction\Model\ResourceView;
 
 class PatchResourceAction
 {
     #[Patch('/resources')]
-    public function __invoke(#[Body] PatchResourceBody $body): ResourceView
+    public function __invoke(#[Payload] PatchResourcePayload $payload): ResourceView
     {
-        return ResourceView::from('4f09d694-446a-4769-9929-dad96a071cad', $body->name);
+        return ResourceView::from('4f09d694-446a-4769-9929-dad96a071cad', $payload->name);
     }
 }

…eAction/Controller/PatchResourceBody.php …tion/Controller/PatchResourcePayload.phptests/Functional/App/PatchResourceAction/Controller/PatchResourceBody.php renamed to tests/Functional/App/PatchResourceAction/Controller/PatchResourcePayload.php tests/Functional/App/PatchResourceAction/Controller/PatchResourceBody.php renamed to tests/Functional/App/PatchResourceAction/Controller/PatchResourcePayload.php

@@ -6,7 +6,7 @@
 use OpenSolid\OpenApiBundle\Attribute\Property;
 
 #[Schema(writeOnly: true)]
-class PatchResourceBody
+class PatchResourcePayload
 {
     #[Property]
     public ?string $name = null;