Merge pull request #89 from OCHA-DAP/feature/HDX-9804_response_in_data_key

HDX-9804 Put responses into a "data" key

Author: alexandru-m-g

hdx_hapi/endpoints/get_admin_level.py

@@ -1,5 +1,6 @@
+from typing import Annotated
 from datetime import date
-from typing import List, Annotated
+
 from fastapi import Depends, Query, APIRouter
 from pydantic import NaiveDatetime
 
@@ -20,6 +21,7 @@
     DOC_HAPI_REPLACED_DATE_MAX,
 )
 
+from hdx_hapi.endpoints.models.base import HapiGenericResponse
 from hdx_hapi.endpoints.models.admin_level import Admin1Response, Admin2Response, LocationResponse
 from hdx_hapi.endpoints.util.util import (
     CommonEndpointParams,
@@ -41,13 +43,13 @@
 
 @router.get(
     '/api/location',
-    response_model=List[LocationResponse],
+    response_model=HapiGenericResponse[LocationResponse],
     summary='Get the list of locations (typically countries) included in HAPI',
     include_in_schema=False,
 )
 @router.get(
     '/api/v1/location',
-    response_model=List[LocationResponse],
+    response_model=HapiGenericResponse[LocationResponse],
     summary='Get the list of locations (typically countries) included in HAPI',
 )
 async def get_locations(
@@ -94,13 +96,13 @@ async def get_locations(
 
 @router.get(
     '/api/admin1',
-    response_model=List[Admin1Response],
+    response_model=HapiGenericResponse[Admin1Response],
     summary='Get the list of first-level subnational administrative divisions available in HAPI',
     include_in_schema=False,
 )
 @router.get(
     '/api/v1/admin1',
-    response_model=List[Admin1Response],
+    response_model=HapiGenericResponse[Admin1Response],
     summary='Get the list of first-level subnational administrative divisions available in HAPI',
 )
 async def get_admin1(
@@ -151,13 +153,13 @@ async def get_admin1(
 
 @router.get(
     '/api/admin2',
-    response_model=List[Admin2Response],
+    response_model=HapiGenericResponse[Admin2Response],
     summary='Get the list of second-level administrative divisions available in HAPI',
     include_in_schema=False,
 )
 @router.get(
     '/api/v1/admin2',
-    response_model=List[Admin2Response],
+    response_model=HapiGenericResponse[Admin2Response],
     summary='Get the list of second-level administrative divisions available in HAPI',
 )
 async def get_admin2(

hdx_hapi/endpoints/get_demographic.py

@@ -1,4 +1,4 @@
-from typing import List, Annotated
+from typing import Annotated
 from fastapi import Depends, Query, APIRouter
 
 
@@ -11,6 +11,7 @@
     DOC_GENDER_SUMMARY,
 )
 
+from hdx_hapi.endpoints.models.base import HapiGenericResponse
 from hdx_hapi.endpoints.models.demographic import AgeRangeResponse, GenderResponse
 from hdx_hapi.endpoints.util.util import CommonEndpointParams, common_endpoint_parameters, OutputFormat
 from hdx_hapi.services.age_range_logic import get_age_ranges_srv
@@ -25,9 +26,14 @@
 
 
 @router.get(
-    '/api/age_range', response_model=List[AgeRangeResponse], summary=f'{DOC_AGE_RANGE_SUMMARY}', include_in_schema=False
+    '/api/age_range',
+    response_model=HapiGenericResponse[AgeRangeResponse],
+    summary=f'{DOC_AGE_RANGE_SUMMARY}',
+    include_in_schema=False,
+)
+@router.get(
+    '/api/v1/age_range', response_model=HapiGenericResponse[AgeRangeResponse], summary=f'{DOC_AGE_RANGE_SUMMARY}'
 )
-@router.get('/api/v1/age_range', response_model=List[AgeRangeResponse], summary=f'{DOC_AGE_RANGE_SUMMARY}')
 async def get_age_ranges(
     common_parameters: Annotated[CommonEndpointParams, Depends(common_endpoint_parameters)],
     db: AsyncSession = Depends(get_db),
@@ -49,9 +55,12 @@ async def get_age_ranges(
 
 
 @router.get(
-    '/api/gender', response_model=List[GenderResponse], summary=f'{DOC_GENDER_SUMMARY}', include_in_schema=False
+    '/api/gender',
+    response_model=HapiGenericResponse[GenderResponse],
+    summary=f'{DOC_GENDER_SUMMARY}',
+    include_in_schema=False,
 )
-@router.get('/api/v1/gender', response_model=List[GenderResponse], summary=f'{DOC_GENDER_SUMMARY}')
+@router.get('/api/v1/gender', response_model=HapiGenericResponse[GenderResponse], summary=f'{DOC_GENDER_SUMMARY}')
 async def get_genders(
     common_parameters: Annotated[CommonEndpointParams, Depends(common_endpoint_parameters)],
     db: AsyncSession = Depends(get_db),

hdx_hapi/endpoints/get_encoded_identifier.py

@@ -2,10 +2,9 @@
 from typing import Annotated
 from fastapi import APIRouter
 from pydantic import EmailStr
-from hdx_hapi.services.csv_transform_logic import transform_result_to_csv_stream_if_requested
 
 from hdx_hapi.endpoints.models.encoded_identifier import IdentifierResponse
-from hdx_hapi.endpoints.util.util import OutputFormat, app_name_identifier_query, email_identifier_query
+from hdx_hapi.endpoints.util.util import app_name_identifier_query, email_identifier_query
 
 router = APIRouter(
     tags=['Utility'],
@@ -35,4 +34,5 @@ async def get_encoded_identifier(
     encoded_identifier = base64.b64encode(bytes(f'{application}:{email}', 'utf-8'))
 
     result = {'encoded_identifier': encoded_identifier.decode('utf-8')}
-    return transform_result_to_csv_stream_if_requested(result, OutputFormat.JSON, IdentifierResponse)
+    return result
+    # return transform_result_to_csv_stream_if_requested(result, OutputFormat.JSON, IdentifierResponse)

hdx_hapi/endpoints/get_food_security.py

@@ -1,5 +1,5 @@
 from datetime import date
-from typing import List, Annotated
+from typing import Annotated
 from fastapi import Depends, Query, APIRouter
 from pydantic import NaiveDatetime
 
@@ -18,6 +18,7 @@
     DOC_HAPI_REPLACED_DATE_MAX,
 )
 
+from hdx_hapi.endpoints.models.base import HapiGenericResponse
 from hdx_hapi.endpoints.models.food_security import FoodSecurityResponse
 from hdx_hapi.endpoints.util.util import AdminLevel, CommonEndpointParams, OutputFormat, common_endpoint_parameters
 from hdx_hapi.services.csv_transform_logic import transform_result_to_csv_stream_if_requested
@@ -31,11 +32,15 @@
 
 @router.get(
     '/api/themes/food_security',
-    response_model=List[FoodSecurityResponse],
+    response_model=HapiGenericResponse[FoodSecurityResponse],
     summary='Get food security data',
     include_in_schema=False,
 )
-@router.get('/api/v1/themes/food_security', response_model=List[FoodSecurityResponse], summary='Get food security data')
+@router.get(
+    '/api/v1/themes/food_security',
+    response_model=HapiGenericResponse[FoodSecurityResponse],
+    summary='Get food security data',
+)
 async def get_food_security(
     common_parameters: Annotated[CommonEndpointParams, Depends(common_endpoint_parameters)],
     db: AsyncSession = Depends(get_db),

hdx_hapi/endpoints/get_hdx_metadata.py

@@ -1,5 +1,5 @@
 from datetime import date
-from typing import List, Annotated
+from typing import Annotated
 from fastapi import Depends, Query, APIRouter
 from pydantic import NaiveDatetime
 
@@ -24,6 +24,7 @@
     DOC_HAPI_REPLACED_DATE_MAX,
 )
 
+from hdx_hapi.endpoints.models.base import HapiGenericResponse
 from hdx_hapi.endpoints.models.hdx_metadata import DatasetResponse, ResourceResponse
 from hdx_hapi.endpoints.util.util import (
     CommonEndpointParams,
@@ -42,13 +43,13 @@
 
 @router.get(
     '/api/dataset',
-    response_model=List[DatasetResponse],
+    response_model=HapiGenericResponse[DatasetResponse],
     summary='Get information about the sources of the data in HAPI',
     include_in_schema=False,
 )
 @router.get(
     '/api/v1/dataset',
-    response_model=List[DatasetResponse],
+    response_model=HapiGenericResponse[DatasetResponse],
     summary='Get information about the sources of the data in HAPI',
 )
 async def get_datasets(
@@ -79,13 +80,13 @@ async def get_datasets(
 
 @router.get(
     '/api/resource',
-    response_model=List[ResourceResponse],
+    response_model=HapiGenericResponse[ResourceResponse],
     summary='Get information about the sources of the data in HAPI',
     include_in_schema=False,
 )
 @router.get(
     '/api/v1/resource',
-    response_model=List[ResourceResponse],
+    response_model=HapiGenericResponse[ResourceResponse],
     summary='Get information about the sources of the data in HAPI',
 )
 async def get_resources(

hdx_hapi/endpoints/get_humanitarian_needs.py

@@ -1,5 +1,5 @@
 from datetime import date
-from typing import List, Annotated
+from typing import Annotated
 from fastapi import Depends, Query, APIRouter
 from pydantic import NaiveDatetime
 
@@ -28,6 +28,7 @@
     DOC_HAPI_REPLACED_DATE_MAX,
 )
 
+from hdx_hapi.endpoints.models.base import HapiGenericResponse
 from hdx_hapi.endpoints.models.humanitarian_needs import HumanitarianNeedsResponse
 from hdx_hapi.endpoints.util.util import AdminLevel, CommonEndpointParams, OutputFormat, common_endpoint_parameters
 from hdx_hapi.services.csv_transform_logic import transform_result_to_csv_stream_if_requested
@@ -41,13 +42,13 @@
 
 @router.get(
     '/api/themes/humanitarian_needs',
-    response_model=List[HumanitarianNeedsResponse],
+    response_model=HapiGenericResponse[HumanitarianNeedsResponse],
     summary='Get humanitarian needs data',
     include_in_schema=False,
 )
 @router.get(
     '/api/v1/themes/humanitarian_needs',
-    response_model=List[HumanitarianNeedsResponse],
+    response_model=HapiGenericResponse[HumanitarianNeedsResponse],
     summary='Get humanitarian needs data',
 )
 async def get_humanitarian_needs(

hdx_hapi/endpoints/get_humanitarian_response.py

@@ -1,4 +1,4 @@
-from typing import List, Annotated
+from typing import Annotated
 from fastapi import Depends, Query, APIRouter
 
 
@@ -13,6 +13,7 @@
     DOC_SEE_ORG_TYPE,
 )
 
+from hdx_hapi.endpoints.models.base import HapiGenericResponse
 from hdx_hapi.endpoints.models.humanitarian_response import OrgResponse, OrgTypeResponse, SectorResponse
 from hdx_hapi.endpoints.util.util import (
     CommonEndpointParams,
@@ -33,13 +34,13 @@
 
 @router.get(
     '/api/org',
-    response_model=List[OrgResponse],
+    response_model=HapiGenericResponse[OrgResponse],
     summary='Get the list of organizations represented in the data available in HAPI',
     include_in_schema=False,
 )
 @router.get(
     '/api/v1/org',
-    response_model=List[OrgResponse],
+    response_model=HapiGenericResponse[OrgResponse],
     summary='Get the list of organizations represented in the data available in HAPI',
 )
 async def get_orgs(
@@ -80,13 +81,13 @@ async def get_orgs(
 
 @router.get(
     '/api/org_type',
-    response_model=List[OrgTypeResponse],
+    response_model=HapiGenericResponse[OrgTypeResponse],
     summary='Get information about how organizations are classified in HAPI',
     include_in_schema=False,
 )
 @router.get(
     '/api/v1/org_type',
-    response_model=List[OrgTypeResponse],
+    response_model=HapiGenericResponse[OrgTypeResponse],
     summary='Get information about how organizations are classified in HAPI',
 )
 async def get_org_types(
@@ -112,13 +113,13 @@ async def get_org_types(
 
 @router.get(
     '/api/sector',
-    response_model=List[SectorResponse],
+    response_model=HapiGenericResponse[SectorResponse],
     summary='Get information about how humanitarian response activities are classified',
     include_in_schema=False,
 )
 @router.get(
     '/api/v1/sector',
-    response_model=List[SectorResponse],
+    response_model=HapiGenericResponse[SectorResponse],
     summary='Get information about how humanitarian response activities are classified',
 )
 async def get_sectors(

hdx_hapi/endpoints/get_national_risk.py

@@ -1,5 +1,5 @@
 from datetime import date
-from typing import List, Annotated
+from typing import Annotated
 from fastapi import Depends, Query, APIRouter
 from pydantic import NaiveDatetime
 
@@ -19,6 +19,7 @@
     DOC_HAPI_REPLACED_DATE_MAX,
 )
 
+from hdx_hapi.endpoints.models.base import HapiGenericResponse
 from hdx_hapi.endpoints.models.national_risk import NationalRiskResponse
 from hdx_hapi.endpoints.util.util import CommonEndpointParams, OutputFormat, common_endpoint_parameters
 from hdx_hapi.services.csv_transform_logic import transform_result_to_csv_stream_if_requested
@@ -32,11 +33,15 @@
 
 @router.get(
     '/api/themes/national_risk',
-    response_model=List[NationalRiskResponse],
+    response_model=HapiGenericResponse[NationalRiskResponse],
     summary='Get national risk data',
     include_in_schema=False,
 )
-@router.get('/api/v1/themes/national_risk', response_model=List[NationalRiskResponse], summary='Get national risk data')
+@router.get(
+    '/api/v1/themes/national_risk',
+    response_model=HapiGenericResponse[NationalRiskResponse],
+    summary='Get national risk data',
+)
 async def get_national_risks(
     common_parameters: Annotated[CommonEndpointParams, Depends(common_endpoint_parameters)],
     db: AsyncSession = Depends(get_db),

hdx_hapi/endpoints/get_operational_presence.py

@@ -1,5 +1,5 @@
 from datetime import date
-from typing import List, Annotated
+from typing import Annotated
 from fastapi import Depends, Query, APIRouter
 from pydantic import NaiveDatetime
 
@@ -20,6 +20,7 @@
     DOC_HAPI_REPLACED_DATE_MAX,
 )
 
+from hdx_hapi.endpoints.models.base import HapiGenericResponse
 from hdx_hapi.endpoints.models.operational_presence import OperationalPresenceResponse
 from hdx_hapi.endpoints.util.util import AdminLevel, CommonEndpointParams, OutputFormat, common_endpoint_parameters
 from hdx_hapi.services.csv_transform_logic import transform_result_to_csv_stream_if_requested
@@ -38,24 +39,24 @@
 
 @router.get(
     '/api/themes/3w',
-    response_model=List[OperationalPresenceResponse],
+    response_model=HapiGenericResponse[OperationalPresenceResponse],
     summary=SUMMARY_TEXT,
     include_in_schema=False,
 )
 @router.get(
     '/api/themes/3W',
-    response_model=List[OperationalPresenceResponse],
+    response_model=HapiGenericResponse[OperationalPresenceResponse],
     summary=SUMMARY_TEXT,
     include_in_schema=False,
 )
 @router.get(
     '/api/v1/themes/3w',
-    response_model=List[OperationalPresenceResponse],
+    response_model=HapiGenericResponse[OperationalPresenceResponse],
     summary=SUMMARY_TEXT,
 )
 @router.get(
     '/api/v1/themes/3W',
-    response_model=List[OperationalPresenceResponse],
+    response_model=HapiGenericResponse[OperationalPresenceResponse],
     summary=SUMMARY_TEXT,
     include_in_schema=False,
 )