From 899541caf87d6adc03b7024f251d572ed9e90926 Mon Sep 17 00:00:00 2001 From: mcarans Date: Tue, 11 Mar 2025 17:03:52 +1300 Subject: [PATCH] Update documentation for geo changes (removal of provider_adminN_name, admin references, addition of admin_level) --- .../admin1_parameters.yaml | 4 --- .../admin2_parameters.yaml | 8 ------ .../conflict_event_parameters.yaml | 28 +++++-------------- .../food_price_parameters.yaml | 28 +++++-------------- .../food_security_parameters.yaml | 24 +++++----------- .../funding_parameters.yaml | 3 -- .../humanitarian_needs_parameters.yaml | 28 +++++-------------- .../endpoint_parameters/idps_parameters.yaml | 28 +++++-------------- .../operational_presence_parameters.yaml | 28 +++++-------------- .../population_parameters.yaml | 28 +++++-------------- .../poverty_rate_parameters.yaml | 15 ++++------ .../wfp_market_parameters.yaml | 28 +++++-------------- docs/data_usage_guides/metadata.md | 2 +- hdx_hapi/config/doc_snippets.py | 16 +++++------ 14 files changed, 71 insertions(+), 197 deletions(-) diff --git a/docs/data_usage_guides/endpoint_parameters/admin1_parameters.yaml b/docs/data_usage_guides/endpoint_parameters/admin1_parameters.yaml index 63155dd6..45e2f7ad 100644 --- a/docs/data_usage_guides/endpoint_parameters/admin1_parameters.yaml +++ b/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)' diff --git a/docs/data_usage_guides/endpoint_parameters/admin2_parameters.yaml b/docs/data_usage_guides/endpoint_parameters/admin2_parameters.yaml index 207273e0..9630ec9c 100644 --- a/docs/data_usage_guides/endpoint_parameters/admin2_parameters.yaml +++ b/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)' diff --git a/docs/data_usage_guides/endpoint_parameters/conflict_event_parameters.yaml b/docs/data_usage_guides/endpoint_parameters/conflict_event_parameters.yaml index 75bb1ce3..df9ddab0 100644 --- a/docs/data_usage_guides/endpoint_parameters/conflict_event_parameters.yaml +++ b/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)' \ No newline at end of file + Admin level + Source: '[`Admin Level`](metadata.md#geometadata)' \ No newline at end of file diff --git a/docs/data_usage_guides/endpoint_parameters/food_price_parameters.yaml b/docs/data_usage_guides/endpoint_parameters/food_price_parameters.yaml index 47661243..3d93ed66 100644 --- a/docs/data_usage_guides/endpoint_parameters/food_price_parameters.yaml +++ b/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)' diff --git a/docs/data_usage_guides/endpoint_parameters/food_security_parameters.yaml b/docs/data_usage_guides/endpoint_parameters/food_security_parameters.yaml index 68cb423e..dbca9607 100644 --- a/docs/data_usage_guides/endpoint_parameters/food_security_parameters.yaml +++ b/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)' \ No newline at end of file diff --git a/docs/data_usage_guides/endpoint_parameters/funding_parameters.yaml b/docs/data_usage_guides/endpoint_parameters/funding_parameters.yaml index 6a18d48f..b8d8a601 100644 --- a/docs/data_usage_guides/endpoint_parameters/funding_parameters.yaml +++ b/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: diff --git a/docs/data_usage_guides/endpoint_parameters/humanitarian_needs_parameters.yaml b/docs/data_usage_guides/endpoint_parameters/humanitarian_needs_parameters.yaml index e8e73969..8fc84356 100644 --- a/docs/data_usage_guides/endpoint_parameters/humanitarian_needs_parameters.yaml +++ b/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)' \ No newline at end of file + Admin level + Source: '[`Admin Level`](metadata.md#geometadata)' \ No newline at end of file diff --git a/docs/data_usage_guides/endpoint_parameters/idps_parameters.yaml b/docs/data_usage_guides/endpoint_parameters/idps_parameters.yaml index 2f5606a7..21a14a99 100644 --- a/docs/data_usage_guides/endpoint_parameters/idps_parameters.yaml +++ b/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)' \ No newline at end of file diff --git a/docs/data_usage_guides/endpoint_parameters/operational_presence_parameters.yaml b/docs/data_usage_guides/endpoint_parameters/operational_presence_parameters.yaml index 3a9b84e0..0ee1192e 100644 --- a/docs/data_usage_guides/endpoint_parameters/operational_presence_parameters.yaml +++ b/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)' \ No newline at end of file diff --git a/docs/data_usage_guides/endpoint_parameters/population_parameters.yaml b/docs/data_usage_guides/endpoint_parameters/population_parameters.yaml index e63ade59..0196644e 100644 --- a/docs/data_usage_guides/endpoint_parameters/population_parameters.yaml +++ b/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)' \ No newline at end of file diff --git a/docs/data_usage_guides/endpoint_parameters/poverty_rate_parameters.yaml b/docs/data_usage_guides/endpoint_parameters/poverty_rate_parameters.yaml index 1eb41667..46a99ac7 100644 --- a/docs/data_usage_guides/endpoint_parameters/poverty_rate_parameters.yaml +++ b/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)' \ No newline at end of file diff --git a/docs/data_usage_guides/endpoint_parameters/wfp_market_parameters.yaml b/docs/data_usage_guides/endpoint_parameters/wfp_market_parameters.yaml index 7e122e1b..73b41234 100644 --- a/docs/data_usage_guides/endpoint_parameters/wfp_market_parameters.yaml +++ b/docs/data_usage_guides/endpoint_parameters/wfp_market_parameters.yaml @@ -19,33 +19,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)' \ No newline at end of file diff --git a/docs/data_usage_guides/metadata.md b/docs/data_usage_guides/metadata.md index 304195ec..a6491c1d 100644 --- a/docs/data_usage_guides/metadata.md +++ b/docs/data_usage_guides/metadata.md @@ -49,7 +49,7 @@ For available query parameters, please see the {{ read_yaml('data_usage_guides/endpoint_parameters/resource_parameters.yaml') }} -## Geographical Metadata +## Geographical Metadata HAPI supports three hierarchical levels of geographical metadata: location (a country or country-like entity), admin 1, and admin 2. An entry in diff --git a/hdx_hapi/config/doc_snippets.py b/hdx_hapi/config/doc_snippets.py index 2aef7520..e2e6e133 100644 --- a/hdx_hapi/config/doc_snippets.py +++ b/hdx_hapi/config/doc_snippets.py @@ -14,18 +14,18 @@ DOC_ADMIN1_ID = 'Filter the response by 1st subnational administrative division, using the unique identifier (id) from the admin1 table associated with each entry.' DOC_ADMIN1_REF = 'Filter the response by the 1st subnational administrative division reference number.' DOC_ADMIN1_CODE = 'Filter the response by the 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets.' -DOC_ADMIN1_NAME = 'Filter the response by the 1st subnational administrative divisions. The admin1 names refer to the Common Operational Datasets.' +DOC_ADMIN1_NAME = 'Filter the response by the 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source.' DOC_SEE_ADMIN1 = 'See the admin1 endpoint for details.' -DOC_PROVIDER_ADMIN1_NAME = ( - 'Filter the response by the 1st subnational administrative divisions provided in the original data source.' -) +#DOC_PROVIDER_ADMIN1_NAME = ( +# 'Filter the response by the 1st subnational administrative divisions provided in the original data source.' +#) 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 Common Operational Datasets.' -DOC_ADMIN2_NAME = 'Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to the Common Operational Datasets.' -DOC_PROVIDER_ADMIN2_NAME = ( - 'Filter the response by the 2nd subnational administrative divisions provided in the original data source.' -) +DOC_ADMIN2_NAME = 'Filter the response by the 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source.' +#DOC_PROVIDER_ADMIN2_NAME = ( +# 'Filter the response by the 2nd subnational administrative divisions provided in the original data source.' +#) DOC_SEE_ADMIN2 = 'See the admin2 endpoint for details.' DOC_ADMIN_LEVEL_FILTER = 'Filter the response by admin level.'