Here-strings in request examples

Aperta Adatta ai principianti
#1,286 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 14 giorni

@jadhavgaurav ci sta già lavorando.

Dal 23/10/2026.

  • #1295 di @jadhavgaurav — aperta

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
68/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
shell
Ambito
documentation

Direzione di ricerca

Inizia con l’esempio di gestione delle policy dei token collegato nell’issue, poi cerca nella documentazione altri esempi di richieste che usano here-string. Sostituiscile con input di tipo stringa dove appropriato, mantenendo gli here-doc per gli oggetti JSON di grandi dimensioni. Il lavoro è completato quando gli esempi non dipendono più da here-string non supportate da alcune shell.

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

Descrizione

docs help wanted

The API request examples in the documentation sometimes make use of here-strings. Because some shells do not support here-strings, I think it would be beneficial to use string inputs instead. In contrast, here-docs are commonly supported, so their use in the documentation is reasonable, especially for large JSON objects.

curl https://desec.io/api/v1/auth/tokens/{id}/policies/rrsets/ \
    --header "Authorization: Token mu4W4MHuSc0Hy-GD1h_dnKuZBond" \
    --header "Content-Type: application/json" --data @- <<< \
    '{"domain": null, "subname": null, "type": null}'

This request, for example, can be replaced with:

curl https://desec.io/api/v1/auth/tokens/{id}/policies/rrsets/ \
    --header "Authorization: Token mu4W4MHuSc0Hy-GD1h_dnKuZBond" \
    --header "Content-Type: application/json" --data \
    '{"domain": null, "subname": null, "type": null}'

The only difference is the removed @- <<< part. What are your thoughts on this?

Lingua principale
Python
Stelle
678
Fork
74
Merge medio
7g 23h
PR unite (30g)
1

Preparare l'ambiente

  • Include un Dockerfile o un file Docker Compose
  • Nessun modello di pull request
  • Nessuna guida per i contributori

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 desec-io/desec-stack

Tutte le issue di desec-io/desec-stack

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.