Skip to content

Commit 2309d47

Browse files
committed
doc example update
1 parent e405d6e commit 2309d47

File tree

2 files changed

+12
-16
lines changed

2 files changed

+12
-16
lines changed

design-docs/CLI-Data.md

+9-13
Original file line numberDiff line numberDiff line change
@@ -601,7 +601,7 @@ Options:
601601
--pretty - flag. Pretty-print output
602602
603603
Output:
604-
A full GeoJSON description of the item, including its properties, assets, and metadata.
604+
A full GeoJSON description of the returned item.
605605
```
606606

607607
### Usage Examples
@@ -630,8 +630,7 @@ ITEM_ID - The ID of the item
630630
Options:
631631
--geom TEXT - A GeoJSON geometry or feature reference. [required]
632632
--mode TEXT - Method used for coverage calculation (e.g., UDM2, estimate)
633-
--band TEXT - Specific band to extract from UDM2 (e.g., cloud, haze)
634-
--pretty - Pretty print the output.
633+
--band TEXT - Specific band to extract from UDM2 (e.g., cloud, snow)
635634
636635
Output:
637636
A JSON description of the clear coverage for the provided AOI within the scene.
@@ -645,25 +644,25 @@ User Story: As a CLI user I want to get clear coverage information for a specifi
645644
$ planet data item-coverage PSScene 20250304_162555_90_24f2 \
646645
--geom '{"type":"Polygon","coordinates":[[[-81.45,30.31],[-81.45,30.23],[-81.38,30.23],[-81.45,30.31]]]}'
647646
```
648-
response (pretty-printed)
647+
response
649648
```
650649
{
651650
"clear_percent": 95,
652651
"status": "complete"
653652
}
654653
```
655654

656-
User Story: As a CLI user I want to get haze coverage over my Feature Ref.
655+
User Story: As a CLI user I want to get snow coverage over my Feature Ref.
657656

658657
```console
659658
$ planet data item-coverage PSScene 20250304_162555_90_24f2 \
660659
--geom 'pl:features/my/[collection-id]/[feature-id]' \
661-
--band haze
660+
--band snow
662661
```
663-
response (pretty-printed)
662+
response
664663
```
665664
{
666-
"haze_percent": 0.0,
665+
"snow_percent": 0.0,
667666
"status": "complete"
668667
}
669668
```
@@ -691,7 +690,7 @@ User Story: As a CLI user I want to get information about a specific asset for a
691690
```console
692691
$ planet data asset-get PSScene 20221003_002705_38_2461 basic_udm2
693692
```
694-
response (pretty-printed)
693+
response
695694
```
696695
{
697696
"_links": {
@@ -714,9 +713,6 @@ planet data asset-list [OPTIONS] ITEM_TYPE ITEM_ID
714713

715714
List all assets available for an item.
716715

717-
Options:
718-
- --pretty - Pretty print the output.
719-
720716
Arguments:
721717
- ITEM_TYPE - The type of item (e.g., PSScene, SkySatScene)
722718
- ITEM_ID - The ID of the item
@@ -731,7 +727,7 @@ User Story: As a CLI user I want to see all available assets for an item.
731727
```console
732728
$ planet data asset-list PSScene 20221003_002705_38_2461
733729
```
734-
response (pretty-printed)
730+
response
735731
```
736732
{
737733
"basic_analytic_4b": {

docs/cli/cli-data.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -441,7 +441,7 @@ planet data item-get PSScene 20230310_083933_71_2431
441441
The `item-coverage` command estimates the clear coverage of an item within a specified area of interest (AOI). This is useful for determining how much of your area of interest is covered by clouds or other obstructions:
442442

443443
```sh
444-
planet data item-coverage PSScene 20230310_083933_71_2431 --geom geometry.geojson
444+
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]]]}'
445445
```
446446

447447
You can also specify additional parameters:
@@ -453,7 +453,7 @@ You can also specify additional parameters:
453453
For example:
454454

455455
```sh
456-
planet data item-coverage PSScene 20230310_083933_71_2431 --geom geometry.geojson --band "haze"
456+
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]]]}' --band='snow'
457457
```
458458

459459
## Item Asset Management
@@ -475,7 +475,7 @@ This will show you all asset available for the item, including their status and
475475
To get detailed information about a specific asset:
476476

477477
```sh
478-
planet data asset-get PSScene 20230310_083933_71_2431 ortho_analytic_8b_sr
478+
planet data asset-get PSScene 20230310_083933_71_2431 ortho_analytic_8b
479479
```
480480

481481
This command provides information about the asset's status download availability.

0 commit comments

Comments
 (0)