POST
and PUT
enpoints must return the full entity (e.g. schema object) so that the UI does not have to reason about how the entity will be structured after an updated.HATEOAS
(Hypermedia As The Engine Of Application State) to tell the client which operations are possible for a given entity and how to invoke them._links
object now, with all possible operations. If the operation is not possible or the current user does not have the permission the link will not be present.RISK to break something: LOW
_meta
object.RISK to break something: LOW
POST
and PUT
enpoints return the full entity (e.g. schema object) now. This is not a breaking change for you if your client has the following behavior:204 No Content
status code before, returns 200 OK
now (usally the case).RISK to break something: MEDIUM
PUT /api/content/{app}/{name}/{id}/archive/
PUT /api/content/{app}/{name}/{id}/publish/
PUT /api/content/{app}/{name}/{id}/restore/
PUT /api/content/{app}/{name}/{id}/unpublish/
RISK to break something: HIGH
POST /api/apps/{app}/assets/
does not return the isDuplicate
JSON property anymore, which has been replaced with metadata (see example above).RISK to break something: LOW
GET /api/apps/{app}/rules/
endpoint returns Items-Object instead of JSON array.RISK to break something: LOW
GET /api/apps/
endpoint returns Items-Object instead of JSON array.GET /api/apps/{app}/clients/
endpoint returns Items-Object instead of JSON array.GET /api/apps/{app}/languages/
endpoint returns Items-Object instead of JSON array.GET /api/apps/{app}/contributors/
endpoint returns Items-Object instead of custom JSON object.GET /api/apps/{app}/patterns/
endpoint returns Items-Object instead of JSON array.GET /api/apps/{app}/roles/
endpoint returns Items-Object instead of custom JSON object.RISK to break something: LOW