feat: update get_feeds endpoint to support string pagination parameters (#1108)

Author: AlfredNwolisa

docs/OperationsAPI.yaml

@@ -3,7 +3,7 @@ info:
   version: 1.0.0
   title: Mobility Database Catalog Operations
   description: |
-    API for the Mobility Database Catalog Operations. See [https://mobilitydatabase.org/](https://mobilitydatabase.org/). 
+    API for the Mobility Database Catalog Operations. See [https://mobilitydatabase.org/](https://mobilitydatabase.org/).
     This API was designed for internal use and is not intended to be used by the general public.
     The Mobility Database Operation API uses Auth2.0 authentication.
   termsOfService: https://mobilitydatabase.org/terms-and-conditions
@@ -33,29 +33,29 @@ paths:
           required: false
           schema:
             type: string
-            enum: [wip, published]
+            enum: [ wip, published ]
         - name: data_type
           in: query
           description: Filter feeds by data type.
           required: false
           schema:
             type: string
-            enum: [gtfs, gtfs_rt]
+            enum: [ gtfs, gtfs_rt ]
         - name: offset
           in: query
           description: Number of items to skip for pagination.
           required: false
           schema:
-            type: integer
-            default: 0
+            type: string
+            default: "0"
         - name: limit
           in: query
           description: Maximum number of items to return.
           required: false
           schema:
-            type: integer
-            default: 50
-            maximum: 100
+            type: string
+            default: "50"
+            example: "100"
       responses:
         200:
           description: List of feeds retrieved successfully.
@@ -86,7 +86,7 @@ paths:
         - "operations"
       operationId: updateGtfsFeed
       security:
-        - ApiKeyAuth: []
+        - ApiKeyAuth: [ ]
       requestBody:
         description: Payload to update the specified GTFS feed.
         required: true
@@ -118,7 +118,7 @@ paths:
         - "operations"
       operationId: updateGtfsRtFeed
       security:
-        - ApiKeyAuth: []
+        - ApiKeyAuth: [ ]
       requestBody:
         description: Payload to update the specified GTFS-RT feed.
         required: true
@@ -179,7 +179,7 @@ components:
           $ref: "#/components/schemas/SourceInfo"
         operational_status:
           type: string
-          enum: [wip, published]
+          enum: [ wip, published ]
           description: Current operational status of the feed.
         created_at:
           type: string
@@ -245,10 +245,10 @@ components:
           type: integer
           description: Total number of feeds matching the criteria.
         offset:
-          type: integer
+          type: string
           description: Current offset for pagination.
         limit:
-          type: integer
+          type: string
           description: Maximum number of items per page.
         feeds:
           type: array
@@ -285,13 +285,13 @@ components:
           example: Los Angeles Department of Transportation (LADOT, DASH, Commuter Express)
         feed_name:
           description: >
-            An optional description of the data feed, e.g to specify if the data feed is an aggregate of 
+            An optional description of the data feed, e.g to specify if the data feed is an aggregate of
             multiple providers, or which network is represented by the feed.
           type: string
           example: Bus
         note:
-         description: A note to clarify complex use cases for consumers.
-         type: string
+          description: A note to clarify complex use cases for consumers.
+          type: string
         feed_contact_email:
           description: Use to contact the feed producer.
           type: string
@@ -344,13 +344,13 @@ components:
           example: Los Angeles Department of Transportation (LADOT, DASH, Commuter Express)
         feed_name:
           description: >
-            An optional description of the data feed, e.g to specify if the data feed is an aggregate of 
+            An optional description of the data feed, e.g to specify if the data feed is an aggregate of
             multiple providers, or which network is represented by the feed.
           type: string
           example: Bus
         note:
-         description: A note to clarify complex use cases for consumers.
-         type: string
+          description: A note to clarify complex use cases for consumers.
+          type: string
         feed_contact_email:
           description: Use to contact the feed producer.
           type: string
@@ -396,7 +396,7 @@ components:
       properties:
         producer_url:
           description: >
-            URL where the producer is providing the dataset. 
+            URL where the producer is providing the dataset.
             Refer to the authentication information to know how to access this URL.
           type: string
           format: url
@@ -405,7 +405,7 @@ components:
           $ref: "#/components/schemas/Authentication_type"
         authentication_info_url:
           description: >
-            Contains a URL to a human-readable page describing how the authentication should be performed and how credentials can be created. 
+            Contains a URL to a human-readable page describing how the authentication should be performed and how credentials can be created.
             This field is required for `authentication_type=1` and `authentication_type=2`.
           type: string
           format: url
@@ -500,4 +500,4 @@ components:
       in: header
 
 security:
-  - ApiKeyAuth: []
+  - ApiKeyAuth: [ ]

functions-python/operations_api/src/feeds_operations/impl/feeds_operations_impl.py

@@ -20,6 +20,7 @@
 from deepdiff import DeepDiff
 from fastapi import HTTPException
 from pydantic import Field
+from sqlalchemy.orm import Session
 from starlette.responses import Response
 
 from feeds_operations.impl.models.get_feeds_response import GetFeeds200Response
@@ -39,13 +40,12 @@
 from feeds_operations_gen.models.update_request_gtfs_rt_feed import (
     UpdateRequestGtfsRtFeed,
 )
+from shared.database.database import with_db_session, refresh_materialized_view
 from shared.database_gen.sqlacodegen_models import Gtfsfeed, t_feedsearch
 from shared.helpers.query_helper import (
     query_feed_by_stable_id,
     get_feeds_query,
 )
-from sqlalchemy.orm import Session
-from shared.database.database import with_db_session, refresh_materialized_view
 from .request_validator import validate_request
 
 logging.basicConfig(level=logging.INFO)
@@ -72,20 +72,23 @@ def process_feed(self, feed) -> GtfsFeedResponse | GtfsRtFeedResponse:
     @with_db_session
     async def get_feeds(
         self,
-        db_session: Session,
         operation_status: Optional[str] = None,
         data_type: Optional[str] = None,
-        offset: int = 0,
-        limit: int = 50,
+        offset: str = "0",
+        limit: str = "50",
+        db_session: Session = None,
     ) -> GetFeeds200Response:
         """Get a list of feeds with optional filtering and pagination."""
         try:
+            limit_int = int(limit) if limit else 50
+            offset_int = int(offset) if offset else 0
+
             query = get_feeds_query(
                 db_session=db_session,
                 operation_status=operation_status,
                 data_type=data_type,
-                limit=limit,
-                offset=offset,
+                limit=limit_int,
+                offset=offset_int,
             )
 
             logging.info("Executing query with data_type: %s", data_type)
@@ -100,7 +103,7 @@ async def get_feeds(
                 feed_list.append(processed_feed)
 
             response = GetFeeds200Response(
-                total=total, offset=offset, limit=limit, feeds=feed_list
+                total=total, offset=offset_int, limit=limit_int, feeds=feed_list
             )
             logging.info("Returning response with %d feeds", len(feed_list))
             return response