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

Document public vs admin Mercure updates (api-components-bundle #497)

Chiusa Adatta ai principianti
  • Qualcosa non va?
#258 1 commento 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
75/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
symfony, typescript
Ambito
documentation

Direzione di ricerca

Leggi la sezione Mercure / tempo reale in content/4.api/ e confrontala con api-components-bundle PR #497, collegata dall’issue. Documenta il comportamento degli aggiornamenti pubblici, degli aggiornamenti privati dell’amministrazione e delle bozze, i grants, il routing di Messenger, la fuga di informazioni e una sotto-richiesta interna per ogni resource creato o aggiornato. Il lavoro è completato quando la documentazione copre ciascun comportamento e ciascuna avvertenza elencati.

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/497 (issue #494) changes what Mercure publishes. To document in content/4.api/ (Mercure / real-time section):

  • Public update: the public update for a created or updated resource is what an anonymous GET of that resource returns. When anonymous callers can't read the resource (401/403/404), the public update is a delete {"@id": "<iri>"}. That covers a page no live route reaches, a route before its liveAt, and a published component moved to a future date.
  • Admin update: the writer's view is published privately on <iri>?draft=1 after the public update. It is only published when it differs from the public payload.
  • Grants: every Mercure resource class grants admins <pattern>\\?draft=1. Here an admin is anyone holding the publishable.permission (or a class's own #[Publishable(isGranted:)]).
  • Drafts: a draft is still published only privately on ?draft=1.
  • Messenger routing: an application that routes Symfony\\Component\\Mercure\\Update to an async transport must also route Silverback\\ApiComponentsBundle\\Message\\PublishMercureUpdatesMessage. That message carries a resource's public and private updates in order.
  • Information disclosure: a public delete for a resource that was never public reveals that its IRI exists. A route IRI contains its path.
  • Cost: each created or updated resource costs one internal sub-request.
Lingua principale
TypeScript
Stelle
0
Fork
0
Merge medio
1h 20m
PR unite (30g)
1

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 TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.