vendor/api-platform/core/src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php line 527

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection;
  16. use ApiPlatform\Core\Annotation\ApiResource;
  17. use ApiPlatform\Core\Bridge\Elasticsearch\Metadata\Document\DocumentMetadata;
  18. use ApiPlatform\Core\Exception\FilterValidationException;
  19. use ApiPlatform\Core\Exception\InvalidArgumentException;
  20. use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
  21. use Doctrine\Bundle\MongoDBBundle\DoctrineMongoDBBundle;
  22. use Doctrine\ORM\EntityManagerInterface;
  23. use Doctrine\ORM\OptimisticLockException;
  24. use Elasticsearch\Client as ElasticsearchClient;
  25. use FOS\UserBundle\FOSUserBundle;
  26. use GraphQL\GraphQL;
  27. use Symfony\Bundle\FullStack;
  28. use Symfony\Bundle\MercureBundle\MercureBundle;
  29. use Symfony\Bundle\TwigBundle\TwigBundle;
  30. use Symfony\Component\Config\Definition\BaseNode;
  31. use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
  32. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  33. use Symfony\Component\Config\Definition\ConfigurationInterface;
  34. use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
  35. use Symfony\Component\HttpFoundation\Response;
  36. use Symfony\Component\Messenger\MessageBusInterface;
  37. use Symfony\Component\Serializer\Exception\ExceptionInterface as SerializerExceptionInterface;
  38. use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
  40. /**
  41.  * The configuration of the bundle.
  42.  *
  43.  * @author Kévin Dunglas <dunglas@gmail.com>
  44.  * @author Baptiste Meyer <baptiste.meyer@gmail.com>
  45.  */
  46. final class Configuration implements ConfigurationInterface
  47. {
  48.     /**
  49.      * {@inheritdoc}
  50.      * @return TreeBuilder
  51.      */
  52.     public function getConfigTreeBuilder(): TreeBuilder
  53.     {
  54.         if (method_exists(TreeBuilder::class, 'getRootNode')) {
  55.             $treeBuilder = new TreeBuilder('api_platform');
  56.             $rootNode = $treeBuilder->getRootNode();
  57.         } else {
  58.             $treeBuilder = new TreeBuilder();
  59.             $rootNode = $treeBuilder->root('api_platform');
  60.         }
  62.         $rootNode
  63.             ->beforeNormalization()
  64.                 ->ifTrue(static function ($v) {
  65.                     return false === ($v['enable_swagger'] ?? null);
  66.                 })
  67.                 ->then(static function ($v) {
  68.                     $v['swagger']['versions'] = [];
  70.                     return $v;
  71.                 })
  72.             ->end()
  73.             ->children()
  74.                 ->scalarNode('title')
  75.                     ->info('The title of the API.')
  76.                     ->cannotBeEmpty()
  77.                     ->defaultValue('')
  78.                 ->end()
  79.                 ->scalarNode('description')
  80.                     ->info('The description of the API.')
  81.                     ->cannotBeEmpty()
  82.                     ->defaultValue('')
  83.                 ->end()
  84.                 ->scalarNode('version')
  85.                     ->info('The version of the API.')
  86.                     ->cannotBeEmpty()
  87.                     ->defaultValue('0.0.0')
  88.                 ->end()
  89.                 ->booleanNode('show_webby')->defaultTrue()->info('If true, show Webby on the documentation page')->end()
  90.                 ->scalarNode('default_operation_path_resolver')
  91.                     ->defaultValue('api_platform.operation_path_resolver.underscore')
  92.                     ->setDeprecated(...$this->buildDeprecationArgs('2.1', 'The use of the `default_operation_path_resolver` has been deprecated in 2.1 and will be removed in 3.0. Use `path_segment_name_generator` instead.'))
  93.                     ->info('Specify the default operation path resolver to use for generating resources operations path.')
  94.                 ->end()
  95.                 ->scalarNode('name_converter')->defaultNull()->info('Specify a name converter to use.')->end()
  96.                 ->scalarNode('asset_package')->defaultNull()->info('Specify an asset package name to use.')->end()
  97.                 ->scalarNode('path_segment_name_generator')->defaultValue('api_platform.path_segment_name_generator.underscore')->info('Specify a path name generator to use.')->end()
  98.                 ->booleanNode('allow_plain_identifiers')->defaultFalse()->info('Allow plain identifiers, for example "id" instead of "@id" when denormalizing a relation.')->end()
  99.                 ->arrayNode('validator')
  100.                     ->addDefaultsIfNotSet()
  101.                     ->children()
  102.                         ->variableNode('serialize_payload_fields')->defaultValue([])->info('Set to null to serialize all payload fields when a validation error is thrown, or set the fields you want to include explicitly.')->end()
  103.                     ->end()
  104.                 ->end()
  105.                 ->arrayNode('eager_loading')
  106.                     ->canBeDisabled()
  107.                     ->addDefaultsIfNotSet()
  108.                     ->children()
  109.                         ->booleanNode('fetch_partial')->defaultFalse()->info('Fetch only partial data according to serialization groups. If enabled, Doctrine ORM entities will not work as expected if any of the other fields are used.')->end()
  110.                         ->integerNode('max_joins')->defaultValue(30)->info('Max number of joined relations before EagerLoading throws a RuntimeException')->end()
  111.                         ->booleanNode('force_eager')->defaultTrue()->info('Force join on every relation. If disabled, it will only join relations having the EAGER fetch mode.')->end()
  112.                     ->end()
  113.                 ->end()
  114.                 ->booleanNode('enable_fos_user')
  115.                     ->defaultValue(class_exists(FOSUserBundle::class))
  116.                     ->setDeprecated(...$this->buildDeprecationArgs('2.5', 'FOSUserBundle is not actively maintained anymore. Enabling the FOSUserBundle integration has been deprecated in 2.5 and will be removed in 3.0.'))
  117.                     ->info('Enable the FOSUserBundle integration.')
  118.                 ->end()
  119.                 ->booleanNode('enable_nelmio_api_doc')
  120.                     ->defaultFalse()
  121.                     ->setDeprecated(...$this->buildDeprecationArgs('2.2', 'Enabling the NelmioApiDocBundle integration has been deprecated in 2.2 and will be removed in 3.0. NelmioApiDocBundle 3 has native support for API Platform.'))
  122.                     ->info('Enable the NelmioApiDocBundle integration.')
  123.                 ->end()
  124.                 ->booleanNode('enable_swagger')->defaultTrue()->info('Enable the Swagger documentation and export.')->end()
  125.                 ->booleanNode('enable_swagger_ui')->defaultValue(class_exists(TwigBundle::class))->info('Enable Swagger UI')->end()
  126.                 ->booleanNode('enable_re_doc')->defaultValue(class_exists(TwigBundle::class))->info('Enable ReDoc')->end()
  127.                 ->booleanNode('enable_entrypoint')->defaultTrue()->info('Enable the entrypoint')->end()
  128.                 ->booleanNode('enable_docs')->defaultTrue()->info('Enable the docs')->end()
  129.                 ->booleanNode('enable_profiler')->defaultTrue()->info('Enable the data collector and the WebProfilerBundle integration.')->end()
  130.                 ->arrayNode('collection')
  131.                     ->addDefaultsIfNotSet()
  132.                     ->children()
  133.                         ->scalarNode('exists_parameter_name')->defaultValue('exists')->cannotBeEmpty()->info('The name of the query parameter to filter on nullable field values.')->end()
  134.                         ->scalarNode('order')->defaultValue('ASC')->info('The default order of results.')->end() // Default ORDER is required for postgresql and mysql >= 5.7 when using LIMIT/OFFSET request
  135.                         ->scalarNode('order_parameter_name')->defaultValue('order')->cannotBeEmpty()->info('The name of the query parameter to order results.')->end()
  136.                         ->arrayNode('pagination')
  137.                             ->canBeDisabled()
  138.                             ->addDefaultsIfNotSet()
  139.                             ->children()
  140.                                 ->booleanNode('enabled')
  141.                                     ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `collection.pagination.enabled` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.pagination_enabled` instead.'))
  142.                                     ->defaultTrue()
  143.                                     ->info('To enable or disable pagination for all resource collections by default.')
  144.                                 ->end()
  145.                                 ->booleanNode('partial')
  146.                                     ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `collection.pagination.partial` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.pagination_partial` instead.'))
  147.                                     ->defaultFalse()
  148.                                     ->info('To enable or disable partial pagination for all resource collections by default when pagination is enabled.')
  149.                                 ->end()
  150.                                 ->booleanNode('client_enabled')
  151.                                     ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `collection.pagination.client_enabled` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.pagination_client_enabled` instead.'))
  152.                                     ->defaultFalse()
  153.                                     ->info('To allow the client to enable or disable the pagination.')
  154.                                 ->end()
  155.                                 ->booleanNode('client_items_per_page')
  156.                                     ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `collection.pagination.client_items_per_page` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.pagination_client_items_per_page` instead.'))
  157.                                     ->defaultFalse()
  158.                                     ->info('To allow the client to set the number of items per page.')
  159.                                 ->end()
  160.                                 ->booleanNode('client_partial')
  161.                                     ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `collection.pagination.client_partial` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.pagination_client_partial` instead.'))
  162.                                     ->defaultFalse()
  163.                                     ->info('To allow the client to enable or disable partial pagination.')
  164.                                 ->end()
  165.                                 ->integerNode('items_per_page')
  166.                                     ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `collection.pagination.items_per_page` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.pagination_items_per_page` instead.'))
  167.                                     ->defaultValue(30)
  168.                                     ->info('The default number of items per page.')
  169.                                 ->end()
  170.                                 ->integerNode('maximum_items_per_page')
  171.                                     ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `collection.pagination.maximum_items_per_page` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.pagination_maximum_items_per_page` instead.'))
  172.                                     ->defaultNull()
  173.                                     ->info('The maximum number of items per page.')
  174.                                 ->end()
  175.                                 ->scalarNode('page_parameter_name')->defaultValue('page')->cannotBeEmpty()->info('The default name of the parameter handling the page number.')->end()
  176.                                 ->scalarNode('enabled_parameter_name')->defaultValue('pagination')->cannotBeEmpty()->info('The name of the query parameter to enable or disable pagination.')->end()
  177.                                 ->scalarNode('items_per_page_parameter_name')->defaultValue('itemsPerPage')->cannotBeEmpty()->info('The name of the query parameter to set the number of items per page.')->end()
  178.                                 ->scalarNode('partial_parameter_name')->defaultValue('partial')->cannotBeEmpty()->info('The name of the query parameter to enable or disable partial pagination.')->end()
  179.                             ->end()
  180.                         ->end()
  181.                     ->end()
  182.                 ->end()
  183.                 ->arrayNode('mapping')
  184.                     ->addDefaultsIfNotSet()
  185.                     ->children()
  186.                         ->arrayNode('paths')
  187.                             ->prototype('scalar')->end()
  188.                         ->end()
  189.                     ->end()
  190.                 ->end()
  191.                 ->arrayNode('resource_class_directories')
  192.                     ->prototype('scalar')->end()
  193.                 ->end()
  194.             ->end();
  196.         $this->addDoctrineOrmSection($rootNode);
  197.         $this->addDoctrineMongoDbOdmSection($rootNode);
  198.         $this->addOAuthSection($rootNode);
  199.         $this->addGraphQlSection($rootNode);
  200.         $this->addSwaggerSection($rootNode);
  201.         $this->addHttpCacheSection($rootNode);
  202.         $this->addMercureSection($rootNode);
  203.         $this->addMessengerSection($rootNode);
  204.         $this->addElasticsearchSection($rootNode);
  205.         $this->addOpenApiSection($rootNode);
  207.         $this->addExceptionToStatusSection($rootNode);
  209.         $this->addFormatSection($rootNode, 'formats', [
  210.             'jsonld' => ['mime_types' => ['application/ld+json']],
  211.             'json' => ['mime_types' => ['application/json']], // Swagger support
  212.             'html' => ['mime_types' => ['text/html']], // Swagger UI support
  213.         ]);
  214.         $this->addFormatSection($rootNode, 'patch_formats', []);
  215.         $this->addFormatSection($rootNode, 'error_formats', [
  216.             'jsonproblem' => ['mime_types' => ['application/problem+json']],
  217.             'jsonld' => ['mime_types' => ['application/ld+json']],
  218.         ]);
  220.         $this->addDefaultsSection($rootNode);
  222.         return $treeBuilder;
  223.     }
  225.     private function addDoctrineOrmSection(ArrayNodeDefinition $rootNode): void
  226.     {
  227.         $rootNode
  228.             ->children()
  229.                 ->arrayNode('doctrine')
  230.                     ->{class_exists(DoctrineBundle::class) && interface_exists(EntityManagerInterface::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  231.                 ->end()
  232.             ->end();
  233.     }
  235.     private function addDoctrineMongoDbOdmSection(ArrayNodeDefinition $rootNode): void
  236.     {
  237.         $rootNode
  238.             ->children()
  239.                 ->arrayNode('doctrine_mongodb_odm')
  240.                     ->{class_exists(DoctrineMongoDBBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  241.                 ->end()
  242.             ->end();
  243.     }
  245.     private function addOAuthSection(ArrayNodeDefinition $rootNode): void
  246.     {
  247.         $rootNode
  248.             ->children()
  249.                 ->arrayNode('oauth')
  250.                     ->canBeEnabled()
  251.                     ->addDefaultsIfNotSet()
  252.                     ->children()
  253.                         ->scalarNode('clientId')->defaultValue('')->info('The oauth client id.')->end()
  254.                         ->scalarNode('clientSecret')->defaultValue('')->info('The oauth client secret.')->end()
  255.                         ->scalarNode('type')->defaultValue('oauth2')->info('The oauth type.')->end()
  256.                         ->scalarNode('flow')->defaultValue('application')->info('The oauth flow grant type.')->end()
  257.                         ->scalarNode('tokenUrl')->defaultValue('')->info('The oauth token url.')->end()
  258.                         ->scalarNode('authorizationUrl')->defaultValue('')->info('The oauth authentication url.')->end()
  259.                         ->scalarNode('refreshUrl')->defaultValue('')->info('The oauth refresh url.')->end()
  260.                         ->arrayNode('scopes')
  261.                             ->prototype('scalar')->end()
  262.                         ->end()
  263.                     ->end()
  264.                 ->end()
  265.             ->end();
  266.     }
  268.     private function addGraphQlSection(ArrayNodeDefinition $rootNode): void
  269.     {
  270.         $rootNode
  271.             ->children()
  272.                 ->arrayNode('graphql')
  273.                     ->{class_exists(GraphQL::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  274.                     ->addDefaultsIfNotSet()
  275.                     ->children()
  276.                         ->scalarNode('default_ide')->defaultValue('graphiql')->end()
  277.                         ->arrayNode('graphiql')
  278.                             ->{class_exists(GraphQL::class) && class_exists(TwigBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  279.                         ->end()
  280.                         ->arrayNode('graphql_playground')
  281.                             ->{class_exists(GraphQL::class) && class_exists(TwigBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  282.                         ->end()
  283.                         ->scalarNode('nesting_separator')->defaultValue('_')->info('The separator to use to filter nested fields.')->end()
  284.                         ->arrayNode('collection')
  285.                             ->addDefaultsIfNotSet()
  286.                             ->children()
  287.                                 ->arrayNode('pagination')
  288.                                     ->canBeDisabled()
  289.                                 ->end()
  290.                             ->end()
  291.                         ->end()
  292.                     ->end()
  293.                 ->end()
  294.             ->end();
  295.     }
  297.     private function addSwaggerSection(ArrayNodeDefinition $rootNode): void
  298.     {
  299.         $defaultVersions = [2, 3];
  301.         $rootNode
  302.             ->children()
  303.                 ->arrayNode('swagger')
  304.                     ->addDefaultsIfNotSet()
  305.                     ->children()
  306.                         ->arrayNode('versions')
  307.                             ->info('The active versions of Open API to be exported or used in the swagger_ui. The first value is the default.')
  308.                             ->defaultValue($defaultVersions)
  309.                             ->beforeNormalization()
  310.                                 ->always(static function ($v) {
  311.                                     if (!\is_array($v)) {
  312.                                         $v = [$v];
  313.                                     }
  315.                                     foreach ($v as &$version) {
  316.                                         $version = (int) $version;
  317.                                     }
  319.                                     return $v;
  320.                                 })
  321.                             ->end()
  322.                             ->validate()
  323.                                 ->ifTrue(static function ($v) use ($defaultVersions) {
  324.                                     return $v !== array_intersect($v, $defaultVersions);
  325.                                 })
  326.                                 ->thenInvalid(sprintf('Only the versions %s are supported. Got %s.', implode(' and ', $defaultVersions), '%s'))
  327.                             ->end()
  328.                             ->prototype('scalar')->end()
  329.                         ->end()
  330.                         ->arrayNode('api_keys')
  331.                             ->prototype('array')
  332.                                 ->children()
  333.                                     ->scalarNode('name')
  334.                                         ->info('The name of the header or query parameter containing the api key.')
  335.                                     ->end()
  336.                                     ->enumNode('type')
  337.                                         ->info('Whether the api key should be a query parameter or a header.')
  338.                                         ->values(['query', 'header'])
  339.                                     ->end()
  340.                                 ->end()
  341.                             ->end()
  342.                         ->end()
  343.                     ->end()
  344.                 ->end()
  345.             ->end();
  346.     }
  348.     private function addHttpCacheSection(ArrayNodeDefinition $rootNode): void
  349.     {
  350.         $rootNode
  351.             ->children()
  352.                 ->arrayNode('http_cache')
  353.                     ->addDefaultsIfNotSet()
  354.                     ->children()
  355.                         ->booleanNode('etag')
  356.                             ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `http_cache.etag` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.cache_headers.etag` instead.'))
  357.                             ->defaultTrue()
  358.                             ->info('Automatically generate etags for API responses.')
  359.                         ->end()
  360.                         ->integerNode('max_age')
  361.                             ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `http_cache.max_age` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.cache_headers.max_age` instead.'))
  362.                             ->defaultNull()
  363.                             ->info('Default value for the response max age.')
  364.                         ->end()
  365.                         ->integerNode('shared_max_age')
  366.                             ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `http_cache.shared_max_age` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.cache_headers.shared_max_age` instead.'))
  367.                             ->defaultNull()
  368.                             ->info('Default value for the response shared (proxy) max age.')
  369.                         ->end()
  370.                         ->arrayNode('vary')
  371.                             ->setDeprecated(...$this->buildDeprecationArgs('2.6', 'The use of the `http_cache.vary` has been deprecated in 2.6 and will be removed in 3.0. Use `defaults.cache_headers.vary` instead.'))
  372.                             ->defaultValue(['Accept'])
  373.                             ->prototype('scalar')->end()
  374.                             ->info('Default values of the "Vary" HTTP header.')
  375.                         ->end()
  376.                         ->booleanNode('public')->defaultNull()->info('To make all responses public by default.')->end()
  377.                         ->arrayNode('invalidation')
  378.                             ->info('Enable the tags-based cache invalidation system.')
  379.                             ->canBeEnabled()
  380.                             ->children()
  381.                                 ->arrayNode('varnish_urls')
  382.                                     ->defaultValue([])
  383.                                     ->prototype('scalar')->end()
  384.                                     ->info('URLs of the Varnish servers to purge using cache tags when a resource is updated.')
  385.                                 ->end()
  386.                                 ->integerNode('max_header_length')
  387.                                     ->defaultValue(7500)
  388.                                     ->info('Max header length supported by the server')
  389.                                 ->end()
  390.                                 ->variableNode('request_options')
  391.                                     ->defaultValue([])
  392.                                     ->validate()
  393.                                         ->ifTrue(static function ($v) { return false === \is_array($v); })
  394.                                         ->thenInvalid('The request_options parameter must be an array.')
  395.                                     ->end()
  396.                                     ->info('To pass options to the client charged with the request.')
  397.                                 ->end()
  398.                             ->end()
  399.                         ->end()
  400.                     ->end()
  401.                 ->end()
  402.             ->end();
  403.     }
  405.     private function addMercureSection(ArrayNodeDefinition $rootNode): void
  406.     {
  407.         $rootNode
  408.             ->children()
  409.                 ->arrayNode('mercure')
  410.                     ->{class_exists(MercureBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  411.                     ->children()
  412.                         ->scalarNode('hub_url')
  413.                             ->defaultNull()
  414.                             ->info('The URL sent in the Link HTTP header. If not set, will default to the URL for MercureBundle\'s default hub.')
  415.                         ->end()
  416.                     ->end()
  417.                 ->end()
  418.             ->end();
  419.     }
  421.     private function addMessengerSection(ArrayNodeDefinition $rootNode): void
  422.     {
  423.         $rootNode
  424.             ->children()
  425.                 ->arrayNode('messenger')
  426.                     ->{!class_exists(FullStack::class) && interface_exists(MessageBusInterface::class) ? 'canBeDisabled' : 'canBeEnabled'}()
  427.                 ->end()
  428.             ->end();
  429.     }
  431.     private function addElasticsearchSection(ArrayNodeDefinition $rootNode): void
  432.     {
  433.         $rootNode
  434.             ->children()
  435.                 ->arrayNode('elasticsearch')
  436.                     ->canBeEnabled()
  437.                     ->addDefaultsIfNotSet()
  438.                     ->children()
  439.                         ->booleanNode('enabled')
  440.                             ->defaultFalse()
  441.                             ->validate()
  442.                                 ->ifTrue()
  443.                                 ->then(static function (bool $v): bool {
  444.                                     if (!class_exists(ElasticsearchClient::class)) {
  445.                                         throw new InvalidConfigurationException('The elasticsearch/elasticsearch package is required for Elasticsearch support.');
  446.                                     }
  448.                                     return $v;
  449.                                 })
  450.                             ->end()
  451.                         ->end()
  452.                         ->arrayNode('hosts')
  453.                             ->beforeNormalization()->castToArray()->end()
  454.                             ->defaultValue([])
  455.                             ->prototype('scalar')->end()
  456.                         ->end()
  457.                         ->arrayNode('mapping')
  458.                             ->normalizeKeys(false)
  459.                             ->useAttributeAsKey('resource_class')
  460.                             ->prototype('array')
  461.                                 ->children()
  462.                                     ->scalarNode('index')->defaultNull()->end()
  463.                                     ->scalarNode('type')->defaultValue(DocumentMetadata::DEFAULT_TYPE)->end()
  464.                                 ->end()
  465.                             ->end()
  466.                         ->end()
  467.                     ->end()
  468.                 ->end()
  469.             ->end();
  470.     }
  472.     private function addOpenApiSection(ArrayNodeDefinition $rootNode): void
  473.     {
  474.         $rootNode
  475.             ->children()
  476.                 ->arrayNode('openapi')
  477.                     ->addDefaultsIfNotSet()
  478.                         ->children()
  479.                         ->arrayNode('contact')
  480.                         ->addDefaultsIfNotSet()
  481.                             ->children()
  482.                                 ->scalarNode('name')->defaultNull()->info('The identifying name of the contact person/organization.')->end()
  483.                                 ->scalarNode('url')->defaultNull()->info('The URL pointing to the contact information. MUST be in the format of a URL.')->end()
  484.                                 ->scalarNode('email')->defaultNull()->info('The email address of the contact person/organization. MUST be in the format of an email address.')->end()
  485.                             ->end()
  486.                         ->end()
  487.                         ->booleanNode('backward_compatibility_layer')->defaultTrue()->info('Enable this to decorate the "api_platform.swagger.normalizer.documentation" instead of decorating the OpenAPI factory.')->end()
  488.                         ->scalarNode('termsOfService')->defaultNull()->info('A URL to the Terms of Service for the API. MUST be in the format of a URL.')->end()
  489.                         ->arrayNode('license')
  490.                         ->addDefaultsIfNotSet()
  491.                             ->children()
  492.                                 ->scalarNode('name')->defaultNull()->info('The license name used for the API.')->end()
  493.                                 ->scalarNode('url')->defaultNull()->info('URL to the license used for the API. MUST be in the format of a URL.')->end()
  494.                             ->end()
  495.                         ->end()
  496.                     ->end()
  497.                 ->end()
  498.             ->end();
  499.     }
  501.     /**
  502.      * @throws InvalidConfigurationException
  503.      */
  504.     private function addExceptionToStatusSection(ArrayNodeDefinition $rootNode): void
  505.     {
  506.         $rootNode
  507.             ->children()
  508.                 ->arrayNode('exception_to_status')
  509.                     ->defaultValue([
  510.                         SerializerExceptionInterface::class => Response::HTTP_BAD_REQUEST,
  511.                         InvalidArgumentException::class => Response::HTTP_BAD_REQUEST,
  512.                         FilterValidationException::class => Response::HTTP_BAD_REQUEST,
  513.                         OptimisticLockException::class => Response::HTTP_CONFLICT,
  514.                     ])
  515.                     ->info('The list of exceptions mapped to their HTTP status code.')
  516.                     ->normalizeKeys(false)
  517.                     ->useAttributeAsKey('exception_class')
  518.                     ->beforeNormalization()
  519.                         ->ifArray()
  520.                         ->then(static function (array $exceptionToStatus) {
  521.                             foreach ($exceptionToStatus as &$httpStatusCode) {
  522.                                 if (\is_int($httpStatusCode)) {
  523.                                     continue;
  524.                                 }
  526.                                 if (\defined($httpStatusCodeConstant = sprintf('%s::%s', Response::class, $httpStatusCode))) {
  527.                                     @trigger_error(sprintf('Using a string "%s" as a constant of the "%s" class is deprecated since API Platform 2.1 and will not be possible anymore in API Platform 3. Use the Symfony\'s custom YAML extension for PHP constants instead (i.e. "!php/const %s").', $httpStatusCode, Response::class, $httpStatusCodeConstant), \E_USER_DEPRECATED);
  529.                                     $httpStatusCode = \constant($httpStatusCodeConstant);
  530.                                 }
  531.                             }
  533.                             return $exceptionToStatus;
  534.                         })
  535.                     ->end()
  536.                     ->prototype('integer')->end()
  537.                     ->validate()
  538.                         ->ifArray()
  539.                         ->then(static function (array $exceptionToStatus) {
  540.                             foreach ($exceptionToStatus as $httpStatusCode) {
  541.                                 if ($httpStatusCode < 100 || $httpStatusCode >= 600) {
  542.                                     throw new InvalidConfigurationException(sprintf('The HTTP status code "%s" is not valid.', $httpStatusCode));
  543.                                 }
  544.                             }
  546.                             return $exceptionToStatus;
  547.                         })
  548.                     ->end()
  549.                 ->end()
  550.             ->end();
  551.     }
  553.     private function addFormatSection(ArrayNodeDefinition $rootNode, string $key, array $defaultValue): void
  554.     {
  555.         $rootNode
  556.             ->children()
  557.                 ->arrayNode($key)
  558.                     ->defaultValue($defaultValue)
  559.                     ->info('The list of enabled formats. The first one will be the default.')
  560.                     ->normalizeKeys(false)
  561.                     ->useAttributeAsKey('format')
  562.                     ->beforeNormalization()
  563.                         ->ifArray()
  564.                         ->then(static function ($v) {
  565.                             foreach ($v as $format => $value) {
  566.                                 if (isset($value['mime_types'])) {
  567.                                     continue;
  568.                                 }
  570.                                 $v[$format] = ['mime_types' => $value];
  571.                             }
  573.                             return $v;
  574.                         })
  575.                     ->end()
  576.                     ->prototype('array')
  577.                         ->children()
  578.                             ->arrayNode('mime_types')->prototype('scalar')->end()->end()
  579.                         ->end()
  580.                     ->end()
  581.                 ->end()
  582.             ->end();
  583.     }
  585.     private function addDefaultsSection(ArrayNodeDefinition $rootNode): void
  586.     {
  587.         $nameConverter = new CamelCaseToSnakeCaseNameConverter();
  588.         $defaultsNode = $rootNode->children()->arrayNode('defaults');
  590.         $defaultsNode
  591.             ->ignoreExtraKeys()
  592.             ->beforeNormalization()
  593.             ->always(static function (array $defaults) use ($nameConverter) {
  594.                 $normalizedDefaults = [];
  595.                 foreach ($defaults as $option => $value) {
  596.                     $option = $nameConverter->normalize($option);
  597.                     $normalizedDefaults[$option] = $value;
  598.                 }
  600.                 return $normalizedDefaults;
  601.             });
  603.         [$publicProperties, $configurableAttributes] = ApiResource::getConfigMetadata();
  604.         foreach (array_merge($publicProperties, $configurableAttributes) as $attribute => $_) {
  605.             $snakeCased = $nameConverter->normalize($attribute);
  606.             $defaultsNode->children()->variableNode($snakeCased);
  607.         }
  608.     }
  610.     private function buildDeprecationArgs(string $version, string $message): array
  611.     {
  612.         return method_exists(BaseNode::class, 'getDeprecation')
  613.             ? ['api-platform/core', $version, $message]
  614.             : [$message];
  615.     }
  616. }