defaults shouldn't be added to PUT and PATCH endpoints

LiveRamp / reslang

A language for describing resource-oriented APIs & turning them into Swagger or resource diagrams. Oriented around the concepts we want to expose in the APIs.

Apache License 2.0

23 stars 7 forks source link

defaults shouldn't be added to PUT and PATCH endpoints #75

Closed khardaw closed 4 years ago

khardaw commented 4 years ago

With the new default option in reslang, the default is specified in both POST and PUT / PATCH. I could see the default being providing in a PUT but I think PATCH endpoints should not specify defaults. It's too easy to inadvertently override the current value when defaults are provided in a PATCH.

liveandrew commented 4 years ago

addressed in PR https://github.com/LiveRamp/reslang/pull/92

liveandrew commented 4 years ago

merged PR. please re-open if this doesn't meet your needs.

rules are:

no defaults for attributes in the following situations:

GET, MULTIGET - why would the client want to assume a default?
PATCH - all fields are optional, the default is just confusing at that point
POST or PUT if the field is not optional (if you have to supply it why do you need a default - use example instead)