Clarify the absence of fields with nested messages

Aperta
#213 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Ambito
api, documentation

Direzione di ricerca

Inizia individuando la documentazione per i campi di richiesta e risposta i cui tipi sono messaggi annidati. Esamina come viene attualmente descritta la presenza dei campi, quindi documenta se ciascuno di questi campi deve essere impostato, salvo diversa indicazione; il lavoro è completato quando la regola di presenza è esplicita in tutta la documentazione pertinente.

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

Descrizione

documentation enhancement I3 S4 U4

There are plenty of fields of message type. I propose to explicitly write in docs whether the field MUST be set.

Where it is not written otherwise, I suggest to require field presence. Later we can relax the requirement, which would be a backwards compatible change.

These requirements will reduce the number of uncertainties when writing software.

Note: this only applies to fields in requests/responses.

Lingua principale
Makefile
Stelle
12
Fork
15
Merge medio
1g 19h
PR unite (30g)
9

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 nspcc-dev/neofs-api

Tutte le issue di nspcc-dev/neofs-api

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.