papiNet should use best practice for status codes

[larsolofsson]

papiNet should review best practice for status codes and apply best practice.

My findings about best pratice 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)
• 400 Bad request

Currently in 4.0.0

• 200 OK
• 204 No Content, (Not best practice when no items found)

2 Get details of an item

• 200 OK
• 404 Not Found
• 400 Bad request

Currently in 4.0.0

• 200 OK
• 404 Not Found

3 Post when the client has defined "id": as a UUID and the server doesn't respond with a response body

• 201 Created (with Location header, no body)
• 409 Conflict (The UUID already exists)
• 400 Bad request

Currently in 4.0.0

• 200 OK
• 400 Bad request

N.B. Best practice is to use PUT instead of POST to create an resource, when the client defines the "id": as a UUID

PUT to create an resource, when the client defines the "id": as a UUID and the server doesn't respond with a response body.

• 201 Created (with Location header, body optional)
• 400 Bad request

4 PUT when used to replace an existing resource and the server doesn't respond with a response body

• 204 No Content
• 400 Bad request

Currently in 4.0.0

• 200 OK
• 400 Bad request

[larsolofsson]

Rule 2 with new text
An empty collection MUST be communicated via the HTTP status code 200 OK using the standard pagination envelope, with the total count set to 0 and the items array empty. This is enforced by the schema, which explicitly allows empty arrays via minItems: 0.

If the status code for empty collection is changed in next release, then the following change is also needed.

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.

[patricekrakow]

(to be edited)

We will use consistently 201 Created without body response.

GET thingies
200 OK
{ count: 1, data: [ ... ] }

GET thingies
200 OK { count: 0, data: [] }

GET thingie
400 Bad Request

---

GET thingies/{thingyId}
200 OK

GET thingies/{thingyId}
404 Not Found

GET thingies/{thingyI}
400 Bad Request

---

not POST

---

PUT thingies/{thingyId}
{
id
data
}
201 Created

---

PUT thingies/{thingyId}
{
id
data
}
204 No Content

PUT thingies/{thingyId}
{
id
data2
}
400 Bad Request

---

Update rule 2 and refer to a new rule handling ALL status codes!