fix(symfony): fix swagger config to support Symfony ConfigBuilders (#…

…4691)

* - add attribute as key

* -update CHANGELOG.md

* -fix tests

* -update test

* -add Behat tests

* -fix CI

* -update changelog

* -fix MongoDB Behat tests

* -rollback changelog

features/openapi/docs.feature

@@ -16,6 +16,28 @@ Feature: Documentation support
     And the JSON node "info.title" should be equal to "My Dummy API"
     And the JSON node "info.description" should contain "This is a test API."
     And the JSON node "info.description" should contain "Made with love"
+    # Security Schemes
+    And the JSON node "components.securitySchemes" should be equal to:
+    """
+    {
+        "oauth": {
+            "type": "oauth2",
+            "description": "OAuth 2.0 implicit Grant",
+            "flows": {
+                "implicit": {
+                    "authorizationUrl": "http://my-custom-server/openid-connect/auth",
+                    "scopes": {}
+                }
+            }
+        },
+        "Some Authorization Name": {
+            "type": "apiKey",
+            "description": "Value for the Authorization header parameter.",
+            "name": "Authorization",
+            "in": "header"
+        }
+    }
+    """
     # Supported classes
     And the OpenAPI class "AbstractDummy" exists
     And the OpenAPI class "CircularReference" exists

phpstan.neon.dist

@@ -16,6 +16,8 @@ parameters:
 		- src/Symfony/Bundle/Test/Constraint/ArraySubset.php
 		- tests/Fixtures/app/AppKernel.php
 	excludePaths:
+		# Symfony config
+		- tests/Fixtures/app/config/config_swagger.php
 		# Symfony cache
 		- tests/Fixtures/app/var/
 		- tests/Fixtures/Symfony/Maker

src/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -278,6 +278,7 @@ private function addSwaggerSection(ArrayNodeDefinition $rootNode): void
                             ->prototype('scalar')->end()
                         ->end()
                         ->arrayNode('api_keys')
+                            ->useAttributeAsKey('key')
                             ->prototype('array')
                                 ->children()
                                     ->scalarNode('name')

tests/Fixtures/app/AppKernel.php

@@ -238,6 +238,8 @@ class_exists(NativePasswordHasher::class) ? 'password_hashers' : 'encoders' => [
             ],
         ]);
 
+        $loader->load(__DIR__.'/config/config_swagger.php');
+
         if ('mongodb' === $this->environment) {
             $c->prependExtensionConfig('api_platform', [
                 'mapping' => [

tests/Fixtures/app/config/config_swagger.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+
+use Symfony\Config\ApiPlatformConfig;
+
+return static function (ApiPlatformConfig $apiPlatformConfig): void {
+    $apiPlatformConfig->swagger()->apiKeys('Some Authorization Name')
+        ->name('Authorization')
+        ->type('header');
+};

tests/Symfony/Bundle/DependencyInjection/ConfigurationTest.php

@@ -288,13 +288,13 @@ public function testApiKeysConfig(): void
         $config = $this->processor->processConfiguration($this->configuration, [
             'api_platform' => [
                 'swagger' => [
-                    'api_keys' => [$exampleConfig],
+                    'api_keys' => ['Some Authorization name, like JWT' => $exampleConfig],
                 ],
             ],
         ]);
 
         $this->assertArrayHasKey('api_keys', $config['swagger']);
-        $this->assertSame($exampleConfig, $config['swagger']['api_keys'][0]);
+        $this->assertSame($exampleConfig, $config['swagger']['api_keys']['Some Authorization name, like JWT']);
     }
 
     /**