oxidecomputer / oxidecomputer/omicron
Tracking issue for client-side versioned APIs (RFD 532)
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
when there’s no way to ensure that the server side will always be updated first, then servers still need to support the previous release (as in server-side-only versioned), and clients also need to support the API version from the previous release.
When client-side-versioning is necessary, Reconfigurator will provide a reliable way for clients to know which API version they should use. This property will change dynamically at runtime.
This issue is to track implementing the latter part: the reliable way for clients to know which API version they should use.
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.
Research direction
Read RFD 532 first, then trace the Reconfigurator components responsible for communicating API-version choices to clients. Define the runtime behavior and identify the relevant implementation and test entry points before making changes; done means clients can reliably learn which API version to use as that choice changes dynamically.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100