Merge pull request #13 from creyD/dev

Co-authored-by: vikbhas <waraa.vignesh@gmail.com>

.github/workflows/ci.yml

@@ -12,7 +12,6 @@ on:
       - "**/CHANGELOG.md"
   pull_request:
     branches:
-      - master
       - dev
   workflow_dispatch:
 
@@ -46,7 +45,7 @@ jobs:
 
   tag_and_publish:
     runs-on: ubuntu-latest
-    if: github.head_ref == 'master' || github.head_ref == 'dev'
+    if: github.ref_name == 'master' || github.ref_name == 'dev'
     needs: test
     permissions:
       id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
@@ -56,7 +55,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-tags: true
-          ref: ${{ github.head_ref }}
+          ref: ${{ github.ref_name }}
           fetch-depth: 0
 
       - name: setup git
@@ -67,7 +66,7 @@ jobs:
       - name: set version format
         id: version_format
         run: |
-          if [[ ${{ github.head_ref }} == 'master' ]]; then
+          if [[ ${{ github.ref_name }} == 'master' ]]; then
             echo "version_format=\${major}.\${minor}.\${patch}" >> $GITHUB_OUTPUT
           else
             echo "version_format=\${major}.\${minor}.\${patch}rc\${increment}" >> $GITHUB_OUTPUT
@@ -84,7 +83,6 @@ jobs:
           version_format: ${{ steps.version_format.outputs.version_format }}
 
       - name: Create & Push Tag
-        if: github.head_ref == 'master' || github.head_ref == 'dev'
         run: |
           git tag ${{ steps.git_version.outputs.version }}
           git push origin ${{ steps.git_version.outputs.version }}

creyPY/fastapi/pagination.py

@@ -1,6 +1,6 @@
 from math import ceil
 from typing import Any, Generic, Optional, Self, Sequence, TypeVar, Union
-
+from pydantic import BaseModel
 from fastapi_pagination import Params
 from fastapi_pagination.bases import AbstractPage, AbstractParams
 from fastapi_pagination.types import (
@@ -12,14 +12,28 @@ from fastapi_pagination.types import (
 from fastapi_pagination.api import create_page, apply_items_transformer
 from fastapi_pagination.utils import verify_params
 from fastapi_pagination.ext.sqlalchemy import create_paginate_query
+from fastapi_pagination.bases import AbstractParams, RawParams
 from pydantic.json_schema import SkipJsonSchema
 from sqlalchemy.sql.selectable import Select
 from sqlalchemy.orm.session import Session
 from sqlalchemy import select, func
+from fastapi import Query
 
 T = TypeVar("T")
 
 
+class PaginationParams(BaseModel, AbstractParams):
+    page: int = Query(1, ge=1, description="Page number")
+    size: int = Query(50, ge=1, le=100, description="Page size")
+    pagination: bool = Query(True, description="Toggle pagination")
+
+    def to_raw_params(self) -> RawParams:
+        if not self.pagination:
+            return RawParams(limit=None, offset=None)
+
+        return RawParams(limit=self.size, offset=(self.page - 1) * self.size)
+
+
 # TODO: Add complete fastapi-pagination proxy here
 # TODO: Add pagination off functionality
 # SkipJsonSchema is used to avoid generating invalid JSON schema in FastAPI
@@ -32,7 +46,7 @@ class Page(AbstractPage[T], Generic[T]):
     has_next: bool | SkipJsonSchema[None] = None
     has_prev: bool | SkipJsonSchema[None] = None
 
-    __params_type__ = Params
+    __params_type__ = PaginationParams
 
     @classmethod
     def create(
@@ -97,18 +111,19 @@ def unwrap_scalars(
 def paginate(
     connection: Session,
     query: Select,
-    paginationFlag: bool = True,
     params: Optional[AbstractParams] = None,
     transformer: Optional[SyncItemsTransformer] = None,
     additional_data: Optional[AdditionalData] = None,
 ):
-    params, _ = verify_params(params, "limit-offset", "cursor")
 
+    params, raw_params = verify_params(params, "limit-offset", "cursor")
     count_query = create_count_query(query)
     total = connection.scalar(count_query)
 
-    if paginationFlag is False and total > 0:
+    if params.pagination is False and total > 0:
         params = Params(page=1, size=total)
+    else:
+        params = Params(page=params.page, size=params.size)
 
     query = create_paginate_query(query, params)
     items = connection.execute(query).all()