planet-client-python icon indicating copy to clipboard operation
planet-client-python copied to clipboard

Subscription status list in CLI docs is missing values

Open sgillies opened this issue 1 year ago • 1 comments

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

sgillies avatar Jul 21 '23 20:07 sgillies

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

tbarsballe avatar Sep 05 '24 19:09 tbarsballe

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

asonnenschein avatar Oct 03 '24 16:10 asonnenschein