feat(openapi): license identifier (#7141)

Author: soyuka

src/OpenApi/Factory/OpenApiFactory.php

@@ -116,7 +116,7 @@ public function __invoke(array $context = []): OpenApi
     {
         $baseUrl = $context[self::BASE_URL] ?? '/';
         $contact = null === $this->openApiOptions->getContactUrl() || null === $this->openApiOptions->getContactEmail() ? null : new Contact($this->openApiOptions->getContactName(), $this->openApiOptions->getContactUrl(), $this->openApiOptions->getContactEmail());
-        $license = null === $this->openApiOptions->getLicenseName() ? null : new License($this->openApiOptions->getLicenseName(), $this->openApiOptions->getLicenseUrl());
+        $license = null === $this->openApiOptions->getLicenseName() ? null : new License($this->openApiOptions->getLicenseName(), $this->openApiOptions->getLicenseUrl(), $this->openApiOptions->getLicenseIdentifier());
         $info = new Info($this->openApiOptions->getTitle(), $this->openApiOptions->getVersion(), trim($this->openApiOptions->getDescription()), $this->openApiOptions->getTermsOfService(), $contact, $license);
         $servers = '/' === $baseUrl || '' === $baseUrl ? [new Server('/')] : [new Server($baseUrl)];
         $paths = new Paths();

src/OpenApi/Options.php

@@ -46,6 +46,7 @@ public function __construct(
         private array $tags = [],
         private ?string $errorResourceClass = null,
         private ?string $validationErrorResourceClass = null,
+        private ?string $licenseIdentifier = null,
     ) {
     }
 
@@ -172,4 +173,9 @@ public function getValidationErrorResourceClass(): ?string
     {
         return $this->validationErrorResourceClass;
     }
+
+    public function getLicenseIdentifier(): ?string
+    {
+        return $this->licenseIdentifier;
+    }
 }

src/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -865,6 +865,7 @@ private function registerOpenApiConfiguration(ContainerBuilder $container, array
         $container->setParameter('api_platform.openapi.contact.email', $config['openapi']['contact']['email']);
         $container->setParameter('api_platform.openapi.license.name', $config['openapi']['license']['name']);
         $container->setParameter('api_platform.openapi.license.url', $config['openapi']['license']['url']);
+        $container->setParameter('api_platform.openapi.license.identifier', $config['openapi']['license']['identifier']);
         $container->setParameter('api_platform.openapi.overrideResponses', $config['openapi']['overrideResponses']);
 
         $tags = [];

src/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -18,7 +18,6 @@
 use ApiPlatform\Metadata\Exception\InvalidArgumentException;
 use ApiPlatform\Metadata\Post;
 use ApiPlatform\Metadata\Put;
-use ApiPlatform\OpenApi\Model\Tag;
 use ApiPlatform\Symfony\Controller\MainController;
 use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
 use Doctrine\Bundle\MongoDBBundle\DoctrineMongoDBBundle;
@@ -524,6 +523,7 @@ private function addOpenApiSection(ArrayNodeDefinition $rootNode): void
                             ->children()
                                 ->scalarNode('name')->defaultNull()->info('The license name used for the API.')->end()
                                 ->scalarNode('url')->defaultNull()->info('URL to the license used for the API. MUST be in the format of a URL.')->end()
+                                ->scalarNode('identifier')->defaultNull()->info('An SPDX license expression for the API. The identifier field is mutually exclusive of the url field.')->end()
                             ->end()
                         ->end()
                         ->variableNode('swagger_ui_extra_configuration')

src/Symfony/Bundle/Resources/config/openapi.xml

@@ -62,6 +62,7 @@
             <argument>%api_platform.swagger.persist_authorization%</argument>
             <argument>%api_platform.swagger.http_auth%</argument>
             <argument>%api_platform.openapi.tags%</argument>
+            <argument>%api_platform.openapi.license.identifier%</argument>
         </service>
         <service id="ApiPlatform\OpenApi\Options" alias="api_platform.openapi.options" />
 

tests/Symfony/Bundle/DependencyInjection/ConfigurationTest.php

@@ -216,6 +216,7 @@ private function runDefaultConfigTests(array $doctrineIntegrationsToLoad = ['orm
                 'license' => [
                     'name' => null,
                     'url' => null,
+                    'identifier' => null,
                 ],
                 'swagger_ui_extra_configuration' => [],
                 'overrideResponses' => true,