oxidecomputer / oxidecomputer/dropshot
Consider support for the QUERY method
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.2k
- Forks
- 104
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 22
Description
See https://httpwg.org/http-extensions/draft-ietf-httpbis-safe-method-w-body.html
It seems that QUERY is very much like GET with a body. While a body param is (I guess) fine for GET, some tooling and services disallow or ignore it. It seems like we'll want to adopt this sooner rather than later. Whether we'll use it in omicron (or other Oxide repos) remains to be seen. There's a bunch of work this would depend upon, including:
- https://github.com/hyperium/http/pull/717
- OpenAPI 3.2 will apparently include the
QUERYmethod - support in Dropshot for OpenAPI 3.1 (i.e. and later -- 3.2 is a more minor update from 3.1 than 3.1 was from 3.0.x)
Contributor guide
No contributing guide indexed for this repository
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
No files or tests are identified; start by reviewing Dropshot's existing HTTP-method and OpenAPI handling alongside hyperium/http PR 717. Define the scope needed for QUERY support with OpenAPI 3.1 and 3.2, and verify that the resulting API behavior and specification support are complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, 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
- 28/100