⬆️ ♻️ Upgrade pagination customisation in api-server (#6545)

Author: pcrespov

services/api-server/requirements/_base.txt

@@ -156,12 +156,9 @@ fastapi==0.99.1
     #   -c requirements/../../../requirements/constraints.txt
     #   -r requirements/../../../packages/service-library/requirements/_fastapi.in
     #   -r requirements/_base.in
-    #   fastapi-pagination
     #   prometheus-fastapi-instrumentator
-fastapi-pagination==0.12.17
-    # via
-    #   -c requirements/./constraints.txt
-    #   -r requirements/_base.in
+fastapi-pagination==0.12.31
+    # via -r requirements/_base.in
 faststream==0.5.10
     # via
     #   -r requirements/../../../packages/service-library/requirements/_base.in

services/api-server/requirements/constraints.txt

@@ -40,31 +40,3 @@ aws-sam-translator<1.56.0
 # #   aws-sam-translator<1.55.0 (from -c ./constraints.txt (line 32))
 # #   aws-sam-translator>=1.57.0 (from cfn-lint==0.72.10->-c ./constraints.txt (line 33))
 cfn-lint<0.72.1
-
-
-
-#
-# .venv/lib/python3.10/site-packages/fastapi_pagination/api.py:352: in _update_route
-#     get_parameterless_sub_dependant(
-# .venv/lib/python3.10/site-packages/fastapi/dependencies/utils.py:136: in get_parameterless_sub_dependant
-#     return get_sub_dependant(depends=depends, dependency=depends.dependency, path=path)
-# .venv/lib/python3.10/site-packages/fastapi/dependencies/utils.py:159: in get_sub_dependant
-#     sub_dependant = get_dependant(
-# .venv/lib/python3.10/site-packages/fastapi/dependencies/utils.py:310: in get_dependant
-#     sub_dependant = get_param_sub_dependant(
-# .venv/lib/python3.10/site-packages/fastapi/dependencies/utils.py:123: in get_param_sub_dependant
-#     return get_sub_dependant(
-# .venv/lib/python3.10/site-packages/fastapi/dependencies/utils.py:159: in get_sub_dependant
-#     sub_dependant = get_dependant(
-# .venv/lib/python3.10/site-packages/fastapi/dependencies/utils.py:331: in get_dependant
-#     add_param_to_fields(field=param_field, dependant=dependant)
-# _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
-
-#     def add_param_to_fields(*, field: ModelField, dependant: Dependant) -> None:
-#         field_info = cast(params.Param, field.field_info)
-# >       if field_info.in_ == params.ParamTypes.path:
-# E       AttributeError: 'FieldInfo' object has no attribute 'in_'
-
-# .venv/lib/python3.10/site-packages/fastapi/dependencies/utils.py:500: AttributeError
-
-fastapi-pagination<=0.12.17

services/api-server/src/simcore_service_api_server/models/pagination.py

@@ -9,30 +9,36 @@
 from collections.abc import Sequence
 from typing import Any, ClassVar, Generic, TypeAlias, TypeVar
 
-from fastapi_pagination.limit_offset import LimitOffsetParams
-from fastapi_pagination.links.limit_offset import (
-    LimitOffsetPage as _FastApiLimitOffsetPage,
-)
+from fastapi import Query
+from fastapi_pagination.customization import CustomizedPage, UseName, UseParamsFields
+from fastapi_pagination.limit_offset import LimitOffsetParams as _LimitOffsetParams
+from fastapi_pagination.links import LimitOffsetPage as _LimitOffsetPage
 from models_library.rest_pagination import (
     DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
     MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE,
 )
 from models_library.utils.pydantic_tools_extension import FieldNotRequired
-from pydantic import Field, NonNegativeInt, validator
+from pydantic import NonNegativeInt, validator
 from pydantic.generics import GenericModel
 
 T = TypeVar("T")
 
-# NOTE: same pagination limits and defaults as web-server
-Page = _FastApiLimitOffsetPage.with_custom_options(
-    limit=Field(
-        DEFAULT_NUMBER_OF_ITEMS_PER_PAGE, ge=1, le=MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE
-    )
-)
-# NOTE: Renamed to make shorter clients name models
-Page.__name__ = "Page"
-
-PaginationParams: TypeAlias = LimitOffsetParams
+Page = CustomizedPage[
+    _LimitOffsetPage[T],
+    # Customizes the default and maximum to fit those of the web-server. It simplifies interconnection
+    UseParamsFields(
+        limit=Query(
+            DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
+            ge=1,
+            le=MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE,
+            description="Page size limit",
+        )
+    ),
+    # Renames class for the openapi.json to make the python-client's name models shorter
+    UseName(name="Page"),
+]
+
+PaginationParams: TypeAlias = _LimitOffsetParams
 
 
 class OnePage(GenericModel, Generic[T]):