kenaug74/Sylius
1
0
Fork 0
mirror of https://github.com/Sylius/Sylius.git synced 2026-07-14 17:10:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

[ADR] Status change and minor improvements

Browse source
This commit is contained in:
Łukasz Chruściel 2020-08-28 16:05:48 +02:00
parent 667258b2e9
commit 9559abeb0b
No known key found for this signature in database
GPG key ID: 428B9D810DB2ACDF
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
adr/2020_05_13_handling_non_crud_operations_in_api.md
View file

@ -1,12 +1,12 @@
# Handling Non-CRUD operations in API
* Status: proposed
* Date: 2020-05-13
* Status: accepted
* Date: 2020-08-31
## Context and Problem Statement
Handling non-CRUD operation over REST API is not trivial. Once operations are beyond Create, Read, Update, Delete,
which can be mapped directly to `POST`/`PUT`, `GET`, `PUT`/`PATCH`, `DELETE` HTTP methods there is no clear recommendation
Handling non-CRUD operation over REST API is not trivial. Once operations are beyond Create(`POST`/`PUT` HTTP methods),
Read(`GET` HTTP method), Update(`PUT`/`PATCH` HTTP methods), Delete(`DELETE` HTTP method) there is no clear recommendation
how to map others actions. These actions include, but are not limited to, changes of states (described in the form of
workflow in a state machine) or command execution.
@ -41,7 +41,7 @@ PUT `/api/orders/1/shipment/1`
This solution works for all standards supported by ApiPlatform(JSON-LD, JSON HAL, GraphQL).
* Good, because it does not introduce any new `verbs` (which may be considered as a bad practice for REST API)
* Good, because it does not introduce verbs into URL (which may be considered as a bad practice for REST API)
* Good, because it does not introduce any new endpoints.
* Bad, because calling `ship` on `status` may be misleading, as a result, may be different(In presented example command
`"status": "ship"` results with `"status": "shipped"`).
@ -64,7 +64,7 @@ POST `/api/orders/1/shipment/1/ship-attempts`
}
```
* Good, because it does not introduce any new `verbs` (which may be considered as a bad practice for REST API)
* Good, because it does not introduce verbs into URL (which may be considered as a bad practice for REST API)
* Good, because there may be a straight forward way to expose possible transitions (GET `/api/orders/1/shipment/1/ship-attempts`)
* Good, because it provides a clear solution for all custom endpoints.
* Good, because it uses `POST` operation for action, which is not idempotent.