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

Enhancement: extend planner task get with more options #3229

Closed
Jwaegebaert opened this issue Apr 12, 2022 · 5 comments
Closed

Enhancement: extend planner task get with more options #3229

Jwaegebaert opened this issue Apr 12, 2022 · 5 comments
Assignees
Milestone

Comments

@Jwaegebaert
Copy link
Contributor

Jwaegebaert commented Apr 12, 2022

Within the planner aspect, there are typically more options provided on get level with the ability to retrieve it by plannerName, bucketName, etc. I think it could be interesting to align planner task get with this capability. Then we would get the following options.

Option Description
-i, --id [id] ID of the task. Specify either id or title but not both. When you specify the task ID, you no longer need to provide the information for bucket, plan, and ownerGroup.
-t, --title [title] Title of the task. Specify either id or title but not both.
--bucketId [bucketId] Bucket ID to which the task belongs. Specify bucketId or bucketName when using title.
--bucketName [bucketName] Bucket Name to which the task belongs. Specify bucketId or bucketName when using title.
--planId [planId] Plan ID to which the task belongs. Specify planId or planName when using bucketName.
--planName [planName] Plan Name to which the task belongs. Specify planId or planName when using bucketName.
--ownerGroupId [ownerGroupId] ID of the group to which the plan belongs. Specify ownerGroupId or ownerGroupName when using planName.
--ownerGroupName [ownerGroupName] Name of the group to which the plan belongs. Specify ownerGroupId or ownerGroupName when using planName.
@waldekmastykarz
Copy link
Member

Nice suggestion, @Jwaegebaert! It would be helpful to expand the descriptions of other options saying that they're only necessary when you want to retrieve task by its title. When you use its ID, you don't need to specify the plan, bucket, etc.

@Jwaegebaert
Copy link
Contributor Author

Good suggestion, I updated the specs. Should we also apply this to the new issue planner bucket get #3226. That when they make us of ID that they don't need to specify plan and ownerGroup

@waldekmastykarz
Copy link
Member

Good suggestion, I updated the specs. Should we also apply this to the new issue planner bucket get #3226. That when they make us of ID that they don't need to specify plan and ownerGroup

Absolutely!

@Jwaegebaert
Copy link
Contributor Author

I can work on this one if the specs are alright 😄

@waldekmastykarz
Copy link
Member

Please do! We appreciate your help 👏

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

Successfully merging a pull request may close this issue.

3 participants