minor code tweak and doc refresh

Author: wiki0831

design-docs/CLI-Data.md

@@ -642,32 +642,28 @@ A JSON description of the clear coverage for the provided AOI within the scene.
 User Story: As a CLI user I want to get clear coverage information for a specific area within an item.
 
 ```console
-$ planet data item-coverage PSScene 20221003_002705_38_2461 \
-  --geom '{"type": "Polygon", "coordinates": [[[37.791595458984375, 14.84923123791421],
-  [37.90214538574219, 14.84923123791421],
-  [37.90214538574219, 14.945448293647944],
-  [37.791595458984375, 14.945448293647944],
-  [37.791595458984375, 14.84923123791421]]]}'
+$ planet data item-coverage PSScene 20250304_162555_90_24f2 \
+  --geom '{"type":"Polygon","coordinates":[[[-81.45,30.31],[-81.45,30.23],[-81.38,30.23],[-81.45,30.31]]]}'
 ```
 response (pretty-printed)
 ```
 {
-  "clear_percent": 90.0,
+  "clear_percent": 95,
   "status": "complete"
 }
 ```
 
 User Story: As a CLI user I want to get haze coverage over my Feature Ref.
 
 ```console
-$ planet data item-coverage PSScene 20221003_002705_38_2461 \
+$ planet data item-coverage PSScene 20250304_162555_90_24f2 \
   --geom 'pl:features/my/[collection-id]/[feature-id]' \
   --band haze
 ```
 response (pretty-printed)
 ```
 {
-  "haze_percent": 90.0,
+  "haze_percent": 0.0,
   "status": "complete"
 }
 ```
@@ -705,8 +701,7 @@ response (pretty-printed)
   },
   "_permissions": ["download"],
   "md5_digest": null,
-  "status": "active",
-  "location": "https://api.planet.com/data/v1/1?token=IAmAToken",
+  "status": "inactive",
   "type": "basic_udm2"
 }
 ```
@@ -788,7 +783,7 @@ None.
 User Story: As a CLI user I would like to activate an asset for download.
 
 ```
-$ planet data asset-activate PSScene 20210819_162141_68_2276 analytic
+$ planet data asset-activate PSScene 20210819_162141_68_2276 basic_analytic_4b
 ```
 
 User Story: As a CLI user I would like to activate, wait, and then download an
@@ -797,7 +792,7 @@ asset.
 ```
 $ ITEM_TYPE=PSScene && \
 ITEM_ID=20210819_162141_68_2276 && \
-ASSET_TYPE=analytic && \
+ASSET_TYPE=basic_analytic_4b && \
 planet data asset-activate $ITEM_TYPE $ITEM_ID $ASSET_TYPE && \
 planet data asset-wait $ITEM_TYPE $ITEM_ID $ASSET_TYPE && \
 planet data asset-download --directory data \
@@ -859,7 +854,7 @@ directory, overwriting if the file already exists, and silencing reporting.
 $ planet --quiet data asset-download \
 --directory data \
 --overwrite \
-PSScene 20210819_162141_68_2276 analytic
+PSScene 20210819_162141_68_2276 basic_analytic_4b
 data/<psscene_naming 20210819_162141_68_2276>.tif
 ```
 

docs/cli/cli-data.md

@@ -445,10 +445,13 @@ planet data item-coverage PSScene 20230310_083933_71_2431 --geom geometry.geojso
 ```
 
 You can also specify additional parameters:
-- `--mode`: The mode for coverage calculation
-- `--band`: The band to use for coverage calculation
+
+* `--mode`: The mode for coverage calculation
+
+* `--band`: The band to use for coverage calculation
 
 For example:
+
 ```sh
 planet data item-coverage PSScene 20230310_083933_71_2431 --geom geometry.geojson --band "haze"
 ```

planet/cli/data.py

@@ -687,9 +687,20 @@ async def item_get(ctx, item_type, item_id):
 @click.option("--geom",
               type=types.Geometry(),
               callback=check_geom,
-              required=True)
-@click.option('--mode', type=str, required=False)
-@click.option('--band', type=str, required=False)
+              required=True,
+              help="""Either a GeoJSON or a Features API reference""")
+@click.option('--mode',
+              type=str,
+              required=False,
+              help="""Method used for coverage calculation.
+    'UDM2': activates UDM2 asset for accurate coverage, may take time.
+    'estimate': provides a quick rough estimate without activation""")
+@click.option('--band',
+              type=str,
+              required=False,
+              help="""Specific band to extract from UDM2
+              (e.g., 'clear', 'cloud', 'snow_ice').
+              For full details, refer to the UDM2 product specifications.""")
 async def item_coverage(ctx, item_type, item_id, geom, mode, band):
     """Get item clear coverage."""
     async with data_client(ctx) as cl:

tests/integration/test_data_cli.py

@@ -1152,7 +1152,7 @@ def test_item_get_not_found(invoke, item_type, item_id):
 def test_item_coverage_success(invoke, item_type, item_id, geom_geojson):
     """Test successful item coverage command."""
     coverage_url = f'{TEST_URL}/item-types/{item_type}/items/{item_id}/coverage'
-    mock_coverage = {"clear_percent": 90.0, "status": "complete"}
+    mock_coverage = {"clear_percent": 90, "status": "complete"}
     mock_resp = httpx.Response(HTTPStatus.OK, json=mock_coverage)
     respx.post(coverage_url).return_value = mock_resp
 
@@ -1165,7 +1165,7 @@ def test_item_coverage_success(invoke, item_type, item_id, geom_geojson):
     ])
     assert result.exit_code == 0
     coverage = json.loads(result.output)
-    assert coverage["clear_percent"] == 90.0
+    assert coverage["clear_percent"] == 90
     assert coverage["status"] == "complete"
 
 
@@ -1176,7 +1176,7 @@ def test_item_coverage_with_mode_and_band(invoke,
                                           geom_geojson):
     """Test item coverage command with mode and band options."""
     coverage_url = f'{TEST_URL}/item-types/{item_type}/items/{item_id}/coverage'
-    mock_coverage = {"cloud_percent": 90.0, "status": "complete"}
+    mock_coverage = {"cloud_percent": 90, "status": "complete"}
     mock_resp = httpx.Response(HTTPStatus.OK, json=mock_coverage)
     respx.post(coverage_url).return_value = mock_resp
 
@@ -1193,7 +1193,7 @@ def test_item_coverage_with_mode_and_band(invoke,
     ])
     assert result.exit_code == 0
     coverage = json.loads(result.output)
-    assert coverage["cloud_percent"] == 90.0
+    assert coverage["cloud_percent"] == 90
     assert coverage["status"] == "complete"