oxidecomputer / oxidecomputer/omicron

Make object update routes via PUT standards-complaint

Open
#333 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Currently we do a not-quite RFC 7396 thing over PUT (rather than PATCH) to perform object updates, which is not standards compliant. For now, let's standardize on doing a full PUT (re-specifying the entire object state) for the updates.

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.

Research direction

Start by locating the object update endpoints that currently apply partial-update behavior over PUT, then read the linked RFC 7231 and RFC 7396 references. Update the affected API behavior so PUT requires the complete object state, and verify the endpoint tests cover full replacement rather than partial updates.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api, backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.