oxidecomputer / oxidecomputer/dropshot

would like a more generic no-content response type

Open
#265 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1.2k
Forks
104
Avg merge
1d 19h
Merged PRs (30d)
22

Description

The HttpResponseOk typed response has the (at times helpfully) generic description successful operation, but requires a serialisable body and uses response code 200. The HttpResponseUpdatedNoContent typed response allows a HTTP 204 to be generated with no content, but has the description resource updated which is not quite right for everything; e.g., it feels a bit of a mismatch to use this for a resource creation that does not return a body, or for something more like a function call interface where an operation is performed, say with a POST.

Would it make sense to have a HttpResponseOkNoContent typed response that generates a 204 but otherwise uses the successful operation description?

Contributor guide

No contributing guide indexed for this repository

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

Locate the definitions of HttpResponseOk and HttpResponseUpdatedNoContent and inspect their existing tests. Add the proposed no-content response with the successful operation description and HTTP 204 behavior, then extend the relevant tests to verify its generated response.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api, backend-api-design
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.