Skip to content

document list order ordering #915

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 11, 2023
Merged

document list order ordering #915

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions planet/cli/orders.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ async def list(ctx, state, limit, pretty):

This command prints a sequence of the returned order descriptions,
optionally pretty-printed.

Order descriptions are sorted by creation date with the last created order
returned first.
'''
async with orders_client(ctx) as cl:
async for o in cl.list_orders(state=state, limit=limit):
Expand Down
5 changes: 4 additions & 1 deletion planet/clients/orders.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,10 @@ async def wait(self,
async def list_orders(self,
state: Optional[str] = None,
limit: int = 100) -> AsyncIterator[dict]:
"""Iterate over the list of stored order requests.
"""Iterate over the list of stored orders.

Order descriptions are sorted by creation date with the last created
order returned first.

Note:
The name of this method is based on the API's method name. This
Expand Down