oxidecomputer / oxidecomputer/oxide.rs
CLI should fill in existing values for parameters not specified on update requests
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 75
- Forks
- 21
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 19
Description
Target component
- CLI
- SDK
- Something else
- Not sure
Overview
Currently commands like instance update require the user to provide all settings for the object being updated. This is inconvenient for users who need to adjust just one setting on a large number of objects, requiring them to separately lookup the details of each item and pass all of them on the command line.
For update commands, the CLI should instead make all of the field arguments optional. For values not passed, it should transparently query the API and send the existing values on the update request.
Implementation details
We'd want to update progenitor's CLI generator to implement this.
Anything else you would like to add?
No response
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with progenitor's CLI generator and the instance update command described in the issue. Trace how update field arguments are generated and how the API request is assembled; the work is done when omitted fields are populated from the existing object and update commands no longer require every setting.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100