Fix Parameter Required

byjg · Nov 27, 2024 · fb52d3d · fb52d3d
1 parent 8309699
commit fb52d3d
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 4 deletions.
diff --git a/src/Base/Schema.php b/src/Base/Schema.php
@@ -119,6 +119,11 @@ public function getPathDefinition(string $path, string $method): mixed
         throw new PathNotFoundException('Path "' . $path . '" not found');
     }
 
+    /**
+     * @throws DefinitionNotFoundException
+     * @throws NotMatchedException
+     * @throws InvalidDefinitionException
+     */
     protected function prepareToValidateArguments(string $path, string $method, string $parameterIn, $matches): void
     {
         $pathDef = $this->jsonFile[self::SWAGGER_PATHS][$path];
@@ -142,11 +147,9 @@ protected function prepareToValidateArguments(string $path, string $method, stri
      * @param string $method
      * @param int $status
      * @return Body
-     * @throws DefinitionNotFoundException
      * @throws HttpMethodNotFoundException
      * @throws InvalidDefinitionException
      * @throws InvalidRequestException
-     * @throws NotMatchedException
      * @throws PathNotFoundException
      */
     public function getResponseParameters(string $path, string $method, int $status): Body

diff --git a/src/OpenApi/OpenApiSchema.php b/src/OpenApi/OpenApiSchema.php
@@ -78,7 +78,7 @@ protected function validateArguments(string $parameterIn, array $parameters, arr
                 $parameter = $this->jsonFile[self::SWAGGER_COMPONENTS][self::SWAGGER_PARAMETERS][$paramParts[3]];
             }
             if ($parameter['in'] === $parameterIn) {
-                $parameterMatch = new Parameter($this, $parameter['name'], $parameter["schema"] ?? [], true);
+                $parameterMatch = new Parameter($this, $parameter['name'], $parameter["schema"] ?? [], !($parameter["required"] ?? false));
                 $parameterMatch->match($arguments[$parameter['name']] ?? null);
             }
         }

diff --git a/src/Swagger/SwaggerSchema.php b/src/Swagger/SwaggerSchema.php
@@ -60,7 +60,7 @@ protected function validateArguments(string $parameterIn, array $parameters, arr
     {
         foreach ($parameters as $parameter) {
             if ($parameter['in'] === $parameterIn) {
-                $parameterMatch = new Parameter($this, $parameter['name'], $parameter ?? []);
+                $parameterMatch = new Parameter($this, $parameter['name'], $parameter ?? [], !($parameter["required"] ?? false));
                 $parameterMatch->match($arguments[$parameter['name']] ?? null);
             }
         }

diff --git a/tests/OpenApiRequestBodyTest.php b/tests/OpenApiRequestBodyTest.php
@@ -121,6 +121,30 @@ public function testMatchParameterInQuery()
         $this->assertTrue(true);
     }
 
+    public function testMatchParameterInQueryRequired()
+    {
+        $this->expectException(NotMatchedException::class);
+        $this->expectExceptionMessage("Value of property 'status' is null, but should be of type 'array'");
+
+        self::openApiSchema()->getRequestParameters('/v2/pet/findByStatus', 'get');
+    }
+
+    public function testMatchParameterInQueryRequired2()
+    {
+        $this->expectException(NotMatchedException::class);
+        $this->expectExceptionMessage("Value of property 'username' is null, but should be of type 'string");
+
+        self::openApiSchema()->getRequestParameters('/user/login', 'get');
+    }
+
+    public function testMatchParameterInQueryRequired3()
+    {
+        $this->expectException(NotMatchedException::class);
+        $this->expectExceptionMessage("Value of property 'password' is null, but should be of type 'string");
+
+        self::openApiSchema()->getRequestParameters('/user/login?username=test', 'get');
+    }
+
     public function testMatchParameterInQueryNotValid()
     {
         $this->expectException(NotMatchedException::class);