otto-de / otto-de/api-guidelines
[update] rework ETag usage
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 50
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
(i) This issue has been manually transferred from a former internal repository, as a private repository issue cannot be transferred to a public repository.
Context
Follow up of #1193:
Goal is to describe/clarify the usage of ETags for:
cache management
- good match for strong/weak etags
- Care should be taken, which headers, embedding, etc are part of the ETag calculation
concurrency control
- might not be suitable, due to strong ETags being constraint to the entity's representation and not to it's logical state
- Problems with intermediate proxies, that convert strong to weak ETags
- Introduction of a separate token as an alternative
Reference
Details can be found in the discussion of #1193.
Contributor guide
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 with the discussion and linked comments in issue #1193, including the referenced guidance on headers and ETag calculation. Identify the repository guidance section covering ETags, then revise it so the cache-management and concurrency-control guidance is explicit and complete, with the issue's stated concerns addressed.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100