microsoft / microsoft/api-guidelines
Add guidance for when/how Azure services should allow caching of responses
Open
Nobody has claimed this yet.
Azure Guidelines
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
Some references:
- https://apisyouwonthate.com/blog/caching-is-hard-draw-me-a-picture/
- https://www.rfc-editor.org/rfc/rfc9111#section-3
One of the guidelines we may want to establish:
⛔ DO NOT include a cache-control: public header in the response to an authorized request.
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 RFC 9111 section 3 and the linked caching article, then determine the scope of guidance needed for Azure service responses. Done means the guidelines clearly explain when and how responses may be cached, including the stated restriction on using cache-control: public for authorized requests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100