Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixed validation of requirements in route description #2083

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixed validation of requirements in route description #2083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion RouteDescriber/RouteMetadataDescriber.php
View file
Open in desktop
Expand Up @@ -68,7 +68,7 @@ public function describe(OA\OpenApi $api, Route $route, \ReflectionMethod $refle
}
// add the pattern anyway
if (Generator::UNDEFINED === $parameter->schema->pattern) {
$parameter->schema->pattern = $requirements[$pathVariable];
$parameter->schema->pattern = sprintf('^(?:%s)$', $requirements[$pathVariable]);
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions Tests/Functional/Controller/ApiController80.php
View file
Open in desktop
Expand Up @@ -113,7 +113,7 @@ public function implicitSwaggerAction()
}

/**
* @Route("/test/users/{user}", methods={"POST"}, schemes={"https"}, requirements={"user"="/foo/"})
* @Route("/test/users/{user}", methods={"POST"}, schemes={"https"}, requirements={"user"="foo"})
* @OA\Response(
* response="201",
* description="Operation automatically detected",
Expand All @@ -129,7 +129,7 @@ public function submitUserTypeAction()
}

/**
* @Route("/test/{user}", methods={"GET"}, schemes={"https"}, requirements={"user"="/foo/"})
* @Route("/test/{user}", methods={"GET"}, schemes={"https"}, requirements={"user"="foo"})
* @OA\Response(response=200, description="sucessful")
*/
public function userAction()
Expand Down
2 changes: 1 addition & 1 deletion Tests/Functional/FunctionalTest.php
View file
Open in desktop
Expand Up @@ -147,7 +147,7 @@ public function testUserAction()
$parameter = Util::getOperationParameter($operation, 'user', 'path');
$this->assertTrue($parameter->required);
$this->assertEquals('string', $parameter->schema->type);
$this->assertEquals('/foo/', $parameter->schema->pattern);
$this->assertEquals('^(?:foo)$', $parameter->schema->pattern);
$this->assertEquals(Generator::UNDEFINED, $parameter->schema->format);
}

Expand Down
6 changes: 3 additions & 3 deletions Tests/RouteDescriber/RouteMetadataDescriberTest.php
View file
Open in desktop
Expand Up @@ -44,7 +44,7 @@ public function testRouteRequirementsWithPattern()
$this->assertEquals('path', $getPathParameter->in);
$this->assertEquals('foo', $getPathParameter->name);
$this->assertEquals('string', $getPathParameter->schema->type);
$this->assertEquals('[0-9]|[a-z]', $getPathParameter->schema->pattern);
$this->assertEquals('^(?:[0-9]|[a-z])$', $getPathParameter->schema->pattern);
}
}

Expand All @@ -68,7 +68,7 @@ public function testSimpleOrRequirementsAreHandledAsEnums($req)
$this->assertEquals('foo', $getPathParameter->name);
$this->assertEquals('string', $getPathParameter->schema->type);
$this->assertEquals(explode('|', $req), $getPathParameter->schema->enum);
$this->assertEquals($req, $getPathParameter->schema->pattern);
$this->assertEquals('^(?:' . $req . ')$', $getPathParameter->schema->pattern);
}

/**
Expand All @@ -86,7 +86,7 @@ public function testNonEnumPatterns($pattern)
);

$getPathParameter = $api->paths[0]->get->parameters[0];
$this->assertEquals($pattern, $getPathParameter->schema->pattern);
$this->assertEquals('^(?:' . $pattern . ')$', $getPathParameter->schema->pattern);
$this->assertEquals(Generator::UNDEFINED, $getPathParameter->schema->enum);
}

Expand Down