oxidecomputer / oxidecomputer/omicron

Make image OS and version fields optional

Open
#5,993 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
572
Forks
97
Avg merge
2d 12h
Merged PRs (30d)
96

Description

We accept empty string as a non-null value, which is why these can be left empty in the web console, but then when creating images in the CLI and API, these fields are required (even though you can pass empty string). This is all a confusing state of affairs — if we allow empty string, we should probably just let them be null too.

https://github.com/oxidecomputer/omicron/blob/617990503cbd9cf4968327e14d45da0251563ec7/nexus/types/src/external_api/params.rs#L1858-L1862

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in nexus/types/src/external_api/params.rs at lines 1858-1862, where the image OS and version parameters are defined. Compare how the web console, CLI, and API represent empty values, then update the API behavior so these fields consistently accept null as well as empty strings. Confirm that image creation through the CLI and API no longer requires non-null values.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.