oxidecomputer / oxidecomputer/omicron
Document constraints for the endpoints related to uploading disk images
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
There are constraints that are not documented that should be. At the minimum, noting what states a disk is required to be in, what state transitions occur, and maximum POST body sizes should be documented. The four relevant endpoints are:
Contributor guide
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
Read nexus/external-api/src/lib.rs at lines 3392-3445, covering the four disk-image upload endpoints. Document the required disk states, state transitions, and maximum POST body sizes; the work is done when those constraints are stated for all four endpoints.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100