[FOLIO-698] document RESTful API guidelines for modules Created: 27/Jun/17  Updated: 14/Feb/22

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

Type: Task Priority: P3
Reporter: Jakub Skoczen Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: core, for-next-sprint, sprint17
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Blocks
blocks FOLIO-664 Get feedback on Bulk User Import prer... Closed
Relates
relates to FOLIO-399 primary keys / resource creation Closed
relates to RMB-43 document HTTP status codes Closed
Sprint: CP: Roadmap backlog
Development Team: Core: Platform

 Comments   
Comment by shale99 [ 27/Jun/17 ]

my comments on this
1. i believe there should be a dedicated update (patch) service, which fails when a record does not exist
2. in order to limit errors, i believe the UI should use the correct verb for the exposed functionality. for example, if a list of users exposes the ability to edit a user - patch should be used - and not put - so that if an edge case scenario arises where the user is deleted - the update should fail and not re-create the user. this is business use case oriented - but enforcing strictness will limit strange bugs that will most certainly arise along the line

Comment by Julian Ladisch [ 27/Jun/17 ]

see FOLIO-399 Closed about UUID when doing POST or PUT

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