oxidecomputer / oxidecomputer/propolis

Move type definitions out of propolis-client

Open
#554 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
270
Forks
42
Avg merge
4d 5h
Merged PRs (30d)
6

Description

There are several swaths of types, relating to instance specs and the serial console, defined in the propolis-client lib today. Some of those are then re-exported in that same library from the code generated by progrenitor, based of the openapi json defined by propolis-server. While the handmade client code in propolis-client served a purpose early-on, as the progenitor-based bits were still being hammered out, we should clean that up so that its little more than the progenitor definition, plus whatever small helpers we deem necessary.

Types exposed by the openapi-visible portion of propolis-server should go in some sort of crate or module, used only by propolis-server (and perhaps the mock-server), rather than living in propolis-client. This will cut down on the dependencies required by propolis-client consumers as well.

Contributor guide

No contributing guide indexed for this repository

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 by inventorying the instance-spec and serial-console types in the propolis-client library, including the progenitor-generated re-exports, then compare them with the openapi-visible types in propolis-server. Determine an appropriate crate or module for server and mock-server use. Done means propolis-client retains only the progenitor definition and necessary helpers, while consumers no longer need its extra dependencies.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
backend-api-design
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.