|
In order to improve consistency across API within FOLIO, agree and document a set of standards.
Context
RAML describes the responses that a client can expect, it does not describe the circumstances under which a particular response is expected.
Examples
- Should a PUT respond with 201 when a new record is created, and a 204 when an existing record is replaced
- Should deleting a record that does not exist return 404 (revealing the lack of pre-existence) or 204 as the outcome is that no record exists at that location
- Should invalid JSON respond with 400 and a plain text body or 422 with a JSON body
|