Add Pagination to API responses (rtdip#659)

* updates for pagination for raw api response Signed-off-by: Chloe Ching <chloe.ching@shell.com> * update models for pagination Signed-off-by: Chloe Ching <chloe.ching@shell.com> * added pagination logic to raw Signed-off-by: Chloe Ching <chloe.ching@shell.com> * add pagination logic to all time series apis Signed-off-by: Chloe Ching <chloe.ching@shell.com> * updates Signed-off-by: Chloe Ching <chloe.ching@shell.com> * updated unit test for api pagination Signed-off-by: Chloe Ching <chloe.ching@shell.com> --------- Signed-off-by: Chloe Ching <chloe.ching@shell.com>
rodalynbarce · Feb 12, 2024 · 019990f · 019990f
1 parent f997c1a
commit 019990f
Show file tree

Hide file tree

Showing 21 changed files with 248 additions and 1 deletion.
diff --git a/src/api/v1/circular_average.py b/src/api/v1/circular_average.py
@@ -34,6 +34,7 @@
     CircularAverageQueryParams,
     PivotQueryParams,
     LimitOffsetQueryParams,
+    PaginationRow,
 )
 import src.api.v1.common
 
@@ -61,15 +62,35 @@ def circular_average_events_get(
         )
 
         data = circular_average.get(connection, parameters)
+
+        pagination = None
+
+        if (
+            limit_offset_parameters.limit is not None
+            and limit_offset_parameters.offset is not None
+        ):
+            next = None
+
+            if len(data.index) == limit_offset_parameters.limit:
+                next = limit_offset_parameters.offset + limit_offset_parameters.limit
+
+            pagination = PaginationRow(
+                limit=limit_offset_parameters.limit,
+                offset=limit_offset_parameters.offset,
+                next=next,
+            )
+
         if parameters.get("pivot") == True:
             return PivotResponse(
                 schema=build_table_schema(data, index=False, primary_key=False),
                 data=data.replace({np.nan: None}).to_dict(orient="records"),
+                pagination=pagination,
             )
         else:
             return ResampleInterpolateResponse(
                 schema=build_table_schema(data, index=False, primary_key=False),
                 data=data.replace({np.nan: None}).to_dict(orient="records"),
+                pagination=pagination,
             )
     except Exception as e:
         logging.error(str(e))

diff --git a/src/api/v1/circular_standard_deviation.py b/src/api/v1/circular_standard_deviation.py
@@ -34,6 +34,7 @@
     PivotQueryParams,
     LimitOffsetQueryParams,
     CircularAverageQueryParams,
+    PaginationRow,
 )
 import src.api.v1.common
 
@@ -61,16 +62,37 @@ def circular_standard_deviation_events_get(
         )
 
         data = circular_standard_deviation.get(connection, parameters)
+
+        pagination = None
+
+        if (
+            limit_offset_parameters.limit is not None
+            and limit_offset_parameters.offset is not None
+        ):
+            next = None
+
+            if len(data.index) == limit_offset_parameters.limit:
+                next = limit_offset_parameters.offset + limit_offset_parameters.limit
+
+            pagination = PaginationRow(
+                limit=limit_offset_parameters.limit,
+                offset=limit_offset_parameters.offset,
+                next=next,
+            )
+
         if parameters.get("pivot") == True:
             return PivotResponse(
                 schema=build_table_schema(data, index=False, primary_key=False),
                 data=data.replace({np.nan: None}).to_dict(orient="records"),
+                pagination=pagination,
             )
         else:
             return ResampleInterpolateResponse(
                 schema=build_table_schema(data, index=False, primary_key=False),
                 data=data.replace({np.nan: None}).to_dict(orient="records"),
+                pagination=pagination,
             )
+
     except Exception as e:
         logging.error(str(e))
         raise HTTPException(status_code=400, detail=str(e))

diff --git a/src/api/v1/interpolate.py b/src/api/v1/interpolate.py
@@ -33,6 +33,7 @@
     InterpolateQueryParams,
     PivotQueryParams,
     LimitOffsetQueryParams,
+    PaginationRow,
 )
 import src.api.v1.common
 
@@ -62,15 +63,35 @@ def interpolate_events_get(
         )
 
         data = interpolate.get(connection, parameters)
+
+        pagination = None
+
+        if (
+            limit_offset_parameters.limit is not None
+            and limit_offset_parameters.offset is not None
+        ):
+            next = None
+
+            if len(data.index) == limit_offset_parameters.limit:
+                next = limit_offset_parameters.offset + limit_offset_parameters.limit
+
+            pagination = PaginationRow(
+                limit=limit_offset_parameters.limit,
+                offset=limit_offset_parameters.offset,
+                next=next,
+            )
+
         if parameters.get("pivot") == True:
             return PivotResponse(
                 schema=build_table_schema(data, index=False, primary_key=False),
                 data=data.replace({np.nan: None}).to_dict(orient="records"),
+                pagination=pagination,
             )
         else:
             return ResampleInterpolateResponse(
                 schema=build_table_schema(data, index=False, primary_key=False),
                 data=data.replace({np.nan: None}).to_dict(orient="records"),
+                pagination=pagination,
             )
     except Exception as e:
         logging.error(str(e))

diff --git a/src/api/v1/interpolation_at_time.py b/src/api/v1/interpolation_at_time.py
@@ -31,6 +31,7 @@
     InterpolationAtTimeQueryParams,
     PivotQueryParams,
     LimitOffsetQueryParams,
+    PaginationRow,
 )
 import src.api.v1.common
 
@@ -56,15 +57,35 @@ def interpolation_at_time_events_get(
         )
 
         data = interpolation_at_time.get(connection, parameters)
+
+        pagination = None
+
+        if (
+            limit_offset_parameters.limit is not None
+            and limit_offset_parameters.offset is not None
+        ):
+            next = None
+
+            if len(data.index) == limit_offset_parameters.limit:
+                next = limit_offset_parameters.offset + limit_offset_parameters.limit
+
+            pagination = PaginationRow(
+                limit=limit_offset_parameters.limit,
+                offset=limit_offset_parameters.offset,
+                next=next,
+            )
+
         if parameters.get("pivot") == True:
             return PivotResponse(
                 schema=build_table_schema(data, index=False, primary_key=False),
                 data=data.replace({np.nan: None}).to_dict(orient="records"),
+                pagination=pagination,
             )
         else:
             return ResampleInterpolateResponse(
                 schema=build_table_schema(data, index=False, primary_key=False),
                 data=data.replace({np.nan: None}).to_dict(orient="records"),
+                pagination=pagination,
             )
     except Exception as e:
         logging.error(str(e))

diff --git a/src/api/v1/latest.py b/src/api/v1/latest.py
@@ -27,6 +27,7 @@
     LatestResponse,
     LimitOffsetQueryParams,
     HTTPError,
+    PaginationRow,
 )
 from src.api.auth.azuread import oauth2_scheme
 from src.api.FastAPIApp import api_v1_router
@@ -47,9 +48,28 @@ def latest_retrieval_get(
         )
 
         data = latest.get(connection, parameters)
+
+        pagination = None
+
+        if (
+            limit_offset_parameters.limit is not None
+            and limit_offset_parameters.offset is not None
+        ):
+            next = None
+
+            if len(data.index) == limit_offset_parameters.limit:
+                next = limit_offset_parameters.offset + limit_offset_parameters.limit
+
+            pagination = PaginationRow(
+                limit=limit_offset_parameters.limit,
+                offset=limit_offset_parameters.offset,
+                next=next,
+            )
+
         return LatestResponse(
             schema=build_table_schema(data, index=False, primary_key=False),
             data=data.replace({np.nan: None}).to_dict(orient="records"),
+            pagination=pagination,
         )
     except Exception as e:
         logging.error(str(e))

diff --git a/src/api/v1/metadata.py b/src/api/v1/metadata.py
@@ -27,6 +27,7 @@
     MetadataResponse,
     LimitOffsetQueryParams,
     HTTPError,
+    PaginationRow,
 )
 from src.api.auth.azuread import oauth2_scheme
 from src.api.FastAPIApp import api_v1_router
@@ -47,10 +48,30 @@ def metadata_retrieval_get(
         )
 
         data = metadata.get(connection, parameters)
+
+        pagination = None
+
+        if (
+            limit_offset_parameters.limit is not None
+            and limit_offset_parameters.offset is not None
+        ):
+            next = None
+
+            if len(data.index) == limit_offset_parameters.limit:
+                next = limit_offset_parameters.offset + limit_offset_parameters.limit
+
+            pagination = PaginationRow(
+                limit=limit_offset_parameters.limit,
+                offset=limit_offset_parameters.offset,
+                next=next,
+            )
+
         return MetadataResponse(
             schema=build_table_schema(data, index=False, primary_key=False),
             data=data.replace({np.nan: None}).to_dict(orient="records"),
+            pagination=pagination,
         )
+
     except Exception as e:
         logging.error(str(e))
         raise HTTPException(status_code=400, detail=str(e))

diff --git a/src/api/v1/models.py b/src/api/v1/models.py
@@ -67,6 +67,12 @@ class LatestRow(BaseModel):
     GoodValueType: Union[str, None]
 
 
+class PaginationRow(BaseModel):
+    limit: Union[int, None]
+    offset: Union[int, None]
+    next: Union[int, None]
+
+
 class RawRow(BaseModel):
     EventTime: datetime
     TagName: str
@@ -90,20 +96,23 @@ class MetadataResponse(BaseModel):
         None, alias="schema", serialization_alias="schema"
     )
     data: List[MetadataRow]
+    pagination: Union[PaginationRow, None]
 
 
 class LatestResponse(BaseModel):
     field_schema: FieldSchema = Field(
         None, alias="schema", serialization_alias="schema"
     )
     data: List[LatestRow]
+    pagination: Union[PaginationRow, None]
 
 
 class RawResponse(BaseModel):
     field_schema: FieldSchema = Field(
         None, alias="schema", serialization_alias="schema"
     )
     data: List[RawRow]
+    pagination: Union[PaginationRow, None]
 
 
 class ResampleInterpolateRow(BaseModel):
@@ -123,20 +132,23 @@ class ResampleInterpolateResponse(BaseModel):
         None, alias="schema", serialization_alias="schema"
     )
     data: List[ResampleInterpolateRow]
+    pagination: Union[PaginationRow, None]
 
 
 class SummaryResponse(BaseModel):
     field_schema: FieldSchema = Field(
         None, alias="schema", serialization_alias="schema"
     )
     data: List[SummaryRow]
+    pagination: Union[PaginationRow, None]
 
 
 class PivotResponse(BaseModel):
     field_schema: FieldSchema = Field(
         None, alias="schema", serialization_alias="schema"
     )
     data: List[PivotRow]
+    pagination: Union[PaginationRow, None]
 
 
 class HTTPError(BaseModel):

diff --git a/src/api/v1/raw.py b/src/api/v1/raw.py
@@ -18,7 +18,7 @@
 from pandas.io.json import build_table_schema
 from fastapi import Query, HTTPException, Depends, Body
 import nest_asyncio
-from src.sdk.python.rtdip_sdk.queries.time_series import raw
+from src.sdk.python.rtdip_sdk.queries.time_series import raw, summary
 from src.api.v1.models import (
     BaseHeaders,
     BaseQueryParams,
@@ -28,6 +28,7 @@
     TagsBodyParams,
     LimitOffsetQueryParams,
     HTTPError,
+    PaginationRow,
 )
 from src.api.auth.azuread import oauth2_scheme
 from src.api.FastAPIApp import api_v1_router
@@ -53,9 +54,28 @@ def raw_events_get(
         )
 
         data = raw.get(connection, parameters)
+
+        pagination = None
+
+        if (
+            limit_offset_parameters.limit is not None
+            and limit_offset_parameters.offset is not None
+        ):
+            next = None
+
+            if len(data.index) == limit_offset_parameters.limit:
+                next = limit_offset_parameters.offset + limit_offset_parameters.limit
+
+            pagination = PaginationRow(
+                limit=limit_offset_parameters.limit,
+                offset=limit_offset_parameters.offset,
+                next=next,
+            )
+
         return RawResponse(
             schema=build_table_schema(data, index=False, primary_key=False),
             data=data.replace({np.nan: None}).to_dict(orient="records"),
+            pagination=pagination,
         )
     except Exception as e:
         logging.error(str(e))