belgif / rest-guide

REST Guidelines of Belgian government institutions
https://www.belgif.be/specification/rest/api-guide/
Apache License 2.0
24 stars 4 forks source link

Create resource: allow returning resource representation #92

Closed wsalembi closed 1 year ago

wsalembi commented 2 years ago

https://www.gcloud.belgium.be/rest/#create-resource

AS-IS: The response contains an empty body.

TO-BE: The response either contains an empty body or the representation of the created resource.

pvdbosch commented 2 years ago

I agree to allow returning the resource. Other REST guidelines:

Maybe we can also allow partial resource to be returned (e.g. only generated identifier). Maybe some guidelines what to consider in this decision? Is it a large resource; are there any generated/default fields added, ...

pvdbosch commented 2 years ago

Conclusion of WG meeting 30/3, allow three response bodies:

pvdbosch commented 1 year ago

PR was merged and being published