fix(openapi): use 3.1 version (#5489)

Author: soyuka

features/openapi/docs.feature

@@ -10,7 +10,7 @@ Feature: Documentation support
     And the response should be in JSON
     And the header "Content-Type" should be equal to "application/json; charset=utf-8"
     # Context
-    And the JSON node "openapi" should be equal to "3.0.0"
+    And the JSON node "openapi" should be equal to "3.1.0"
     # Root properties
     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."
@@ -29,7 +29,7 @@ Feature: Documentation support
                 }
             }
         },
-        "Some Authorization Name": {
+        "Some_Authorization_Name": {
             "type": "apiKey",
             "description": "Value for the Authorization header parameter.",
             "name": "Authorization",

src/Metadata/Resource/Factory/LinkFactory.php

@@ -14,7 +14,6 @@
 namespace ApiPlatform\Metadata\Resource\Factory;
 
 use ApiPlatform\Doctrine\Orm\State\Options;
-use ApiPlatform\Metadata\ApiResource;
 use ApiPlatform\Metadata\Exception\RuntimeException;
 use ApiPlatform\Metadata\Link;
 use ApiPlatform\Metadata\Metadata;

src/OpenApi/OpenApi.php

@@ -22,9 +22,7 @@ final class OpenApi
 {
     use ExtensionTrait;
 
-    // We're actually supporting 3.1 but swagger ui has a version constraint
-    // public const VERSION = '3.1.0';
-    public const VERSION = '3.0.0';
+    public const VERSION = '3.1.0';
 
     private string $openapi = self::VERSION;
 

src/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -280,6 +280,10 @@ private function addSwaggerSection(ArrayNodeDefinition $rootNode): void
                         ->end()
                         ->arrayNode('api_keys')
                             ->useAttributeAsKey('key')
+                            ->validate()
+                                ->ifTrue(static fn($v): bool => (bool) array_filter(array_keys($v), fn($item) => !preg_match('/^[a-zA-Z0-9._-]+$/', $item)))
+                                ->thenInvalid('The api keys "key" is not valid according to the pattern enforced by OpenAPI 3.1 ^[a-zA-Z0-9._-]+$.')
+                            ->end()
                             ->prototype('array')
                                 ->children()
                                     ->scalarNode('name')

tests/Fixtures/app/config/config_swagger.php

@@ -16,7 +16,7 @@
 use Symfony\Config\ApiPlatformConfig;
 
 return static function (ApiPlatformConfig $apiPlatformConfig): void {
-    $apiPlatformConfig->swagger()->apiKeys('Some Authorization Name')
+    $apiPlatformConfig->swagger()->apiKeys('Some_Authorization_Name')
         ->name('Authorization')
         ->type('header');
 };

tests/Symfony/Bundle/DependencyInjection/ConfigurationTest.php

@@ -276,6 +276,26 @@ public function testExceptionToStatusConfigWithInvalidHttpStatusCodeValue($inval
         ]);
     }
 
+    /**
+     * Test config for api keys.
+     */
+    public function testInvalidApiKeysConfig(): void
+    {
+        $this->expectExceptionMessage('The api keys "key" is not valid according to the pattern enforced by OpenAPI 3.1 ^[a-zA-Z0-9._-]+$.');
+        $exampleConfig = [
+            'name' => 'Authorization',
+            'type' => 'query',
+        ];
+
+        $config = $this->processor->processConfiguration($this->configuration, [
+            'api_platform' => [
+                'swagger' => [
+                    'api_keys' => ['Some Authorization name, like JWT' => $exampleConfig, 'Another-Auth' => $exampleConfig],
+                ],
+            ],
+        ]);
+    }
+
     /**
      * Test config for api keys.
      */
@@ -289,13 +309,13 @@ public function testApiKeysConfig(): void
         $config = $this->processor->processConfiguration($this->configuration, [
             'api_platform' => [
                 'swagger' => [
-                    'api_keys' => ['Some Authorization name, like JWT' => $exampleConfig],
+                    'api_keys' => ['authorization_name_like_JWT' => $exampleConfig],
                 ],
             ],
         ]);
 
         $this->assertArrayHasKey('api_keys', $config['swagger']);
-        $this->assertSame($exampleConfig, $config['swagger']['api_keys']['Some Authorization name, like JWT']);
+        $this->assertSame($exampleConfig, $config['swagger']['api_keys']['authorization_name_like_JWT']);
     }
 
     /**