feat(serializer): remove pagination attributes when explicitly disabled

Author: aaa2000

src/Hal/JsonSchema/SchemaFactory.php

@@ -177,6 +177,14 @@ public function buildSchema(string $className, string $format = 'jsonhal', strin
                 ];
             }
 
+            if (false === $operation->getPaginationEnabled()) {
+                unset($definitions[self::COLLECTION_BASE_SCHEMA_NAME]['properties']['itemsPerPage']);
+                unset($definitions[self::COLLECTION_BASE_SCHEMA_NAME]['properties']['_links']['properties']['first']);
+                unset($definitions[self::COLLECTION_BASE_SCHEMA_NAME]['properties']['_links']['properties']['last']);
+                unset($definitions[self::COLLECTION_BASE_SCHEMA_NAME]['properties']['_links']['properties']['next']);
+                unset($definitions[self::COLLECTION_BASE_SCHEMA_NAME]['properties']['_links']['properties']['previous']);
+            }
+
             unset($schema['items']);
             unset($schema['type']);
 

src/Hydra/JsonSchema/SchemaFactory.php

@@ -235,6 +235,10 @@ public function buildSchema(string $className, string $format = 'jsonld', string
             ];
         }
 
+        if (false === $operation->getPaginationEnabled()) {
+            unset($definitions[self::COLLECTION_BASE_SCHEMA_NAME]['properties'][$hydraPrefix.'view']);
+        }
+
         $definitionName = $this->definitionNameFactory->create($className, $format, $inputOrOutputClass, $operation, $serializerContext);
         $schema['type'] = 'object';
         $schema['description'] = "$definitionName collection.";

src/Hydra/Serializer/PartialCollectionViewNormalizer.php

@@ -95,6 +95,10 @@ public function normalize(mixed $object, ?string $format = null, array $context
 
         $partialCollectionView = $this->getPartialCollectionView($object, $context['uri'] ?? $context['request_uri'] ?? '/', $this->pageParameterName, $this->enabledParameterName, $operation?->getUrlGenerationStrategy() ?? $this->urlGenerationStrategy);
 
+        if (false === $operation?->getPaginationEnabled()) {
+            return $data;
+        }
+
         $view = [
             '@id' => $partialCollectionView->id,
             '@type' => $hydraPrefix.'PartialCollectionView',

src/JsonApi/JsonSchema/SchemaFactory.php

@@ -231,6 +231,19 @@ public function buildSchema(string $className, string $format = 'jsonapi', strin
             ];
         }
 
+        if (false === $operation->getPaginationEnabled()) {
+            unset($definitions[self::COLLECTION_BASE_SCHEMA_NAME]['properties']['links']['properties']['first']);
+            unset($definitions[self::COLLECTION_BASE_SCHEMA_NAME]['properties']['links']['properties']['last']);
+            unset($definitions[self::COLLECTION_BASE_SCHEMA_NAME]['properties']['links']['properties']['next']);
+            unset($definitions[self::COLLECTION_BASE_SCHEMA_NAME]['properties']['links']['properties']['prev']);
+            unset($definitions[self::COLLECTION_BASE_SCHEMA_NAME]['properties']['links']['example']['first']);
+            unset($definitions[self::COLLECTION_BASE_SCHEMA_NAME]['properties']['links']['example']['last']);
+            unset($definitions[self::COLLECTION_BASE_SCHEMA_NAME]['properties']['links']['example']['next']);
+            unset($definitions[self::COLLECTION_BASE_SCHEMA_NAME]['properties']['links']['example']['prev']);
+            unset($definitions[self::COLLECTION_BASE_SCHEMA_NAME]['properties']['meta']['properties']['itemsPerPage']);
+            unset($definitions[self::COLLECTION_BASE_SCHEMA_NAME]['properties']['meta']['properties']['currentPage']);
+        }
+
         unset($schema['items']);
         unset($schema['type']);
 

tests/Fixtures/TestBundle/Entity/PaginationDisabledEntity.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Fixtures\TestBundle\Entity;
+
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\GetCollection;
+use Doctrine\ORM\Mapping as ORM;
+
+#[ApiResource]
+#[GetCollection(
+    paginationEnabled: false,
+    paginationItemsPerPage: 3,
+)]
+#[ORM\Entity]
+class PaginationDisabledEntity
+{
+    #[ORM\Column(type: 'integer', nullable: true)]
+    #[ORM\Id]
+    #[ORM\GeneratedValue(strategy: 'AUTO')]
+    private ?int $id = null;
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+}