Merge pull request #315 from OCHA-DAP/geo_updates

HDXDSYS-1845 Update HAPI documentation for geo changes

docs/data_usage_guides/endpoint_parameters/admin1_parameters.yaml

@@ -28,7 +28,3 @@
     Location name, based on the "short name" from the
     [UN M49 Standard](https://unstats.un.org/unsd/methodology/m49/#fn2)
   Source: '[`Location`](metadata.md#location)'
-- Parameter: '`location_ref`'
-  Description: >
-    A reference to the `id` of the associated entry in the `location` table
-  Source: '[`Location`](metadata.md#location)'

docs/data_usage_guides/endpoint_parameters/admin2_parameters.yaml

@@ -28,17 +28,9 @@
     Location name, based on the "short name" from the
     [UN M49 Standard](https://unstats.un.org/unsd/methodology/m49/#fn2)
   Source: '[`Location`](metadata.md#location)'
-- Parameter: '`location_ref`'
-  Description: >
-    A reference to the `id` of the associated entry in the `location` table
-  Source: '[`Location`](metadata.md#location)'
 - Parameter: '`admin1_code`'
   Description: Admin 1 p-code
   Source: '[`Admin 1`](metadata.md#admin1)'
 - Parameter: '`admin1_name`'
   Description: Admin 1 name
   Source: '[`Admin 1`](metadata.md#admin1)'
-- Parameter: '`admin1_ref`'
-  Description: >
-    A reference to the `id` of the associated entry in the `admin 1` table
-  Source: '[`Admin 1`](metadata.md#admin1)'

docs/data_usage_guides/endpoint_parameters/conflict_event_parameters.yaml

@@ -29,33 +29,19 @@
     Location name, based on the "short name" from the
     [UN M49 Standard](https://unstats.un.org/unsd/methodology/m49/#fn2)
   Source: '[`Location`](metadata.md#location)'
-- Parameter: '`location_ref`'
-  Description: >
-    A reference to the `id` of the associated entry in the `location` table
-  Source: '[`Location`](metadata.md#location)'
 - Parameter: '`admin1_code`'
-  Description: Admin 1 p-code
+  Description: Admin 1 p-code from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?)
   Source: '[`Admin 1`](metadata.md#admin1)'
 - Parameter: '`admin1_name`'
-  Description: Admin 1 name
-  Source: '[`Admin 1`](metadata.md#admin1)'
-- Parameter: '`provider_admin1_name`'
-  Description: Admin 1 names provided in the original source data
-  Source: 
-- Parameter: '`admin1_ref`'
-  Description: >
-    A reference to the `id` of the associated entry in the `admin 1` table
+  Description: Admin 1 name from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?) or original data source
   Source: '[`Admin 1`](metadata.md#admin1)'
 - Parameter: '`admin2_code`'
-  Description: Admin 2 p-code
+  Description: Admin 2 p-code from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?)
   Source: '[`Admin 2`](metadata.md#admin2)'
 - Parameter: '`admin2_name`'
-  Description: Admin 2 name
+  Description: Admin 2 name from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?) or original data source
   Source: '[`Admin 2`](metadata.md#admin2)'
-- Parameter: '`provider_admin2_name`'
-  Description: Admin 2 names provided in the original source data
-  Source:
-- Parameter: '`admin2_ref`'
+- Parameter: '`admin_level`'
   Description: >
-    A reference to the `id` of the associated entry in the `admin 2` table
-  Source: '[`Admin 2`](metadata.md#admin2)'
+    Admin level
+  Source: '[`Admin Level`](metadata.md#geometadata)'

docs/data_usage_guides/endpoint_parameters/food_price_parameters.yaml

@@ -32,10 +32,6 @@
 - Parameter: '`reference_period_end`'
   Description: The end date for which the data are applicable
   Source:
-- Parameter: '`location_ref`'
-  Description: >
-    A reference to the `id` of the associated entry in the `location` table
-  Source: '[`Location`](metadata.md#location)'
 - Parameter: '`location_code`'
   Description: >
     Location p-code, based on the ISO-3 (ISO 3166 alpha-3) standard
@@ -46,31 +42,21 @@
     [UN M49 Standard](https://unstats.un.org/unsd/methodology/m49/#fn2)
   Source: '[`Location`](metadata.md#location)'
 - Parameter: '`admin1_code`'
-  Description: Admin 1 p-code
+  Description: Admin 1 p-code from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?)
   Source: '[`Admin 1`](metadata.md#admin1)'
 - Parameter: '`admin1_name`'
-  Description: Admin 1 name
-  Source: '[`Admin 1`](metadata.md#admin1)'
-- Parameter: '`provider_admin1_name`'
-  Description: Admin 1 names provided in the original source data
-  Source: 
-- Parameter: '`admin1_ref`'
-  Description: >
-    A reference to the `id` of the associated entry in the `admin 1` table
+  Description: Admin 1 name from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?) or original data source
   Source: '[`Admin 1`](metadata.md#admin1)'
 - Parameter: '`admin2_code`'
-  Description: Admin 2 p-code
+  Description: Admin 2 p-code from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?)
   Source: '[`Admin 2`](metadata.md#admin2)'
 - Parameter: '`admin2_name`'
-  Description: Admin 2 name
+  Description: Admin 2 name from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?) or original data source
   Source: '[`Admin 2`](metadata.md#admin2)'
-- Parameter: '`provider_admin2_name`'
-  Description: Admin 2 names provided in the original source data
-  Source:
-- Parameter: '`admin2_ref`'
+- Parameter: '`admin_level`'
   Description: >
-    A reference to the `id` of the associated entry in the `admin 2` table
-  Source: '[`Admin 2`](metadata.md#admin2)'
+    Admin level
+  Source: '[`Admin Level`](metadata.md#geometadata)'
 - Parameter: '`market_code`'
   Description: The unique code identifying the market
   Source: '[`WFP Market`](metadata.md#wfp-market)'

docs/data_usage_guides/endpoint_parameters/food_security_parameters.yaml

@@ -29,28 +29,18 @@
     [UN M49 Standard](https://unstats.un.org/unsd/methodology/m49/#fn2)
   Source: '[`Location`](metadata.md#location)'
 - Parameter: '`admin1_code`'
-  Description: Admin 1 p-code
+  Description: Admin 1 p-code from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?)
   Source: '[`Admin 1`](metadata.md#admin1)'
 - Parameter: '`admin1_name`'
-  Description: Admin 1 name
-  Source: '[`Admin 1`](metadata.md#admin1)'
-- Parameter: '`provider_admin1_name`'
-  Description: Admin 1 names provided in the original source data
-  Source: 
-- Parameter: '`admin1_ref`'
-  Description: >
-    A reference to the `id` of the associated entry in the `admin 1` table
+  Description: Admin 1 name from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?) or original data source
   Source: '[`Admin 1`](metadata.md#admin1)'
 - Parameter: '`admin2_code`'
-  Description: Admin 2 p-code
+  Description: Admin 2 p-code from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?)
   Source: '[`Admin 2`](metadata.md#admin2)'
 - Parameter: '`admin2_name`'
-  Description: Admin 2 name
+  Description: Admin 2 name from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?) or original data source
   Source: '[`Admin 2`](metadata.md#admin2)'
-- Parameter: '`provider_admin2_name`'
-  Description: Admin 2 names provided in the original source data
-  Source:
-- Parameter: '`admin2_ref`'
+- Parameter: '`admin_level`'
   Description: >
-    A reference to the `id` of the associated entry in the `admin 2` table
-  Source: '[`Admin 2`](metadata.md#admin2)'
+    Admin level
+  Source: '[`Admin Level`](metadata.md#geometadata)'

docs/data_usage_guides/endpoint_parameters/funding_parameters.yaml

@@ -19,9 +19,6 @@
 - Parameter: '`funding_pct`'
   Description: The percentage of required funding received by the appeal
   Source:
-  Description: >
-    A reference to the `id` of the associated entry in the `location` table
-  Source: '[`Location`](metadata.md#location)'
 - Parameter: '`reference_period_start`'
   Description: The start date for which the data are applicable
   Source:

docs/data_usage_guides/endpoint_parameters/humanitarian_needs_parameters.yaml

@@ -36,33 +36,19 @@
     Location name, based on the "short name" from the
     [UN M49 Standard](https://unstats.un.org/unsd/methodology/m49/#fn2)
   Source: '[`Location`](metadata.md#location)'
-- Parameter: '`location_ref`'
-  Description: >
-    A reference to the `id` of the associated entry in the `location` table
-  Source: '[`Location`](metadata.md#location)'
 - Parameter: '`admin1_code`'
-  Description: Admin 1 p-code
+  Description: Admin 1 p-code from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?)
   Source: '[`Admin 1`](metadata.md#admin1)'
 - Parameter: '`admin1_name`'
-  Description: Admin 1 name
-  Source: '[`Admin 1`](metadata.md#admin1)'
-- Parameter: '`provider_admin1_name`'
-  Description: Admin 1 names provided in the original source data
-  Source: 
-- Parameter: '`admin1_ref`'
-  Description: >
-    A reference to the `id` of the associated entry in the `admin 1` table
+  Description: Admin 1 name from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?) or original data source
   Source: '[`Admin 1`](metadata.md#admin1)'
 - Parameter: '`admin2_code`'
-  Description: Admin 2 p-code
+  Description: Admin 2 p-code from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?)
   Source: '[`Admin 2`](metadata.md#admin2)'
 - Parameter: '`admin2_name`'
-  Description: Admin 2 name
+  Description: Admin 2 name from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?) or original data source
   Source: '[`Admin 2`](metadata.md#admin2)'
-- Parameter: '`provider_admin2_name`'
-  Description: Admin 2 names provided in the original source data
-  Source:
-- Parameter: '`admin2_ref`'
+- Parameter: '`admin_level`'
   Description: >
-    A reference to the `id` of the associated entry in the `admin 2` table
-  Source: '[`Admin 2`](metadata.md#admin2)'
+    Admin level
+  Source: '[`Admin Level`](metadata.md#geometadata)'

docs/data_usage_guides/endpoint_parameters/idps_parameters.yaml

@@ -28,33 +28,19 @@
     Location name, based on the "short name" from the
     [UN M49 Standard](https://unstats.un.org/unsd/methodology/m49/#fn2)
   Source: '[`Location`](metadata.md#location)'
-- Parameter: '`location_ref`'
-  Description: >
-    A reference to the `id` of the associated entry in the `location` table
-  Source: '[`Location`](metadata.md#location)'
 - Parameter: '`admin1_code`'
-  Description: Admin 1 p-code
+  Description: Admin 1 p-code from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?)
   Source: '[`Admin 1`](metadata.md#admin1)'
 - Parameter: '`admin1_name`'
-  Description: Admin 1 name
-  Source: '[`Admin 1`](metadata.md#admin1)'
-- Parameter: '`provider_admin1_name`'
-  Description: Admin 1 names provided in the original source data
-  Source: 
-- Parameter: '`admin1_ref`'
-  Description: >
-    A reference to the `id` of the associated entry in the `admin 1` table
+  Description: Admin 1 name from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?) or original data source
   Source: '[`Admin 1`](metadata.md#admin1)'
 - Parameter: '`admin2_code`'
-  Description: Admin 2 p-code
+  Description: Admin 2 p-code from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?)
   Source: '[`Admin 2`](metadata.md#admin2)'
 - Parameter: '`admin2_name`'
-  Description: Admin 2 name
+  Description: Admin 2 name from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?) or original data source
   Source: '[`Admin 2`](metadata.md#admin2)'
-- Parameter: '`provider_admin2_name`'
-  Description: Admin 2 names provided in the original source data
-  Source:
-- Parameter: '`admin2_ref`'
+- Parameter: '`admin_level`'
   Description: >
-    A reference to the `id` of the associated entry in the `admin 2` table
-  Source: '[`Admin 2`](metadata.md#admin2)'
+    Admin level
+  Source: '[`Admin Level`](metadata.md#geometadata)'

docs/data_usage_guides/endpoint_parameters/operational_presence_parameters.yaml

@@ -40,33 +40,19 @@
     Location name, based on the "short name" from the
     [UN M49 Standard](https://unstats.un.org/unsd/methodology/m49/#fn2)
   Source: '[`Location`](metadata.md#location)'
-- Parameter: '`location_ref`'
-  Description: >
-    A reference to the `id` of the associated entry in the `location` table
-  Source: '[`Location`](metadata.md#location)'
 - Parameter: '`admin1_code`'
-  Description: Admin 1 p-code
+  Description: Admin 1 p-code from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?)
   Source: '[`Admin 1`](metadata.md#admin1)'
 - Parameter: '`admin1_name`'
-  Description: Admin 1 name
-  Source: '[`Admin 1`](metadata.md#admin1)'
-- Parameter: '`provider_admin1_name`'
-  Description: Admin 1 names provided in the original source data
-  Source: 
-- Parameter: '`admin1_ref`'
-  Description: >
-    A reference to the `id` of the associated entry in the `admin 1` table
+  Description: Admin 1 name from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?) or original data source
   Source: '[`Admin 1`](metadata.md#admin1)'
 - Parameter: '`admin2_code`'
-  Description: Admin 2 p-code
+  Description: Admin 2 p-code from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?)
   Source: '[`Admin 2`](metadata.md#admin2)'
 - Parameter: '`admin2_name`'
-  Description: Admin 2 name
+  Description: Admin 2 name from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?) or original data source
   Source: '[`Admin 2`](metadata.md#admin2)'
-- Parameter: '`provider_admin2_name`'
-  Description: Admin 2 names provided in the original source data
-  Source:
-- Parameter: '`admin2_ref`'
+- Parameter: '`admin_level`'
   Description: >
-    A reference to the `id` of the associated entry in the `admin 2` table
-  Source: '[`Admin 2`](metadata.md#admin2)'
+    Admin level
+  Source: '[`Admin Level`](metadata.md#geometadata)'

docs/data_usage_guides/endpoint_parameters/population_parameters.yaml

@@ -40,33 +40,19 @@
     Location name, based on the "short name" from the
     [UN M49 Standard](https://unstats.un.org/unsd/methodology/m49/#fn2)
   Source: '[`Location`](metadata.md#location)'
-- Parameter: '`location_ref`'
-  Description: >
-    A reference to the `id` of the associated entry in the `location` table
-  Source: '[`Location`](metadata.md#location)'
 - Parameter: '`admin1_code`'
-  Description: Admin 1 p-code
+  Description: Admin 1 p-code from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?)
   Source: '[`Admin 1`](metadata.md#admin1)'
 - Parameter: '`admin1_name`'
-  Description: Admin 1 name
-  Source: '[`Admin 1`](metadata.md#admin1)'
-- Parameter: '`provider_admin1_name`'
-  Description: Admin 1 names provided in the original source data
-  Source: 
-- Parameter: '`admin1_ref`'
-  Description: >
-    A reference to the `id` of the associated entry in the `admin 1` table
+  Description: Admin 1 name from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?) or original data source
   Source: '[`Admin 1`](metadata.md#admin1)'
 - Parameter: '`admin2_code`'
-  Description: Admin 2 p-code
+  Description: Admin 2 p-code from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?)
   Source: '[`Admin 2`](metadata.md#admin2)'
 - Parameter: '`admin2_name`'
-  Description: Admin 2 name
+  Description: Admin 2 name from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?) or original data source
   Source: '[`Admin 2`](metadata.md#admin2)'
-- Parameter: '`provider_admin2_name`'
-  Description: Admin 2 names provided in the original source data
-  Source:
-- Parameter: '`admin2_ref`'
+- Parameter: '`admin_level`'
   Description: >
-    A reference to the `id` of the associated entry in the `admin 2` table
-  Source: '[`Admin 2`](metadata.md#admin2)'
+    Admin level
+  Source: '[`Admin Level`](metadata.md#geometadata)'

docs/data_usage_guides/endpoint_parameters/poverty_rate_parameters.yaml

@@ -36,16 +36,13 @@
     Location name, based on the "short name" from the
     [UN M49 Standard](https://unstats.un.org/unsd/methodology/m49/#fn2)
   Source: '[`Location`](metadata.md#location)'
-- Parameter: '`location_ref`'
-  Description: >
-    A reference to the `id` of the associated entry in the `location` table
-  Source: '[`Location`](metadata.md#location)'
 - Parameter: '`admin1_code`'
-  Description: Admin 1 p-code
+  Description: Admin 1 p-code from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?)
   Source: '[`Admin 1`](metadata.md#admin1)'
 - Parameter: '`admin1_name`'
-  Description: Admin 1 name
+  Description: Admin 1 name from [Common Operational Datasets](https://data.humdata.org/dashboards/cod?) or original data source
   Source: '[`Admin 1`](metadata.md#admin1)'
-- Parameter: '`provider_admin1_name`'
-  Description: Admin 1 names provided in the original source data
-  Source: 
+- Parameter: '`admin_level`'
+  Description: >
+    Admin level
+  Source: '[`Admin Level`](metadata.md#geometadata)'