-
Notifications
You must be signed in to change notification settings - Fork 5
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
Add status parameter to filter jobs #30
Conversation
Hello. You may have forgotten to update the changelog!
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. We should probably include a list of available statuses so users don't have to guess at what they could be.
Co-authored-by: Paul Finlay <50180049+doctorperceptron@users.noreply.github.com>
…b.com:XanaduAI/xanadu-cloud-client into sc-19591-add-status-parameter-to-job-list-api
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the contribution, @HudZah! 🎉
What happens if ids
and status
are both specified? 🤔
- Does
ids
take precedence? - Or will
status
filter the jobs specified byids
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The latter, I tested this previously, and it should filter the jobs specified by
ids
I believe.
Ah, okay! That seems pretty intuitive. 👍
I was going to suggest documenting this behaviour in the xcc job list
help documentation and xcc.Job.list
docstring but, upon further reflection, I don't think that is necessary.
Co-authored-by: Mikhail Andrenkov <Mandrenkov@users.noreply.github.com>
Co-authored-by: Mikhail Andrenkov <Mandrenkov@users.noreply.github.com>
Co-authored-by: Mikhail Andrenkov <Mandrenkov@users.noreply.github.com>
Co-authored-by: Mikhail Andrenkov <Mandrenkov@users.noreply.github.com>
Co-authored-by: Mikhail Andrenkov <Mandrenkov@users.noreply.github.com>
Co-authored-by: Mikhail Andrenkov <Mandrenkov@users.noreply.github.com>
Co-authored-by: Mikhail Andrenkov <Mandrenkov@users.noreply.github.com>
Context:
With this change users can filter the jobs by the
status
parameter that is passed to the/ jobs
endpoint where the jobs are filtered and returned.Description of the Change:
status
parameter to thexcc.Job.list()
status
parameter in the CLI as well by using the--status
argument.Benefits:
Possible Drawbacks:
N/A
Related GitHub Issues:
N/A