allow define docs request model by endpoint mapping (#206)

troytft · Apr 21, 2022 · fbe7016 · fbe7016
1 parent 8024b5f
commit fbe7016
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/src/Mapping/OpenApi/Endpoint.php b/src/Mapping/OpenApi/Endpoint.php
@@ -19,21 +19,24 @@ class Endpoint
     public ?string $description;
     /** @var string[]|string */
     public $tags;
+    public ?string $requestModel;
 
     /**
      * @param array|string $options
      * @param string[]|string $tags
      */
-    public function __construct($options = [], string $title = '', ?string $description = null, $tags = [])
+    public function __construct($options = [], string $title = '', ?string $description = null, $tags = [], ?string $requestModel = null)
     {
         if (is_string($options)) {
             $this->title = $options;
             $this->description = $description;
             $this->tags = $tags;
+            $this->requestModel = $requestModel;
         } elseif (is_array($options)) {
             $this->title = $options['title'] ?? $options['value'] ?? $title;
             $this->description = $options['description'] ?? $description;
             $this->tags = $options['tags'] ?? $tags;
+            $this->requestModel = $options['requestModel'] ?? $requestModel;
         } else {
             throw new \InvalidArgumentException();
         }

diff --git a/src/Services/OpenApi/SchemaGenerator.php b/src/Services/OpenApi/SchemaGenerator.php
@@ -203,6 +203,12 @@ private function createOperation(RestApiBundle\Model\OpenApi\EndpointData $endpo
             }
         }
 
+        if ($requestModelType && $endpointData->endpointMapping->requestModel) {
+            throw new RestApiBundle\Exception\ContextAware\ReflectionMethodAwareException('RequestModel already defined by action arguments', $endpointData->reflectionMethod);
+        } elseif ($endpointData->endpointMapping->requestModel) {
+            $requestModelType = new PropertyInfo\Type(PropertyInfo\Type::BUILTIN_TYPE_OBJECT, false, $endpointData->endpointMapping->requestModel);
+        }
+
         if ($requestModelType && $httpMethod === HttpFoundation\Request::METHOD_GET) {
             $operationParameters = array_merge($operationParameters, $this->createQueryParametersFromRequestModel($requestModelType->getClassName()));
         } elseif ($requestModelType) {