search

planetlabs / planet-client-python

Python client for Planet APIs
https://planet-sdk-for-python-v2.readthedocs.io/en/latest/
Apache License 2.0
274 stars 92 forks source link

Subscription status list in CLI docs is missing values #1001

Open sgillies opened 1 year ago

sgillies commented 1 year ago

https://planet-sdk-for-python-v2.readthedocs.io/en/latest/cli/cli-subscriptions/#subscription-results

{code} The available statuses are created, queued, processing, failed, and success. Note it's quite useful to use jq to help filter out results as well. {code}

But ...

{code} planet subscriptions list --status asdf Usage: planet subscriptions list [OPTIONS] Try 'planet subscriptions list --help' for help.

Error: Invalid value for '--status': 'asdf' is not one of 'running', 'cancelled', 'preparing', 'pending', 'completed', 'suspended', 'failed'. {code}

The error message lists the correct statuses, but the docs do not.

https://developers.planet.com/docs/subscriptions/#subscription-status

tbarsballe commented 2 months ago

The SDK docs should probably just link to the subscription docs as a source-of-truth.

asonnenschein commented 1 month ago

https://github.com/planetlabs/planet-client-python/pull/1062