oxidecomputer / oxidecomputer/third-party-api-clients

allow using httpcache without depending on reqwest directly

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

Nobody has claimed this yet.

Dominant language
Rust
Stars
150
Forks
62
PR merge metrics
No merged PRs in 30d

Description

reqwest types are part of the public API via Client::custom. this is pretty inconvenient because downstream users have to take a direct dependency on reqwest in order to use httpcache. It is additionally inconvenient that the version of reqwest used by the downstream user must match (or be compatible with) the version used in octorust (or other clients).

Possible solutions:

  • provide a constructor that takes httpcache but not the client.
  • re-export the necessary reqwest types.

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

Start by reading the public Client::custom API and tracing how httpcache is passed into it. Compare the proposed constructor and reqwest re-export approaches, including their downstream dependency and compatibility effects. Done means httpcache can be used without a direct reqwest dependency and the chosen public API is documented and tested.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.