corrected the query parameter(compact-zone) of zone query to compact-zones

Author: tik65536

pydggsapi/schemas/ogc_dggs/dggrs_zones.py

@@ -77,7 +77,7 @@ class ZonesRequest(CommonBaseModel):
     )
     compact_zone: bool = Field(
         default=True,
-        alias="compact-zone",
+        alias="compact-zones",
         description=(
             "If set to true (default), when the list of DGGS zones to be returned at the requested resolution (zone-level) includes all children of a parent zone,"
             " the parent zone will be returned as a shorthand for that list of children zone.  If set to false, all zones returned will be of the requested zone level."

tests/test_cql/test_cql_zone-query_dggrs_zones.py

@@ -148,7 +148,7 @@ def test_cql_zone_query_dggrs_zones():
         print(f"Fail test case for cql syntax error (igeo, bbox: {non_exist_aoi.bounds}, compact=False)")
         bounds = list(map(str, non_exist_aoi.bounds))
         response = client.get('/dggs-api/dggs/igeo7/zones', params={"bbox": ",".join(bounds), "zone-level": 7,
-                                                                           "compact-zone": False,
+                                                                           "compact-zones": False,
                                                                            "filter": cql_error})
         assert response.status_code == 400
 
@@ -176,7 +176,7 @@ def test_cql_zone_query_dggrs_zones():
                         compact=False, cql: {cql_string})")
                 response = client.get(f'/dggs-api/dggs/{dggrsid}/zones', params={"bbox": ",".join(bounds),
                                                                                         "zone-level": rf,
-                                                                                        "compact-zone": False,
+                                                                                        "compact-zones": False,
                                                                                         "filter": cql_string})
                 print(validation_data)
                 if (validation_data.shape[0] > 0):
@@ -195,7 +195,7 @@ def test_cql_zone_query_dggrs_zones():
                         compact=False, cql: {cql_string})")
                 response = client.get(f'/dggs-api/dggs/{dggrsid}/zones', params={"bbox": ",".join(bounds),
                                                                                         "zone-level": rf,
-                                                                                        "compact-zone": False,
+                                                                                        "compact-zones": False,
                                                                                         "filter": cql_string})
                 if ("AND" in cql_string):
                     validation_data = dataset[(dataset[column_names[0]] >= test_values[0][0]) &

tests/test_dggal/test_dggal_provider_zone-query_dggrs_zones.py

@@ -97,7 +97,7 @@ def test_dggal_zone_query_dggrs_zones():
         aoi = shapely.box(*df_dict.pop('aoi'))
         print(f"Fail test case with dggs zones query ({dggrsid}, bbox: {non_exist_aoi.bounds}, compact=False), missing zone-level")
         bounds = list(map(str, non_exist_aoi.bounds))
-        response = client.get(f'/dggs-api/dggs/{dggrsid}/zones', params={"bbox": ",".join(bounds), 'compact-zone': False})
+        response = client.get(f'/dggs-api/dggs/{dggrsid}/zones', params={"bbox": ",".join(bounds), 'compact-zones': False})
         assert "zone-level must be specified" in response.text
         assert response.status_code == 400
 
@@ -114,13 +114,13 @@ def test_dggal_zone_query_dggrs_zones():
         print(f"Empty test case with dggs zones query ({dggrsid}, bbox: {non_exist_aoi.bounds}, zone_level=8, compact=False, geojson)")
         non_exist_bounds = list(map(str, non_exist_aoi.bounds))
         response = client.get(f'/dggs-api/dggs/{dggrsid}/zones', headers={'Accept': 'Application/geo+json'},
-                              params={"bbox": ",".join(non_exist_bounds), 'zone-level': 8, 'compact-zone': False})
+                              params={"bbox": ",".join(non_exist_bounds), 'zone-level': 8, 'compact-zones': False})
         assert response.status_code == 204
 
         for rf, validation_set in df_dict.items():
             bounds = list(map(str, aoi.bounds))
             print(f"Success test case with dggs zones query ({dggrsid}, bbox: {aoi.bounds}, zone_level={rf}, compact=False)")
-            response = client.get(f'/dggs-api/dggs/{dggrsid}/zones', params={"bbox": ",".join(bounds), 'zone-level': rf, 'compact-zone': False})
+            response = client.get(f'/dggs-api/dggs/{dggrsid}/zones', params={"bbox": ",".join(bounds), 'zone-level': rf, 'compact-zones': False})
             assert response.status_code == 200
             zones = ZonesResponse(**response.json())
             return_zones_list = zones.zones
@@ -133,12 +133,12 @@ def test_dggal_zone_query_dggrs_zones():
             zone = validation_set['hex'].iloc[iloc_pos[0]]
             print(f"Success test case with dggs zones query ({dggrsid}, parent zone: {zone['zone_id']}, zone_level={rf + 1}, compact=False, geojson)")
             response = client.get(f'/dggs-api/dggs/{dggrsid}/zones', headers={'Accept': 'Application/geo+json'},
-                                  params={"parent-zone": zone['zone_id'], 'zone-level': rf + 1, 'compact-zone': False})
+                                  params={"parent-zone": zone['zone_id'], 'zone-level': rf + 1, 'compact-zones': False})
             assert (response.status_code == 200 or response.status_code == 204)
 
             print(f"Success test case with dggs zones query ({dggrsid}, bbox: {aoi.bounds}, zone_level={rf}, compact=False, geojson)")
             response = client.get(f'/dggs-api/dggs/{dggrsid}/zones', headers={'Accept': 'Application/geo+json'},
-                                  params={"bbox": ",".join(bounds), 'zone-level': rf, 'compact-zone': False})
+                                  params={"bbox": ",".join(bounds), 'zone-level': rf, 'compact-zones': False})
             assert response.status_code == 200
             zones_geojson = ZonesGeoJson(**response.json())
             return_features_list = zones_geojson.features

tests/test_igeo7_with_authalic_conversion/test_h3_to_igeo7_zone-query_dggrs_zones.py

@@ -68,7 +68,7 @@ def test_h3_to_igeo7_zone_query_dggrs_zones():
             aoi = validation_set['aoi']
             bounds = list(map(str, aoi.bounds))
             print(f"Success test case with dggs zones query (h3, bbox: {aoi.bounds}, zone_level={rf}, compact=False)")
-            response = client.get('/dggs-api/dggs/h3/zones', params={"bbox": ",".join(bounds), 'zone-level': rf, 'compact-zone': False})
+            response = client.get('/dggs-api/dggs/h3/zones', params={"bbox": ",".join(bounds), 'zone-level': rf, 'compact-zoness': False})
             zones = ZonesResponse(**response.json())
             return_zones_list = zones.zones
             return_zones_list.sort()
@@ -79,7 +79,7 @@ def test_h3_to_igeo7_zone_query_dggrs_zones():
 
             print(f"Success test case with dggs zones query (h3, bbox: {aoi.bounds}, zone_level={rf}, compact=False, geojson)")
             response = client.get('/dggs-api/dggs/h3/zones', headers={'Accept': 'Application/geo+json'},
-                                  params={"bbox": ",".join(bounds), 'zone-level': rf, 'compact-zone': False})
+                                  params={"bbox": ",".join(bounds), 'zone-level': rf, 'compact-zones': False})
             zones_geojson = ZonesGeoJson(**response.json())
             return_features_list = zones_geojson.features
             geometry = [shapely.from_geojson(json.dumps(f.geometry.__dict__)) for f in return_features_list]

tests/test_igeo7_with_authalic_conversion/test_igeo7_zone-query_dggrs_zones.py

@@ -87,7 +87,7 @@ def test_zone_query_dggrs_zones():
 
     print(f"Fail test case with dggs zones query (igeo7, bbox: {non_exist_aoi.bounds}, compact=False), missing zone-level")
     bounds = list(map(str, non_exist_aoi.bounds))
-    response = client.get('/dggs-api/dggs/igeo7/zones', params={"bbox": ",".join(bounds), 'compact-zone': False})
+    response = client.get('/dggs-api/dggs/igeo7/zones', params={"bbox": ",".join(bounds), 'compact-zones': False})
     assert "zone-level must be specified" in response.text
     assert response.status_code == 400
 
@@ -104,20 +104,20 @@ def test_zone_query_dggrs_zones():
     print(f"Empty test case with dggs zones query (igeo7, bbox: {non_exist_aoi.bounds}, zone_level=8, compact=False, geojson)")
     non_exist_bounds = list(map(str, non_exist_aoi.bounds))
     response = client.get('/dggs-api/dggs/igeo7/zones', headers={'Accept': 'Application/geo+json'},
-                          params={"bbox": ",".join(non_exist_bounds), 'zone-level': 8, 'compact-zone': False})
+                          params={"bbox": ",".join(non_exist_bounds), 'zone-level': 8, 'compact-zones': False})
     assert response.status_code == 204
 
     print(f"Empty test case with dggs zones query (igeo7, parent zone: 055266135, zone_level=8, compact=False, geojson)")
     response = client.get('/dggs-api/dggs/igeo7/zones', headers={'Accept': 'Application/geo+json'},
-                          params={"parent-zone": '055266135', 'zone-level': 8, 'compact-zone': False})
+                          params={"parent-zone": '055266135', 'zone-level': 8, 'compact-zones': False})
     assert response.status_code == 204
 
     for collection_name, df_dict in validation_df.items():
         rf5_validation_set = df_dict.pop(5)
         aoi = rf5_validation_set['aoi']
         print(f"Success test case with dggs zones query (igeo7, bbox: {aoi.bounds}, zone-level=5,compact=False)")
         bounds = list(map(str, aoi.bounds))
-        response = client.get('/dggs-api/dggs/igeo7/zones', params={"bbox": ",".join(bounds), "zone-level": 5, "compact-zone": False})
+        response = client.get('/dggs-api/dggs/igeo7/zones', params={"bbox": ",".join(bounds), "zone-level": 5, "compact-zones": False})
         zones = ZonesResponse(**response.json())
         return_zones_list = zones.zones
         return_zones_list.sort()
@@ -131,7 +131,7 @@ def test_zone_query_dggrs_zones():
         zone = rf5_validation_set['hex'].iloc[iloc_pos[0]]
         print(f"Success test case with dggs zones query (igeo7, parent zone: {zone['name']}, zone_level=8, compact=False, geojson)")
         response = client.get('/dggs-api/dggs/igeo7/zones', headers={'Accept': 'Application/geo+json'},
-                              params={"parent-zone": zone['name'], 'zone-level': 8, 'compact-zone': False})
+                              params={"parent-zone": zone['name'], 'zone-level': 8, 'compact-zones': False})
         zones_geojson = ZonesGeoJson(**response.json())
         return_features_list = zones_geojson.features
         assert response.status_code == 200
@@ -140,7 +140,7 @@ def test_zone_query_dggrs_zones():
             aoi = validation_set['aoi']
             bounds = list(map(str, aoi.bounds))
             print(f"Success test case with dggs zones query (igeo7, bbox: {aoi.bounds}, zone_level={rf}, compact=False)")
-            response = client.get('/dggs-api/dggs/igeo7/zones', params={"bbox": ",".join(bounds), 'zone-level': rf, 'compact-zone': False})
+            response = client.get('/dggs-api/dggs/igeo7/zones', params={"bbox": ",".join(bounds), 'zone-level': rf, 'compact-zones': False})
             zones = ZonesResponse(**response.json())
             return_zones_list = zones.zones
             return_zones_list.sort()
@@ -152,7 +152,7 @@ def test_zone_query_dggrs_zones():
 
             print(f"Success test case with dggs zones query (igeo7, bbox: {aoi.bounds}, zone_level={rf}, compact=False, geojson)")
             response = client.get('/dggs-api/dggs/igeo7/zones', headers={'Accept': 'Application/geo+json'},
-                                  params={"bbox": ",".join(bounds), 'zone-level': rf, 'compact-zone': False})
+                                  params={"bbox": ",".join(bounds), 'zone-level': rf, 'compact-zones': False})
             zones_geojson = ZonesGeoJson(**response.json())
             return_features_list = zones_geojson.features
             geometry = [shapely.from_geojson(json.dumps(f.geometry.__dict__)) for f in return_features_list]

tests/test_temporal_collections/test_temporal_zone-query_dggrs_zones.py

@@ -133,7 +133,7 @@ def test_temporal_zone_query_dggrs_zones():
         print(f"Fail test case for datetime syntax error (igeo, bbox: {non_exist_aoi.bounds}, compact=False)")
         bounds = list(map(str, non_exist_aoi.bounds))
         response = client.get('/dggs-api/dggs/igeo7/zones', params={"bbox": ",".join(bounds), "zone-level": 7,
-                                                                           "compact-zone": False,
+                                                                           "compact-zones": False,
                                                                            "datetime": datetime_error})
         assert response.status_code == 400
 
@@ -152,7 +152,7 @@ def test_temporal_zone_query_dggrs_zones():
                 print(f"Success test case with dggs zones query ({dggrsid}, bbox: {aoi.bounds}, zone_level={rf}, \
                         compact=False, datetime: {datetime_string})")
                 response = client.get(f'/dggs-api/dggs/{dggrsid}/zones',
-                                      params={"bbox": ",".join(bounds), "zone-level": rf, "compact-zone": False,
+                                      params={"bbox": ",".join(bounds), "zone-level": rf, "compact-zones": False,
                                               "datetime": datetime_string})
                 if (is_temporal):
                     assert response.status_code == 200