feat: add 'hydra_operations' option (replaced with 'hydra_item_operations_in_collection')

Author: Maxcastel

src/JsonLd/Serializer/ItemNormalizer.php

@@ -117,7 +117,6 @@ public function normalize(mixed $data, ?string $format = null, array $context =
         // TODO: we should not remove the resource_class in the normalizeRawCollection as we would find out anyway that it's not the same as the requested one
         $previousResourceClass = $context['resource_class'] ?? null;
         $metadata = [];
-        $isRootResource = !isset($context['jsonld_has_context']);
         if ($isResourceClass = $this->resourceClassResolver->isResourceClass($resourceClass) && (null === $previousResourceClass || $this->resourceClassResolver->isResourceClass($previousResourceClass))) {
             $resourceClass = $this->resourceClassResolver->getResourceClass($data, $previousResourceClass);
             if (isset($context['operation']) && $context['operation'] instanceof HttpOperation && $context['operation']->getClass() !== $resourceClass) {
@@ -192,11 +191,10 @@ public function normalize(mixed $data, ?string $format = null, array $context =
             $metadata['@type'] = 1 === \count($types) ? $types[0] : $types;
         }
 
-        if ($isResourceClass && !is_a($resourceClass, ErrorResourceInterface::class, true) && $isRootResource) {
-            $isCollectionRoute = $context['api_collection_sub_level'] ?? false;
-            $showItemHydraOperationsInCollection = $context['hydra_item_operations_in_collection'] ?? false;
+        if ($isResourceClass && !is_a($resourceClass, ErrorResourceInterface::class, true)) {
+            $showOperations = $context['hydra_operations'] ?? false;
 
-            if (!$isCollectionRoute || $showItemHydraOperationsInCollection) {
+            if ($showOperations) {
                 $hydraOperations = $this->getHydraOperations(
                     false,
                     $this->resourceMetadataCollectionFactory->create($resourceClass)[0],

src/Laravel/config/api-platform.php

@@ -149,7 +149,7 @@
 
     'serializer' => [
         'hydra_prefix' => false,
-        'hydra_item_operations_in_collection' => false,
+        'hydra_operations' => false,
         // 'datetime_format' => \DateTimeInterface::RFC3339,
     ],
 

src/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -334,7 +334,7 @@ private function registerCommonConfiguration(ContainerBuilder $container, array
 
         $defaultContext = [
             'hydra_prefix' => $config['serializer']['hydra_prefix'],
-            'hydra_item_operations_in_collection' => $config['serializer']['hydra_item_operations_in_collection'],
+            'hydra_operations' => $config['serializer']['hydra_operations'],
         ] + ($container->hasParameter('serializer.default_context') ? $container->getParameter('serializer.default_context') : []);
 
         $container->setParameter('api_platform.serializer.default_context', $defaultContext);

src/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -172,7 +172,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->addDefaultsIfNotSet()
                     ->children()
                         ->booleanNode('hydra_prefix')->defaultFalse()->info('Use the "hydra:" prefix.')->end()
-                        ->booleanNode('hydra_item_operations_in_collection')->defaultFalse()->info('Include Hydra item operations on each member of a collection response. Disabled by default to reduce payload size.')->end()
+                        ->booleanNode('hydra_operations')->defaultFalse()->info('Add the "operation" field to Hydra responses. Disabled by default to avoid breaking changes.')->end()
                     ->end()
                 ->end()
             ->end();

tests/Fixtures/app/config/config_common.yml

@@ -38,6 +38,8 @@ api_platform:
         Made with love
     enable_swagger: true
     enable_swagger_ui: true
+    serializer:
+        hydra_operations: false
     formats:
         jsonld:                        ['application/ld+json']
         jsonhal:                       ['application/hal+json']

tests/Symfony/Bundle/DependencyInjection/ConfigurationTest.php

@@ -243,7 +243,7 @@ private function runDefaultConfigTests(array $doctrineIntegrationsToLoad = ['orm
             'enable_link_security' => true,
             'serializer' => [
                 'hydra_prefix' => false,
-                'hydra_item_operations_in_collection' => false,
+                'hydra_operations' => false,
             ],
             'enable_phpdoc_parser' => true,
             'mcp' => [