Apidoc: merge endpoint parameters specification if OpenApi annotation…

… is provided (#199) Co-authored-by: Petr Besir Horáček <[email protected]>
contributte · Jul 4, 2023 · 596ac1e · 596ac1e
1 parent 8d66303
commit 596ac1e
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 3 deletions.
diff --git a/src/OpenApi/Schema/Operation.php b/src/OpenApi/Schema/Operation.php
@@ -2,6 +2,8 @@
 
 namespace Apitte\OpenApi\Schema;
 
+use Apitte\OpenApi\Utils\Helpers;
+
 class Operation
 {
 
@@ -65,7 +67,12 @@ public static function fromArray(array $data): Operation
 				continue;
 			}
 
-			$operation->addParameter(Parameter::fromArray($parameterData));
+			$parameter = Parameter::fromArray($parameterData);
+			if ($operation->hasParameter($parameter)) {
+				$operation->mergeParameter($parameter);
+			} else {
+				$operation->addParameter(Parameter::fromArray($parameterData));
+			}
 		}
 
 		if (isset($data['requestBody'])) {
@@ -128,9 +135,46 @@ public function setExternalDocs(?ExternalDocumentation $externalDocs): void
 	 */
 	public function addParameter($parameter): void
 	{
+		if ($parameter instanceof Parameter) {
+			$this->parameters[$this->getParameterKey($parameter)] = $parameter;
+
+			return;
+		}
+
 		$this->parameters[] = $parameter;
 	}
 
+	/**
+	 * @param Parameter $parameter
+	 * @return bool
+	 */
+	public function hasParameter(Parameter $parameter): bool
+	{
+		return array_key_exists($this->getParameterKey($parameter), $this->parameters);
+	}
+
+	/**
+	 * @param Parameter $parameter
+	 */
+	public function mergeParameter(Parameter $parameter): void
+	{
+		$originalParameter = $this->parameters[$this->getParameterKey($parameter)];
+
+		$merged = Helpers::merge($parameter->toArray(), $originalParameter->toArray());
+		$parameter = Parameter::fromArray($merged);
+
+		$this->parameters[$this->getParameterKey($parameter)] = $parameter;
+	}
+
+	/**
+	 * @param Parameter $parameter
+	 * @return string
+	 */
+	private function getParameterKey(Parameter $parameter): string
+	{
+		return $parameter->getIn() . '-' . $parameter->getName();
+	}
+
 	/**
 	 * @param RequestBody|Reference|null $requestBody
 	 */

diff --git a/tests/Cases/OpenApi/Schema/OperationTest.php b/tests/Cases/OpenApi/Schema/OperationTest.php
@@ -35,9 +35,9 @@ public function testOptional(): void
 		$operation->setExternalDocs($externalDocs);
 
 		$parameters = [];
-		$parameters[] = $p1 = new Parameter('p1', Parameter::IN_PATH);
+		$parameters['path-p1'] = $p1 = new Parameter('p1', Parameter::IN_PATH);
 		$operation->addParameter($p1);
-		$parameters[] = $p2 = new Parameter('p2', Parameter::IN_COOKIE);
+		$parameters['cookie-p2'] = $p2 = new Parameter('p2', Parameter::IN_COOKIE);
 		$operation->addParameter($p2);
 		$parameters[] = $p3 = new Reference('r1');
 		$operation->addParameter($p3);