Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/Metadata/Extractor/YamlResourceExtractor.php
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,14 @@ private function buildOpenapi(array $resource): bool|OpenApiOperation|null
if (\array_key_exists('parameters', $resource['openapi']) && \is_array($openapiParameters = $resource['openapi']['parameters'] ?? [])) {
$parameters = [];
foreach ($openapiParameters as $parameter) {
if (!isset($parameter['name'])) {
throw new InvalidArgumentException('OpenAPI parameter is missing the required "name" key.');
}

if (!isset($parameter['in'])) {
throw new InvalidArgumentException(\sprintf('OpenAPI parameter "%s" is missing the required "in" key.', $parameter['name']));
}

$parameters[] = new Parameter(
name: $parameter['name'],
in: $parameter['in'],
Expand Down
8 changes: 8 additions & 0 deletions src/Metadata/Tests/Extractor/YamlExtractorTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -518,6 +518,14 @@ public function testOpenApiParameters(): void
$this->assertEquals('john-doe', $operation->getParameters()[0]->getExample());
}

public function testOpenApiParameterWithoutNameThrowsClearException(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('OpenAPI parameter is missing the required "name" key');

(new YamlResourceExtractor([__DIR__.'/yaml/openapi-parameter-without-name.yaml']))->getResources();
}

public function testInputAndOutputAreBooleans(): void
{
$extractor = new YamlResourceExtractor([__DIR__.'/yaml/input-and-output-are-booleans.yaml']);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
resources:
ApiPlatform\Metadata\Tests\Fixtures\ApiResource\Program:
- uriTemplate: /programs.{_format}
operations:
ApiPlatform\Metadata\GetCollection:
openapi:
parameters:
- in: query
description: A parameter without a name
Loading