Added countable and paginatable (works for now but should be re-visited)

Author: joshmurrayeu

src/Endpoint/Concerns/BuildsOpenApiPaths.php

@@ -7,7 +7,6 @@
 use Tobyz\JsonApiServer\Endpoint\Index;
 use Tobyz\JsonApiServer\JsonApi;
 use Tobyz\JsonApiServer\Resource\Collection;
-use Tobyz\JsonApiServer\Resource\Listable;
 use Tobyz\JsonApiServer\Resource\Resource;
 use Tobyz\JsonApiServer\Schema\Field\Field;
 use Tobyz\JsonApiServer\Schema\Field\Relationship;
@@ -21,6 +20,8 @@ private function buildOpenApiContent(
         bool $multiple = false,
         bool $included = true,
         bool $links = false,
+        bool $countable = false,
+        bool $paginatable = false,
     ): array {
         $item = count($resources) === 1 ? $resources[0] : ['oneOf' => $resources];
 
@@ -33,6 +34,7 @@ private function buildOpenApiContent(
                         'links' => $links ? $this->buildLinksObject($name) : [],
                         'data' => $multiple ? ['type' => 'array', 'items' => $item] : $item,
                         'included' => $included ? ['type' => 'array'] : [],
+                        'meta' => $this->buildMetaObject($countable, $paginatable),
                     ]),
                 ],
             ],
@@ -79,6 +81,27 @@ private function buildLinksObject(string $name): array
         ];
     }
 
+    private function buildMetaObject(bool $countable, bool $paginatable): array
+    {
+        if (!($countable || $paginatable)) {
+            return [];
+        }
+
+        return [
+            'type' => 'object',
+            'properties' => [
+                'page' => [
+                    'type' => 'object',
+                    'properties' => array_filter([
+                        'total' => $countable ? ['type' => 'integer'] : [],
+                        'limit' => $paginatable ? ['type' => 'integer'] : [],
+                        'offset' => $paginatable ? ['type' => 'integer'] : [],
+                    ]),
+                ],
+            ],
+        ];
+    }
+
     /**
      * @throws ReflectionException
      */

src/Endpoint/Index.php

@@ -199,6 +199,8 @@ public function getOpenApiPaths(Collection $collection): array
                                 ),
                                 multiple: true,
                                 links: true,
+                                countable: true,
+                                paginatable: true,
                             ),
                         ],
                         '400' => $this->buildBadRequestErrorResponse(),