Skip to content

Commit 6fce8ae

Browse files
soyukasoyuka
committed
reivew
1 parent 0d9a39d commit 6fce8ae

6 files changed

Lines changed: 20 additions & 25 deletions

File tree

‎src/Validator/Metadata/Resource/Factory/ParameterValidationResourceMetadataCollectionFactory.php‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -157,12 +157,7 @@ private function buildDefaultParameters(): array
157157
continue;
158158
}
159159

160-
$key = $config['key'] ?? null;
161-
if (!$key) {
162-
$key = (new \ReflectionClass($parameterClass))->getShortName();
163-
}
164-
165-
$identifier = $key;
160+
$identifier = $config['key'] ?? (new \ReflectionClass($parameterClass))->getShortName();
166161

167162
$parameter = $this->createParameterFromConfig($parameterClass, $config);
168163
$parameters[$identifier] = $parameter;

‎tests/Functional/DefaultParametersAppKernel.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
3838
],
3939
'parameters' => [
4040
HeaderParameter::class => [
41-
'key' => 'X-API-Key',
41+
'key' => 'API-Key',
4242
'required' => false,
4343
'description' => 'API key for authentication',
4444
'schema' => ['type' => 'string'],

‎tests/Functional/DefaultParametersTest.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ protected static function getKernelClass(): string
3636
* This test verifies that when default parameters are configured via
3737
* api_platform.defaults.parameters with:
3838
* HeaderParameter:
39-
* key: 'X-API-Key'
39+
* key: 'API-Key'
4040
* required: false
4141
* description: 'API key for authentication'
4242
*
@@ -65,14 +65,14 @@ public function testDefaultParameterAppearsInOpenApiForAllOperations(): void
6565

6666
$parameters = $pathItem[$method]['parameters'];
6767
foreach ($parameters as $param) {
68-
if ('X-API-Key' === $param['name'] && 'header' === $param['in']) {
68+
if ('API-Key' === $param['name'] && 'header' === $param['in']) {
6969
$foundParameter = true;
7070
$operationsWithParameter[] = [
7171
'path' => $pathName,
7272
'method' => $method,
7373
];
7474

75-
$this->assertSame('X-API-Key', $param['name']);
75+
$this->assertSame('API-Key', $param['name']);
7676
$this->assertSame('header', $param['in']);
7777
$this->assertSame('API key for authentication', $param['description']);
7878
$this->assertFalse($param['required']);
@@ -88,7 +88,7 @@ public function testDefaultParameterAppearsInOpenApiForAllOperations(): void
8888
$this->assertTrue(
8989
$foundParameter,
9090
\sprintf(
91-
'Default header parameter "X-API-Key" not found in any operation. Operations checked: %d',
91+
'Default header parameter "API-Key" not found in any operation. Operations checked: %d',
9292
\count($content['paths'] ?? [])
9393
)
9494
);
@@ -120,7 +120,7 @@ public function testDefaultParameterAppearsInMultipleOperationTypes(): void
120120

121121
$parameters = $pathItem[$method]['parameters'];
122122
foreach ($parameters as $param) {
123-
if ('X-API-Key' === $param['name'] && 'header' === $param['in']) {
123+
if ('API-Key' === $param['name'] && 'header' === $param['in']) {
124124
$operationMethodsWithParameter[$method] = true;
125125
break;
126126
}

‎tests/Functional/JsonSchema/JsonSchemaWithDefaultParametersTest.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public function testJsonSchemaCanBeGeneratedWithDefaultParameters(): void
5151
foreach ($resourceMetadata as $operation) {
5252
$parameters = $operation->getParameters() ?? [];
5353
foreach ($parameters as $parameter) {
54-
if ('X-API-Key' === $parameter->getKey()) {
54+
if ('API-Key' === $parameter->getKey()) {
5555
$hasDefaultParameters = true;
5656
$this->assertFalse($parameter->getRequired());
5757
$this->assertSame('API key for authentication', $parameter->getDescription());
@@ -63,7 +63,7 @@ public function testJsonSchemaCanBeGeneratedWithDefaultParameters(): void
6363
}
6464
}
6565

66-
$this->assertTrue($hasDefaultParameters, 'Default parameter "X-API-Key" should be applied to resource operations');
66+
$this->assertTrue($hasDefaultParameters, 'Default parameter "API-Key" should be applied to resource operations');
6767

6868
$schema = $this->schemaFactory->buildSchema(BagOfTests::class, 'jsonld');
6969

‎tests/Validator/Metadata/Resource/Factory/ParameterValidationConfigurationTest.php‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public function testDefaultHeaderParameterConfiguration(): void
4141
'defaults' => [
4242
'parameters' => [
4343
'ApiPlatform\Metadata\HeaderParameter' => [
44-
'key' => 'X-API-Version',
44+
'key' => 'API-Version',
4545
'required' => true,
4646
'description' => 'API Version',
4747
],
@@ -52,7 +52,7 @@ public function testDefaultHeaderParameterConfiguration(): void
5252

5353
$this->assertIsArray($config['defaults']['parameters']);
5454
$this->assertArrayHasKey('ApiPlatform\Metadata\HeaderParameter', $config['defaults']['parameters']);
55-
$this->assertSame('X-API-Version', $config['defaults']['parameters']['ApiPlatform\Metadata\HeaderParameter']['key']);
55+
$this->assertSame('API-Version', $config['defaults']['parameters']['ApiPlatform\Metadata\HeaderParameter']['key']);
5656
$this->assertTrue($config['defaults']['parameters']['ApiPlatform\Metadata\HeaderParameter']['required']);
5757
$this->assertSame('API Version', $config['defaults']['parameters']['ApiPlatform\Metadata\HeaderParameter']['description']);
5858
}
@@ -64,7 +64,7 @@ public function testMultipleDefaultParametersConfiguration(): void
6464
'defaults' => [
6565
'parameters' => [
6666
'ApiPlatform\Metadata\HeaderParameter' => [
67-
'key' => 'X-API-Version',
67+
'key' => 'API-Version',
6868
'required' => true,
6969
],
7070
'ApiPlatform\Metadata\QueryParameter' => [
@@ -88,7 +88,7 @@ public function testDefaultParametersWithAllOptions(): void
8888
'defaults' => [
8989
'parameters' => [
9090
'ApiPlatform\Metadata\HeaderParameter' => [
91-
'key' => 'X-API-Version',
91+
'key' => 'API-Version',
9292
'required' => true,
9393
'description' => 'API Version',
9494
'property' => 'version',
@@ -106,7 +106,7 @@ public function testDefaultParametersWithAllOptions(): void
106106
]);
107107

108108
$params = $config['defaults']['parameters']['ApiPlatform\Metadata\HeaderParameter'];
109-
$this->assertSame('X-API-Version', $params['key']);
109+
$this->assertSame('API-Version', $params['key']);
110110
$this->assertTrue($params['required']);
111111
$this->assertSame('API Version', $params['description']);
112112
$this->assertSame('version', $params['property']);
@@ -140,7 +140,7 @@ public function testDefaultParametersDoesNotAffectOtherDefaults(): void
140140
'defaults' => [
141141
'parameters' => [
142142
'ApiPlatform\Metadata\HeaderParameter' => [
143-
'key' => 'X-API-Version',
143+
'key' => 'API-Version',
144144
'required' => true,
145145
],
146146
],

‎tests/Validator/Metadata/Resource/Factory/ParameterValidationResourceMetadataCollectionFactoryDefaultParametersTest.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ final class ParameterValidationResourceMetadataCollectionFactoryDefaultParameter
3030
{
3131
private const DEFAULT_PARAMETERS = [
3232
HeaderParameter::class => [
33-
'key' => 'X-API-Version',
33+
'key' => 'API-Version',
3434
'required' => true,
3535
'description' => 'API Version',
3636
],
@@ -66,10 +66,10 @@ public function testDefaultParametersAppliedToRealResource(): void
6666

6767
$parameters = $collectionOperation->getParameters();
6868
$this->assertNotNull($parameters);
69-
$this->assertTrue($parameters->has('X-API-Version', HeaderParameter::class), 'Default header parameter not found');
69+
$this->assertTrue($parameters->has('API-Version', HeaderParameter::class), 'Default header parameter not found');
7070

71-
$headerParam = $parameters->get('X-API-Version', HeaderParameter::class);
72-
$this->assertSame('X-API-Version', $headerParam->getKey());
71+
$headerParam = $parameters->get('API-Version', HeaderParameter::class);
72+
$this->assertSame('API-Version', $headerParam->getKey());
7373
$this->assertTrue($headerParam->getRequired());
7474
$this->assertSame('API Version', $headerParam->getDescription());
7575
}
@@ -105,7 +105,7 @@ public function testDefaultParametersWithOperationOverride(): void
105105
$parameters = $collectionOperation->getParameters();
106106
$this->assertNotNull($parameters);
107107

108-
$this->assertTrue($parameters->has('X-API-Version', HeaderParameter::class));
108+
$this->assertTrue($parameters->has('API-Version', HeaderParameter::class));
109109
$this->assertTrue($parameters->has('filter', QueryParameter::class));
110110
}
111111
}

0 commit comments

Comments
 (0)