oxidecomputer / oxidecomputer/omicron
Update API to match resolution of RFD-322
Open
@just-be-dev is already working on this.
Since Dec 8, 2022.
api
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
In RFD-322 we reached consensus to update our API design to be ID first[^1]. This issue is to track the work necessary to complete that transition.
Migration
- Update RFD-322's determination section for clarity
- Update
instanceendpoints first as a PoC of the approach #1957 - Update
diskendpoints #2008 - Update networking endpoints #2057
- Update
organizationendpoints #2050 - Update
projectendpoints #2050 - Update
snapshotendpoints #2347 - Update users and groups #2423
- Update
imageendpoints - Update
systemendpoints - Update remaining endpoints
- Delete non-V1 endpoints
Cutover
- Improve all the v1 error messages
- Update tests to use v1 APIs
- Mark non-v1 endpoints as deprecated (depends on https://github.com/oxidecomputer/dropshot/pull/503)
- Cleanup authz test ignores
- Update authz test to be able to verify both id and name path requests to the same endpoint.
- Cleanup any
TODO-v1comments - Cleanup nexus action names as per this comment
- Move all possible contents of a handler into the handler method (context)
- Add comments on each individual property in the selectors to note how they relate to each other (context)
- https://github.com/oxidecomputer/omicron/issues/2409
[^1]: I'm working on synthesizing the discussions and decisions into an an actual determination section
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.
Assessment
This issue has not been assessed yet.