oxidecomputer / oxidecomputer/omicron

Improve API selector / lookup organization

Open
#2,822 0 comments 0 reactions 1 assignee View on GitHub

@just-be-dev is already working on this.

Since Apr 12, 2023.

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

Description

After the migration to the V1 version of the API we have notions of a selector (the set of parameters required to lookup a resource) and a lookup (the mechanism by which the resource is resolved). An emergent notion of this design is that selectors themselves are only intended to be used to resolve lookups inside http endpoint handlers and that the handlers are the only thing that should be passed to the app layer. This notion is muddied a bit by the fact the functions that actually perform lookups themselves live in the app layer. We should do some cleanup to make this distinction clearer.

This mainly entails moving lookup functions outside of the app layer and into their own module.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.