OCHA-DAP · alexandru-m-g · Oct 16, 2024 · Sep 28, 2024 · Sep 30, 2024 · Sep 30, 2024
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -21,4 +21,6 @@
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true,
     "python.analysis.typeCheckingMode": "standard",
+    "python.analysis.diagnosticMode": "workspace",
+    "python.analysis.exclude": ["src/"],
 }
diff --git a/docs/data_usage_guides/coordination_and_context.md b/docs/data_usage_guides/coordination_and_context.md
@@ -19,7 +19,7 @@ efforts, identify gaps, and plan for future humanitarian response.
 
 The table below describes the parameters returned from this endpoint.
 For available query parameters, please see the
-[API sandbox](https://hapi.humdata.org/docs#/Coordination%20%26%20Context/get_operational_presences_api_v1_coordination_context_operational_presence_get).
+[API sandbox](https://hapi.humdata.org/docs#/Coordination%20%26%20Context/get_operational_presence_api_v1_coordination_context_operational_presence_get).
 
 {{ read_yaml('data_usage_guides/endpoint_parameters/operational_presence_parameters.yaml') }}
 

diff --git a/docs/data_usage_guides/food_security_and_nutrition.md b/docs/data_usage_guides/food_security_and_nutrition.md
@@ -74,7 +74,7 @@ detailed methodology, see WFP's
 
 The table below describes the parameters returned from this endpoint.
 For available query parameters, please see the
-[API sandbox](https://hapi.humdata.org/docs#/Food%20Security%20%26%20Nutrition/get_food_prices_api_v1_food_food_price_get).
+[API sandbox](https://hapi.humdata.org/docs#/Food%20Security%20%26%20Nutrition/get_food_price_api_v1_food_food_price_get).
 
 {{ read_yaml('data_usage_guides/endpoint_parameters/food_price_parameters.yaml') }}
 

diff --git a/docs/data_usage_guides/metadata.md b/docs/data_usage_guides/metadata.md
@@ -29,7 +29,7 @@ one child [resource](metadata.md#resource).
 
 The table below describes the parameters returned from this endpoint.
 For available query parameters, please see the
-[API sandbox](https://hapi.humdata.org/docs#/Metadata/get_datasets_api_v1_metadata_dataset_get).
+[API sandbox](https://hapi.humdata.org/docs#/Metadata/get_dataset_api_v1_metadata_dataset_get).
 
 {{ read_yaml('data_usage_guides/endpoint_parameters/dataset_parameters.yaml') }}
 
@@ -92,7 +92,7 @@ Country or country-like entities in HDX HAPI, from the CODs
 
 The table below describes the parameters returned from this endpoint.
 For available query parameters, please see the
-[API sandbox](https://hapi.humdata.org/docs#/Metadata/get_locations_api_v1_metadata_location_get).
+[API sandbox](https://hapi.humdata.org/docs#/Metadata/get_location_api_v1_metadata_location_get).
 
 {{ read_yaml('data_usage_guides/endpoint_parameters/location_parameters.yaml') }}
 
@@ -135,7 +135,7 @@ The currency table is populated using the WFP VAM Data Bridges API.
 
 The table below describes the parameters returned from this endpoint.
 For available query parameters, please see the
-[API sandbox](https://hapi.humdata.org/docs#/Metadata/get_currencies_api_v1_metadata_currency_get).
+[API sandbox](https://hapi.humdata.org/docs#/Metadata/get_currency_api_v1_metadata_currency_get).
 
 {{ read_yaml('data_usage_guides/endpoint_parameters/currency_parameters.yaml') }}
 
@@ -161,7 +161,7 @@ methodology:
 
 The table below describes the parameters returned from this endpoint.
 For available query parameters, please see the
-[API sandbox](https://hapi.humdata.org/docs#/Metadata/get_orgs_api_v1_metadata_org_get).
+[API sandbox](https://hapi.humdata.org/docs#/Metadata/get_org_api_v1_metadata_org_get).
 
 {{ read_yaml('data_usage_guides/endpoint_parameters/org_parameters.yaml') }}
 
@@ -188,7 +188,7 @@ Organization types all have an associated description and code.
 
 The table below describes the parameters returned from this endpoint.
 For available query parameters, please see the
-[API sandbox](https://hapi.humdata.org/docs#/Metadata/get_org_types_api_v1_metadata_org_type_get).
+[API sandbox](https://hapi.humdata.org/docs#/Metadata/get_org_type_api_v1_metadata_org_type_get).
 
 {{ read_yaml('data_usage_guides/endpoint_parameters/org_type_parameters.yaml') }}
 
@@ -215,7 +215,7 @@ Sectors all have an associated name and code.
 
 The table below describes the parameters returned from this endpoint.
 For available query parameters, please see the
-[API sandbox](https://hapi.humdata.org/docs#/Metadata/get_sectors_api_v1_metadata_sector_get).
+[API sandbox](https://hapi.humdata.org/docs#/Metadata/get_sector_api_v1_metadata_sector_get).
 
 {{ read_yaml('data_usage_guides/endpoint_parameters/sector_parameters.yaml') }}
 
@@ -254,7 +254,7 @@ manual overrides.
 
 The table below describes the parameters returned from this endpoint.
 For available query parameters, please see the
-[API sandbox](https://hapi.humdata.org/docs#/Metadata/get_wfp_markets_api_v1_metadata_wfp_market_get).
+[API sandbox](https://hapi.humdata.org/docs#/Metadata/get_wfp_market_api_v1_metadata_wfp_market_get).
 
 {{ read_yaml('data_usage_guides/endpoint_parameters/wfp_market_parameters.yaml') }}
 

diff --git a/docs/data_usage_guides/population_and_socio-economy.md b/docs/data_usage_guides/population_and_socio-economy.md
@@ -20,7 +20,7 @@ sources.
 
 The table below describes the parameters returned from this endpoint.
 For available query parameters, please see the
-[API sandbox](https://hapi.humdata.org/docs#/Population%20%26%20Socio-Economy/get_populations_api_v1_population_social_population_get).
+[API sandbox](https://hapi.humdata.org/docs#/Population%20%26%20Socio-Economy/get_population_api_v1_population_social_population_get).
 
 {{ read_yaml('data_usage_guides/endpoint_parameters/population_parameters.yaml') }}
 
@@ -59,7 +59,7 @@ details.
 
 The table below describes the parameters returned from this endpoint.
 For available query parameters, please see the
-[API sandbox](https://hapi.humdata.org/docs#/Population%20%26%20Socio-Economy/get_poverty_rates_api_v1_population_social_poverty_rate_get).
+[API sandbox](https://hapi.humdata.org/docs#/Population%20%26%20Socio-Economy/get_poverty_rate_api_v1_population_social_poverty_rate_get).
 
 {{ read_yaml('data_usage_guides/endpoint_parameters/poverty_rate_parameters.yaml') }}
 

diff --git a/docs/index.md b/docs/index.md
@@ -30,20 +30,20 @@ HDX HAPI is organised around a set of key humanitarian data subcategories like *
 
 #### Coordination & Context
 
-- [Who is Doing What Where - Operational Presence](https://hapi.humdata.org/docs#/Coordination%20%26%20Context/get_operational_presences_api_v1_coordination_context_operational_presence_get)
-- [Funding](https://hapi.humdata.org/docs#/Coordination%20%26%20Context/get_fundings_api_v1_coordination_context_funding_get)
-- [Conflict Events](https://hapi.humdata.org/docs#/Coordination%20%26%20Context/get_conflict_events_api_v1_coordination_context_conflict_event_get)
-- [National Risk](https://hapi.humdata.org/docs#/Coordination%20%26%20Context/get_national_risks_api_v1_coordination_context_national_risk_get)
+- [Who is Doing What Where - Operational Presence](https://hapi.humdata.org/docs#/Coordination%20%26%20Context/get_operational_presence_api_v1_coordination_context_operational_presence_get)
+- [Funding](https://hapi.humdata.org/docs#/Coordination%20%26%20Context/get_funding_api_v1_coordination_context_funding_get)
+- [Conflict Events](https://hapi.humdata.org/docs#/Coordination%20%26%20Context/get_conflict_event_api_v1_coordination_context_conflict_event_get)
+- [National Risk](https://hapi.humdata.org/docs#/Coordination%20%26%20Context/get_national_risk_api_v1_coordination_context_national_risk_get)
 
 #### Food Security & Nutrition
 
 - [Food Security](https://hapi.humdata.org/docs#/Food%20Security%20%26%20Nutrition/get_food_security_api_v1_food_food_security_get)
-- [Food Prices](https://hapi.humdata.org/docs#/Food%20Security%20%26%20Nutrition/get_food_prices_api_v1_food_food_price_get)
+- [Food Prices](https://hapi.humdata.org/docs#/Food%20Security%20%26%20Nutrition/get_food_price_api_v1_food_food_price_get)
 
 #### Population & Socio-economy
 
-- [Baseline Population](https://hapi.humdata.org/docs#/Population%20%26%20Socio-Economy/get_populations_api_v1_population_social_population_get)
-- [Poverty Rate](https://hapi.humdata.org/docs#/Population%20%26%20Socio-Economy/get_poverty_rates_api_v1_population_social_poverty_rate_get)
+- [Baseline Population](https://hapi.humdata.org/docs#/Population%20%26%20Socio-Economy/get_population_api_v1_population_social_population_get)
+- [Poverty Rate](https://hapi.humdata.org/docs#/Population%20%26%20Socio-Economy/get_poverty_rate_api_v1_population_social_poverty_rate_get)
 
 # Terms Of Use
 

diff --git a/hdx_hapi/config/doc_snippets.py b/hdx_hapi/config/doc_snippets.py
@@ -16,12 +16,16 @@
 DOC_ADMIN1_CODE = 'Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>.'
 DOC_ADMIN1_NAME = 'Filter the response by the 1st subnational administrative divisions. The admin1 names refer to the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>.'
 DOC_SEE_ADMIN1 = 'See the <a href="/docs#/Metadata/get_admin1_api_v1_metadata_admin1_get" target="_blank">admin1 endpoint</a> for details.'
-DOC_PROVIDER_ADMIN1_NAME = 'Filter the response by the 1st subnational administrative divisions provided by the supplier. The admin1 names refer to the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>.'
+DOC_PROVIDER_ADMIN1_NAME = (
+    'Filter the response by the 1st subnational administrative divisions provided by the supplier.'
+)
 DOC_ADMIN2_ID = 'Filter the response by 2nd subnational administrative division, using the unique identifier (id) from the admin2 table associated with each entry.'
 DOC_ADMIN2_REF = 'Filter the response by the 2nd subnational administrative division reference number.'
 DOC_ADMIN2_CODE = 'Filter the response by the 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>.'
 DOC_ADMIN2_NAME = 'Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>.'
-DOC_PROVIDER_ADMIN2_NAME = 'Filter the response by the 1st subnational administrative divisions provided by the supplier. The admin2 names refer to the <a href="https://data.humdata.org/dashboards/cod?">Common Operational Datasets</a>.'
+DOC_PROVIDER_ADMIN2_NAME = (
+    'Filter the response by the 2nd subnational administrative divisions provided by the supplier.'
+)
 DOC_SEE_ADMIN2 = 'See the <a href="/docs#/Metadata/get_admin2_api_v1_metadata_admin2_get" target="_blank">admin2 endpoint</a> for details.'
 DOC_ADMIN_LEVEL_FILTER = 'Filter the response by admin level.'
 
@@ -39,7 +43,7 @@
 DOC_HDX_DATASET_IN_RESOURCE_ID = 'Filter the response by the dataset ID (dataset_hdx_id), which is a unique and fixed identifier of a dataset on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]` will load the dataset page on HDX.'
 DOC_HDX_DATASET_IN_RESOURCE_NAME = 'Filter the response by the URL-safe name (dataset_hdx_stub) of the dataset as displayed on HDX. This name is unique but can change. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_stub]` will load the dataset page on HDX.'
 DOC_HDX_PROVIDER_IN_RESOURCE_STUB = "Filter the response by the URL-safe name of the provider (organization) of the dataset on HDX. A URL in the pattern of `https://data.humdata.org/organization/[dataset_hdx_provider_stub]` will load the provider's page on HDX."
-DOC_SEE_DATASET = 'See the <a href="/docs#/Metadata/get_datasets_api_v1_metadata_dataset_get" target="_blank">dataset endpoint</a> for details.'
+DOC_SEE_DATASET = 'See the <a href="/docs#/Metadata/get_dataset_api_v1_metadata_dataset_get" target="_blank">dataset endpoint</a> for details.'
 
 # Time periods
 DOC_UPDATE_DATE_MIN = 'Minimum date that datasets was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00'
@@ -72,7 +76,7 @@
 DOC_ORG_TYPE_DESCRIPTION = 'Filter the response by the organization type description.'
 DOC_SECTOR_CODE = 'Filter the response by the sector code.'
 DOC_SECTOR_NAME = 'Filter the response by the sector name.'
-DOC_SEE_ORG_TYPE = 'See the <a href="/docs#/Metadata/get_org_types_api_v1_metadata_org_type_get" target="_blank">org type endpoint</a> for details.'
+DOC_SEE_ORG_TYPE = 'See the <a href="/docs#/Metadata/get_org_type_api_v1_metadata_org_type_get" target="_blank">org type endpoint</a> for details.'
 
 
 DOC_AGE_RANGE = 'Filter the response by the age range. These are expressed as [start age]-[end age], or [start age]+ for an age range starting at [start age] or above. The end age is assumed to be inclusive, though that is not always explicit in the source data.'

diff --git a/hdx_hapi/db/dao/admin1_view_dao.py b/hdx_hapi/db/dao/admin1_view_dao.py
@@ -15,7 +15,7 @@
 
 async def admin1_view_list(
     pagination_parameters: PaginationParams,
-    ref_period_parameters: ReferencePeriodParameters,
+    ref_period_parameters: Optional[ReferencePeriodParameters],
     db: AsyncSession,
     id: Optional[int] = None,
     location_ref: Optional[int] = None,

diff --git a/hdx_hapi/db/dao/admin2_view_dao.py b/hdx_hapi/db/dao/admin2_view_dao.py
@@ -13,7 +13,7 @@
 
 async def admin2_view_list(
     pagination_parameters: PaginationParams,
-    ref_period_parameters: ReferencePeriodParameters,
+    ref_period_parameters: Optional[ReferencePeriodParameters],
     db: AsyncSession,
     id: Optional[int] = None,
     admin1_ref: Optional[int] = None,

diff --git a/hdx_hapi/db/dao/availability_view_dao.py b/hdx_hapi/db/dao/availability_view_dao.py
@@ -22,8 +22,8 @@ async def availability_view_list(
     admin1_code: Optional[str] = None,
     admin2_name: Optional[str] = None,
     admin2_code: Optional[str] = None,
-    hapi_updated_date_min: Optional[datetime.datetime] = None,
-    hapi_updated_date_max: Optional[datetime.datetime] = None,
+    hapi_updated_date_min: Optional[datetime.datetime | datetime.date] = None,
+    hapi_updated_date_max: Optional[datetime.datetime | datetime.date] = None,
 ):
     logger.info(f'availability_view_list called with params: {locals()}')
 

diff --git a/hdx_hapi/db/dao/conflict_event_view_dao.py b/hdx_hapi/db/dao/conflict_event_view_dao.py
@@ -19,7 +19,7 @@
 
 async def conflict_event_view_list(
     pagination_parameters: PaginationParams,
-    ref_period_parameters: ReferencePeriodParameters,
+    ref_period_parameters: Optional[ReferencePeriodParameters],
     db: AsyncSession,
     event_type: Optional[EventType] = None,
     location_ref: Optional[int] = None,
@@ -30,10 +30,12 @@ async def conflict_event_view_list(
     admin1_ref: Optional[int] = None,
     admin1_code: Optional[str] = None,
     admin1_name: Optional[str] = None,
+    provider_admin1_name: Optional[str] = None,
     admin1_is_unspecified: Optional[bool] = None,
     admin2_ref: Optional[int] = None,
     admin2_code: Optional[str] = None,
     admin2_name: Optional[str] = None,
+    provider_admin2_name: Optional[str] = None,
     admin2_is_unspecified: Optional[bool] = None,
 ) -> Sequence[ConflictEventView]:
     query = select(ConflictEventView)
@@ -51,10 +53,12 @@ async def conflict_event_view_list(
         admin1_ref,
         admin1_code,
         admin1_name,
+        provider_admin1_name,
         admin1_is_unspecified,
         admin2_ref,
         admin2_code,
         admin2_name,
+        provider_admin2_name,
         admin2_is_unspecified,
     )
 

diff --git a/hdx_hapi/db/dao/food_price_dao.py b/hdx_hapi/db/dao/food_price_dao.py
@@ -39,11 +39,13 @@ async def food_price_view_list(
     admin1_ref: Optional[int] = None,
     admin1_code: Optional[str] = None,
     admin1_name: Optional[str] = None,
+    provider_admin1_name: Optional[str] = None,
     admin1_is_unspecified: Optional[bool] = None,
     location_ref: Optional[int] = None,
     admin2_ref: Optional[int] = None,
     admin2_code: Optional[str] = None,
     admin2_name: Optional[str] = None,
+    provider_admin2_name: Optional[str] = None,
     admin2_is_unspecified: Optional[bool] = None,
 ) -> Sequence[FoodPriceView]:
     query = select(FoodPriceView)
@@ -77,10 +79,12 @@ async def food_price_view_list(
         admin1_ref,
         admin1_code,
         admin1_name,
+        provider_admin1_name,
         admin1_is_unspecified,
         admin2_ref,
         admin2_code,
         admin2_name,
+        provider_admin2_name,
         admin2_is_unspecified,
     )
 

diff --git a/hdx_hapi/db/dao/food_security_view_dao.py b/hdx_hapi/db/dao/food_security_view_dao.py
@@ -16,7 +16,7 @@
 
 async def food_security_view_list(
     pagination_parameters: PaginationParams,
-    ref_period_parameters: ReferencePeriodParameters,
+    ref_period_parameters: Optional[ReferencePeriodParameters],
     db: AsyncSession,
     ipc_phase: Optional[IPCPhase] = None,
     ipc_type: Optional[IPCType] = None,
@@ -26,10 +26,12 @@ async def food_security_view_list(
     in_gho: Optional[bool] = None,
     admin1_name: Optional[str] = None,
     admin1_code: Optional[str] = None,
+    provider_admin1_name: Optional[str] = None,
     admin1_is_unspecified: Optional[bool] = None,
     location_ref: Optional[int] = None,
     admin2_code: Optional[str] = None,
     admin2_name: Optional[str] = None,
+    provider_admin2_name: Optional[str] = None,
     admin2_is_unspecified: Optional[bool] = None,
     admin1_ref: Optional[int] = None,
     admin2_ref: Optional[int] = None,
@@ -52,10 +54,12 @@ async def food_security_view_list(
         admin1_ref,
         admin1_code,
         admin1_name,
+        provider_admin1_name,
         admin1_is_unspecified,
         admin2_ref,
         admin2_code,
         admin2_name,
+        provider_admin2_name,
         admin2_is_unspecified,
     )
 

diff --git a/hdx_hapi/db/dao/funding_view_dao.py b/hdx_hapi/db/dao/funding_view_dao.py
@@ -14,26 +14,17 @@
 
 async def funding_view_list(
     pagination_parameters: PaginationParams,
-    ref_period_parameters: ReferencePeriodParameters,
+    ref_period_parameters: Optional[ReferencePeriodParameters],
     db: AsyncSession,
     appeal_code: Optional[str] = None,
     appeal_type: Optional[str] = None,
-    org_acronym: Optional[str] = None,
-    org_name: Optional[str] = None,
-    sector_name: Optional[str] = None,
     # location_ref: Optional[int] = None,
     location_code: Optional[str] = None,
     location_name: Optional[str] = None,
     has_hrp: Optional[bool] = None,
     in_gho: Optional[bool] = None,
 ) -> Sequence[FundingView]:
     query = select(FundingView)
-    if org_acronym:
-        query = case_insensitive_filter(query, FundingView.org_acronym, org_acronym)
-    if org_name:
-        query = query.where(FundingView.org_name.icontains(org_name))
-    if sector_name:
-        query = query.where(FundingView.sector_name.icontains(sector_name))
     # if location_ref:
     #     query = query.where(FundingView.location_ref == location_ref)
     if location_code:

diff --git a/hdx_hapi/db/dao/humanitarian_needs_view_dao.py b/hdx_hapi/db/dao/humanitarian_needs_view_dao.py
@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Optional, Sequence
 
 from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy import select
@@ -15,7 +15,7 @@
 
 async def humanitarian_needs_view_list(
     pagination_parameters: PaginationParams,
-    ref_period_parameters: ReferencePeriodParameters,
+    ref_period_parameters: Optional[ReferencePeriodParameters],
     db: AsyncSession,
     admin2_ref: Optional[int] = None,
     gender: Optional[Gender] = None,
@@ -35,11 +35,13 @@ async def humanitarian_needs_view_list(
     admin1_code: Optional[str] = None,
     admin2_code: Optional[str] = None,
     admin2_name: Optional[str] = None,
+    provider_admin2_name: Optional[str] = None,
     admin1_ref: Optional[int] = None,
     admin1_name: Optional[str] = None,
+    provider_admin1_name: Optional[str] = None,
     admin1_is_unspecified: Optional[bool] = None,
     admin2_is_unspecified: Optional[bool] = None,
-):
+) -> Sequence[HumanitarianNeedsView]:
     query = select(HumanitarianNeedsView)
 
     if gender:
@@ -73,10 +75,12 @@ async def humanitarian_needs_view_list(
         admin1_ref,
         admin1_code,
         admin1_name,
+        provider_admin1_name,
         admin1_is_unspecified,
         admin2_ref,
         admin2_code,
         admin2_name,
+        provider_admin2_name,
         admin2_is_unspecified,
     )