Merge parameter definitions. Fixes #16 (#17)

DerManoMann · Feb 23, 2018 · a98e045 · a98e045
1 parent 6810019
commit a98e045
Show file tree

Hide file tree

Showing 6 changed files with 131 additions and 5 deletions.
diff --git a/Readme.md b/Readme.md
@@ -208,3 +208,6 @@ For a more complete example have a look at the included Symfony Console command.
 
 ### v3.0.3
 * Allow to specify multiple source locations on command line [#14]
+
+### v3.0.4
+* Finally merge auto-generated and annotated parameter definitions [#16]
diff --git a/src/Swagger/S2SConverter.php b/src/Swagger/S2SConverter.php
@@ -248,18 +248,22 @@ protected function migrateRequest(SLX\Request $request, Context $context, array
                 }
 
                 if (is_array($swgOperation->$key) && is_array($value) && 'parameters' == $key) {
-                    // TODO: check for matching values; ie matching property names and then merge on value level
                     foreach ($value as $parameter) {
-                        // does that parameter already exist?
                         $merged = false;
                         foreach ($swgOperation->$key as $cp) {
-                            if ($cp->name == $parameter->name) {
-                                $merged = true;
-                                // todo: merge!
+                            // does that parameter already exist?
+                            if ($cp->name == $parameter->name && $cp->in == $parameter->in) {
+                                foreach (array_keys(SWG\Parameter::$_types) as $pkey) {
+                                    if ($parameter->$pkey) {
+                                        $cp->$pkey = $parameter->$pkey;
+                                        $merged = true;
+                                    }
+                                }
                                 break;
                             }
                         }
                         if (!$merged) {
+                            // not merged, so lets add it
                             $swgOperation->{$key}[] = $parameter;
                         }
                     }

diff --git a/tests/Controller/ParameterMergeController.php b/tests/Controller/ParameterMergeController.php
@@ -0,0 +1,33 @@
+<?php
+
+namespace Radebatz\Silex2Swagger\Tests\Controller;
+
+use DDesrosiers\SilexAnnotations\Annotations as SLX;
+use Swagger\Annotations as SWG;
+use Radebatz\Silex2Swagger\Swagger\Annotations as S2S;
+
+/**
+ * @SLX\Controller(prefix="/request")
+ */
+class CustomRequestController
+{
+    /**
+     * @SLX\Route(
+     *   @S2S\Request(method="GET", uri="get/{userId}",
+     *     @S2S\SwaggerProperty(name="consumes", value={"application/x-www-form-urlencoded"})
+     *   ),
+     *
+     *   @SWG\Parameter(
+     *     name="userId",
+     *     in="path",
+     *     description="User ID"
+     *   ),
+     *
+     *   @SWG\Response(response=200, description="GET")
+     * )
+     */
+    public function testCustomRequest($userId)
+    {
+        return '';
+    }
+}
diff --git a/tests/Fixtures/auto.json b/tests/Fixtures/auto.json
@@ -28,6 +28,31 @@
                 }
             }
         },
+        "\/request\/get\/{userId}": {
+            "get": {
+                "summary": "GET:\/request\/get\/{userId}",
+                "description": "GET:\/request\/get\/{userId}",
+                "operationId": "testCustomRequest",
+                "consumes": [
+                    "application\/x-www-form-urlencoded"
+                ],
+                "parameters": [
+                    {
+                        "parameter": "userId",
+                        "name": "userId",
+                        "in": "path",
+                        "description": "User ID",
+                        "required": true,
+                        "type": "string"
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "GET"
+                    }
+                }
+            }
+        },
         "\/shared_all\/get": {
             "get": {
                 "summary": "GET:\/shared_all\/get",
@@ -185,6 +210,11 @@
         }
     },
     "parameters": {
+        "userId": {
+            "name": "userId",
+            "in": "path",
+            "description": "User ID"
+        },
         "x-api-version": {
             "name": "x-api-version",
             "in": "header",

diff --git a/tests/Fixtures/defaults.json b/tests/Fixtures/defaults.json
@@ -26,6 +26,29 @@
                 }
             }
         },
+        "\/request\/get\/{userId}": {
+            "get": {
+                "operationId": "testCustomRequest",
+                "consumes": [
+                    "application\/x-www-form-urlencoded"
+                ],
+                "parameters": [
+                    {
+                        "parameter": "userId",
+                        "name": "userId",
+                        "in": "path",
+                        "description": "User ID",
+                        "required": true,
+                        "type": "string"
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "GET"
+                    }
+                }
+            }
+        },
         "\/shared_all\/get": {
             "get": {
                 "operationId": "testGetRequest",
@@ -157,6 +180,11 @@
         }
     },
     "parameters": {
+        "userId": {
+            "name": "userId",
+            "in": "path",
+            "description": "User ID"
+        },
         "x-api-version": {
             "name": "x-api-version",
             "in": "header",

diff --git a/tests/Fixtures/multi-path.json b/tests/Fixtures/multi-path.json
@@ -26,6 +26,29 @@
                 }
             }
         },
+        "\/request\/get\/{userId}": {
+            "get": {
+                "operationId": "testCustomRequest",
+                "consumes": [
+                    "application\/x-www-form-urlencoded"
+                ],
+                "parameters": [
+                    {
+                        "parameter": "userId",
+                        "name": "userId",
+                        "in": "path",
+                        "description": "User ID",
+                        "required": true,
+                        "type": "string"
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "GET"
+                    }
+                }
+            }
+        },
         "\/shared_all\/get": {
             "get": {
                 "operationId": "testGetRequest",
@@ -192,6 +215,11 @@
         }
     },
     "parameters": {
+        "userId": {
+            "name": "userId",
+            "in": "path",
+            "description": "User ID"
+        },
         "x-api-version": {
             "name": "x-api-version",
             "in": "header",