Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Document purging one page or selected tags with purge-http-cache --path / --tag

Chiusa Adatta ai principianti
  • Qualcosa non va?
#193 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
kubernetes, php
Ambito
cli, documentation

Direzione di ricerca

Inizia dalla pagina della documentazione su cache HTTP e comandi da console e trova dove viene descritto silverback:api-components:purge-http-cache. Il comportamento da documentare è nella PR 396 di api-components-bundle collegata: verifica le opzioni --path e --tag, i codici di uscita e che POST /_/http_cache/purge non sia cambiato. È completato quando la pagina copre entrambe le opzioni, i codici di uscita, l'esempio con kubectl exec e la nota che l'endpoint HTTP può svuotare solo l'intera cache.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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-cache with 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-html or 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 PURGE against 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 --path not starting with /.
  • The HTTP endpoint POST /_/http_cache/purge is unchanged: whole-cache flush only.
Lingua principale
Vue
Stelle
0
Fork
0
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di components-web-app/docs

Tutte le issue di components-web-app/docs

Issue simili

Altre issue su CLI

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.