APIPatterns / APIPatterns/PatternsLibrary

Implement linter to warn for required fields in `body`

Ouverte
#4 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
good first issue linter
Langage dominant
TypeScript
Étoiles
1
Forks
0
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.