Merge pull request #60 from DoclerLabs/fix-request-parameters-with-same-name-but-different-refs

request parameters should use reference name when applicable

Author: vsouz4

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [7.2.3] - 2021-11-03
+### Fixed
+- Request parameters with same name but different $ref should not override each other
+
 ## [7.2.2] - 2021-10-15
 ### Fixed
 - ext- in generated clients composer.json is added according to what is actually being used

src/Input/Factory/RequestFactory.php

@@ -31,8 +31,10 @@ public function create(
         $contentTypes = [];
         $collection   = new RequestFieldRegistry();
         foreach ($parameters as $parameter) {
+            $referenceName = '';
             if ($parameter instanceof Reference) {
-                $parameter = $parameter->resolve();
+                $referenceName = SchemaNaming::getClassName($parameter);
+                $parameter     = $parameter->resolve();
             }
             $collection->add(
                 $parameter->in,
@@ -41,7 +43,7 @@ public function create(
                     $parameter->name,
                     $parameter->schema,
                     $parameter->required,
-                    ''
+                    $referenceName
                 )
             );
         }

src/Naming/SchemaNaming.php

@@ -11,9 +11,9 @@
 
 class SchemaNaming
 {
-    private const OPENAPI_COMPONENT_TYPE = 'schemas';
+    private const OPENAPI_COMPONENT_TYPES = ['schemas', 'parameters'];
 
-    public static function getClassName(SpecObjectInterface $reference, string $fallbackName): string
+    public static function getClassName(SpecObjectInterface $reference, string $fallbackName = ''): string
     {
         if (!($reference instanceof Reference)) {
             $fallbackName   = CaseCaster::toPascal($fallbackName);
@@ -29,8 +29,8 @@ public static function getClassName(SpecObjectInterface $reference, string $fall
         $referencePath = $reference->getReference();
         $referencePath = explode('/', $referencePath);
         $referencePath = array_reverse($referencePath);
-        if ($referencePath[1] !== self::OPENAPI_COMPONENT_TYPE) {
-            throw new UnexpectedValueException('Only schema components are supported to be entities.');
+        if (!in_array($referencePath[1], self::OPENAPI_COMPONENT_TYPES, true)) {
+            throw new UnexpectedValueException('Only schema and parameter components are supported to be entities.');
         }
 
         return CaseCaster::toPascal($referencePath[0]);

test/suite/functional/Generator/Request/GetResourcesRequest.php

@@ -10,6 +10,7 @@
 
 namespace Test\Request;
 
+use Test\Schema\ResourceFilter;
 use Test\Schema\SerializableInterface;
 
 class GetResourcesRequest implements RequestInterface
@@ -20,6 +21,8 @@ class GetResourcesRequest implements RequestInterface
 
     private ?array $filterByIds = null;
 
+    private ?ResourceFilter $filter = null;
+
     private string $contentType = '';
 
     public function getContentType(): string
@@ -51,6 +54,13 @@ public function setFilterByIds(array $filterByIds): self
         return $this;
     }
 
+    public function setFilter(ResourceFilter $filter): self
+    {
+        $this->filter = $filter;
+
+        return $this;
+    }
+
     public function getMethod(): string
     {
         return 'GET';
@@ -65,14 +75,14 @@ public function getQueryParameters(): array
     {
         return \array_map(static function ($value) {
             return $value instanceof SerializableInterface ? $value->toArray() : $value;
-        }, \array_filter(['filterById' => $this->filterById, 'filterByName' => $this->filterByName, 'filterByIds' => $this->filterByIds], static function ($value) {
+        }, \array_filter(['filterById' => $this->filterById, 'filterByName' => $this->filterByName, 'filterByIds' => $this->filterByIds, 'filter' => $this->filter], static function ($value) {
             return null !== $value;
         }));
     }
 
     public function getRawQueryParameters(): array
     {
-        return ['filterById' => $this->filterById, 'filterByName' => $this->filterByName, 'filterByIds' => $this->filterByIds];
+        return ['filterById' => $this->filterById, 'filterByName' => $this->filterByName, 'filterByIds' => $this->filterByIds, 'filter' => $this->filter];
     }
 
     public function getCookies(): array

test/suite/functional/Generator/Request/GetSubResourcesRequest.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file was generated by docler-labs/api-client-generator.
+ *
+ * Do not edit it manually.
+ */
+
+namespace Test\Request;
+
+use Test\Schema\SerializableInterface;
+use Test\Schema\SubResourceFilter;
+
+class GetSubResourcesRequest implements RequestInterface
+{
+    private ?SubResourceFilter $filter = null;
+
+    private string $contentType = '';
+
+    public function getContentType(): string
+    {
+        return $this->contentType;
+    }
+
+    public function setFilter(SubResourceFilter $filter): self
+    {
+        $this->filter = $filter;
+
+        return $this;
+    }
+
+    public function getMethod(): string
+    {
+        return 'GET';
+    }
+
+    public function getRoute(): string
+    {
+        return 'v1/resources/sub-resources';
+    }
+
+    public function getQueryParameters(): array
+    {
+        return \array_map(static function ($value) {
+            return $value instanceof SerializableInterface ? $value->toArray() : $value;
+        }, \array_filter(['filter' => $this->filter], static function ($value) {
+            return null !== $value;
+        }));
+    }
+
+    public function getRawQueryParameters(): array
+    {
+        return ['filter' => $this->filter];
+    }
+
+    public function getCookies(): array
+    {
+        return [];
+    }
+
+    public function getHeaders(): array
+    {
+        return [];
+    }
+
+    public function getBody()
+    {
+        return null;
+    }
+}

test/suite/functional/Generator/Request/getResources.yaml

@@ -11,6 +11,24 @@ paths:
         - $ref: '#/components/parameters/FilterById'
         - $ref: '#/components/parameters/FilterByName'
         - $ref: '#/components/parameters/FilterByIds'
+        - $ref: '#/components/parameters/ResourceFilter'
+      responses:
+        '200':
+          description: list of resources
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Resource'
+        '400':
+          description: Invalid request parameters.
+  '/v1/resources/sub-resources':
+    get:
+      description: Get a list of sub resources
+      operationId: getSubResources
+      parameters:
+        - $ref: '#/components/parameters/SubResourceFilter'
       responses:
         '200':
           description: list of resources
@@ -47,3 +65,19 @@ components:
         type: array
         items:
           type: integer
+    ResourceFilter:
+      name: filter
+      in: query
+      schema:
+        type: object
+        properties:
+          prop1:
+            type: string
+    SubResourceFilter:
+      name: filter
+      in: query
+      schema:
+        type: object
+        properties:
+          prop1:
+            type: integer

test/suite/functional/Generator/RequestGeneratorTest.php

@@ -33,6 +33,12 @@ public function exampleProvider(): array
                 self::BASE_NAMESPACE . RequestGenerator::NAMESPACE_SUBPATH . '\\GetResourcesRequest',
                 ConfigurationBuilder::fake()->build(),
             ],
+            'Request with same parameter name but different parameters' => [
+                '/Request/getResources.yaml',
+                '/Request/GetSubResourcesRequest.php',
+                self::BASE_NAMESPACE . RequestGenerator::NAMESPACE_SUBPATH . '\\GetSubResourcesRequest',
+                ConfigurationBuilder::fake()->build(),
+            ],
         ];
     }