softwaremill / softwaremill/chimp
T9 - configurable cache hints
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 102
- Forks
- 10
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 16
Description
Target branch: 2026-07-28-protocol-support
Requires:
Server builders get withCacheHints allowing to replace the defaults. Option for per resource override through the resource builder.
Spec:
Caching - Cacheable Results
Caching - Time-to-Live Field
Caching - Cache Scope Field
Conformance scenarios that must pass after this task: none new, caching still passes.
Docs: yes.
- docs/server/protocol.md: section on cache hints, the defaults and the meaning of public and private
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
Start by resolving issue #246 and reading the three linked caching specification sections. Locate the server builders and resource builder entry points for cache hints, then update docs/server/protocol.md with the defaults and public/private meanings. Done means configurable server defaults, per-resource overrides, and the existing caching conformance scenario still passes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- backend-api-design, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100