Skip to content

Subscription status list in CLI docs is missing values #1001

@sgillies

Description

@sgillies
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

Activity

self-assigned this
on Sep 5, 2024
tbarsballe

tbarsballe commented on Sep 5, 2024

@tbarsballe
Contributor

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

added this to the V2 Post-Release milestone on Sep 5, 2024
asonnenschein

asonnenschein commented on Oct 3, 2024

@asonnenschein
Contributor
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

    Development

    No branches or pull requests

      Participants

      @sgillies@asonnenschein@tbarsballe

      Issue actions

        Subscription status list in CLI docs is missing values · Issue #1001 · planetlabs/planet-client-python