docs(readme): state the key permissions each example needs

Aperta
#312 0 commenti 0 reazioni 1 assegnatario Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@ffumero2003 ci sta già lavorando.

Dal 8/11/2026.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

documentation

Context

The README says to give a key "only the capabilities and buckets your program uses" but never says which each example needs, so a restricted key fails an example with no hint which capability was missing.

Acceptance criteria

  • R1. Each example states its minimal capabilities, checked against what it calls.

In scope

Add one line per example naming the required B2 application-key capabilities and bucket scope (for example "needs: listFiles, readFiles on the bucket").

Out of scope

  • Unrelated work outside the components and behavior described in In scope.

Verification

git diff --check
  • Check each example's stated capabilities and bucket scope against the API calls it performs, as required above.
  • If confirming behavior with a restricted live key, record the required environment and result; otherwise report that live verification could not run and why.
  • Expected result: the checks above succeed and the observable outcomes in Acceptance criteria are demonstrated. If a check cannot run, report Could not run because: ...; if it starts but fails, report Could not complete because: .... A skipped check is not a pass.

Links

Sits with the runnable-examples work and #187.

Lingua principale
Go
Stelle
66
Fork
18
Merge medio
1g 10h
PR unite (30g)
132

Preparare l'ambiente

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 Backblaze/blazer

Tutte le issue di Backblaze/blazer

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.