APIPatterns / APIPatterns/PatternsLibrary

Implement linter to warn for required fields in `body`

Aperta
#4 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
good first issue linter
Lingua principale
TypeScript
Stelle
1
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

We are exploring the use of required fields in request/response bodies. Often, these can be very problematic, e.g. if something changes from optional to required, you want to return/send only a 'partial' resource, etc. Because of versioning, client and server code has to handle changes to the resource structure anyway. Making everything optional enables greater flexibility in what can flow over the wire.

> Mark a field as `required` only when it must absolutely be present on every request/response for every version of the API.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.