[FOLIO-1958] Agree upon HTTP API standards Created: 10/Apr/19  Updated: 25/Jan/23  Resolved: 25/Jan/23

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Task Priority: P3
Reporter: Marc Johnson Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: potential-decision
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Blocks
blocks MODINVSTOR-81 Consider to use 404 over 204 when del... Closed
Relates
relates to MODINVSTOR-73 Contributor type uuids can be changed... Closed
relates to MODINVSTOR-75 Inconsistent response status code for... Closed
relates to MODINVSTOR-78 Inconsistent response status code for... Closed
Sprint:
Development Team: Core: Platform

 Description   

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

Generated at Thu Feb 08 23:17:09 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.