Rule 2 - How to handle empty collection needs to be changed

[larsolofsson]

Existing text

Rule 2 - How to handle empty collection

An empty collection MUST be communicated via the HTTP status code 204 No Content and the response MUST NOT contain a response's body. This rule will be enforced by not allowing empty array in the non-empty response's body using minItems: 1.

See issue #287 best practice for status codes

1 GET a list of items

• When items found: 200 OK
• When no items found: 200 OK with an empty collection (array)

[patricekrakow]

papiNet would prefer 200 OK (with an empty array) over 204 No Content (with no payload).

See https://apihandyman.io/empty-lists-http-status-code-200-vs-204-vs-404/ as a reference.

Let's discuss that with more people... We MUST make up our mind for the next release!

[patricekrakow]

I have drafted a proposal within commit 8108755.

WARNING: This change implies to change the minItems: 1 to minItems: 0 in all collection response schemas! At the time of writing, this implies 4 changes in respectively: ListOfSupplierOrders, ListOfLogisticsDeliveryNotes, ListOfLogisticsDeliveryInstructions and ListOfLogisticsInventoryChanges.

[larsolofsson]

Reviewed OK by me.

But shouldn't this change of Rule 2 be done at next release, if status code for empty collection is changed in next release?