oxidecomputer / oxidecomputer/dendrite
LinkCreate is poorly named
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 20
- Forks
- 3
- Avg merge
- 3d 11h
- Merged PRs (30d)
- 4
Description
The api endpoint link_create takes a LinkCreate struct as a parameter. This is also included inside LinkSettings and used all over the place internally. However, looking at what this struct contains, it's clear, that this is a container for the layer 1, physical properties of the links.
I suggest renaming this to PhysicalLinkProps or something similar to clarify the code and APIs.
This will require an API version bump.
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 dpd-types/versions/src/initial/link.rs at the LinkCreate definition and inspect LinkSettings, the link_create endpoint, and their references. Choose and apply a physical-link properties name consistently, then bump the API version and verify that no old LinkCreate references remain.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, networking
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100