Document purging one page or selected tags with purge-http-cache --path / --tag
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- kubernetes, php
- Domain
- cli, documentation
Research direction
Start on the HTTP cache / console commands docs page and find where silverback:api-components:purge-http-cache is described. The behaviour to document is in the linked api-components-bundle PR 396: check the --path and --tag options, the exit codes, and that POST /_/http_cache/purge is unchanged. Done when the page covers both options, the exit codes, the kubectl exec example, and the whole-cache-only note for the HTTP endpoint.
Written by the indexing model from the issue text.
Description
api-components-bundle PR: https://github.com/components-web-app/api-components-bundle/pull/396 (closes components-web-app/api-components-bundle#390; background components-web-app/components-web-app#138).
What to document (API bundle, HTTP cache / console commands page):
silverback:api-components:purge-http-cachewith no options still flushes the whole cache (Souin only).--path </path>(repeatable) purges one page: it purges the tag a write to the route at that path purges,<route import prefix>/_/routes/<path>(in the template/_api/_/routes//about-us). Works whether or not a route still exists at that path.--tag <tag>(repeatable) purges any tag, e.g.cwa-htmlor a resource IRI.- Either option purges only those tags through the configured purger, never a full flush. With Souin it is a surrogate-key purge, so with the template's Cloudflare provider it also purges Cloudflare (a URL
PURGEagainst the site does not work; see components-web-app#138). - How to run it in the template:
kubectl exec -n <ns> deploy/<release> -c cwa-php -- bin/console silverback:api-components:purge-http-cache --path /about-us. - Exit codes: 0 on success, and also when no purger is configured (nothing purged, says so); 1 when the purge request fails; 2 for a tag containing a space or comma, or a
--pathnot starting with/. - The HTTP endpoint
POST /_/http_cache/purgeis unchanged: whole-cache flush only.
- Dominant language
- Vue
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from components-web-app/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
components-web-app/docs#217 ·
-
documentation
Difficulty 1/5 1-3 hours Newbie friendliness 82/100
components-web-app/docs#216 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
components-web-app/docs#215 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
components-web-app/docs#214 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
components-web-app/docs#213 ·
All issues in components-web-app/docs
Similar issues
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
charmbracelet/glow#1058 ·
Maintainers usually reply within 1 day
-
area::tern-term difficulty::easy good first issue kind::bug triage::ready
Difficulty 1/5 1-3 hours Newbie friendliness 94/100
-
darwin zsh
Difficulty 1/5 Under an hour Newbie friendliness 90/100
carapace-sh/carapace-bin#3846 ·
Maintainers usually reply within 1 day
-
raised-by:verifier
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
medici-finance/assay#2718 ·
Maintainers usually reply within 1 day
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
SaboLabs/soroban-devkit#333 ·
Maintainers usually reply within 1 day