Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update the key calculation expression of proxy cache #8316

Merged
merged 1 commit into from
Jan 8, 2025

Conversation

42milez
Copy link
Contributor

@42milez 42milez commented Jan 3, 2025

Description

In the description of Proxy Cache, it is explained that the cache key is calculated using the following expression.

key = md5(UUID | method | request)

However, in the source code of Proxy Cache (3.9.0), the cache key is calculated from the following five elements.

https://github.com/Kong/kong/blob/3.9.0/kong/plugins/proxy-cache/cache_key.lua#L111-L112

Because of that, I have updated the expression in the documentation to match it with the one of source code.

Testing instructions

Preview link:

Checklist

@42milez 42milez requested a review from a team as a code owner January 3, 2025 12:33
Copy link

netlify bot commented Jan 3, 2025

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit c96b5a4
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/677a1bc5bc1cb30008df202c
😎 Deploy Preview https://deploy-preview-8316--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
9 paths audited
Performance: 94 (🟢 up 4 from production)
Accessibility: 92 (no change from production)
Best Practices: 98 (🟢 up 8 from production)
SEO: 99 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@42milez 42milez changed the title docs: update the key calculation method of proxy cache docs: update the key calculation expression of proxy cache Jan 3, 2025
@lmilan lmilan added the review:copyedit Request for writer review. label Jan 6, 2025
@lmilan lmilan merged commit b0220cb into Kong:main Jan 8, 2025
17 of 18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:copyedit Request for writer review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants