Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Subscription status list in CLI docs is missing values #1001

Open
sgillies opened this issue Jul 21, 2023 · 2 comments
Open

Subscription status list in CLI docs is missing values #1001

sgillies opened this issue Jul 21, 2023 · 2 comments

Comments

@sgillies
Copy link
Contributor

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
Copy link
Contributor

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

@tbarsballe tbarsballe added this to the V2 Post-Release milestone Sep 5, 2024
@asonnenschein
Copy link
Contributor

#1062

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants