Link

Entity Profile (Mixin)

Profile: <http://level3.rest/profiles/mixins/entity>

Resources often have identifiably-distinct instances of themselves defined by unique URIs. These instances are known as Entities in the real world. An entity must exist to accept operations, and clients should perform operations on them with an awareness of their current state.

The HTTP specification has some essential features to support Entity operations. These features take the form of validation headers which manage both caching and safe state modifications. Thanks to these headers, clients enjoy the performance benefits of cached response payloads by using these same headers in GET requests. Also, clients can safely operate with an Entity resource by knowing the version they are working with has not changed since they last interacted with it.

The header values ETag and Last-Modified are often transparently managed by HTTP clients, especially in browsers. A client should learn about conditional request support in their HTTP client library and enable these features.

Almost every Level 3 profile can use the Entity mixin to improve the client’s performance and safe usage. Resource implementers may find that it is more costly to support the Entity profile, but the gains for the client are usually worth the effort.

Discovery

A HEAD request returns the headers described in the table below. An Entity resource may not be able to provide both ETag and Last-Modified, but at least one must be provided for HEAD and GET requests.

Header Value
ETag An entity-tag identifying the entity version.
Last-Modified The HTTP-date the entity was last modified.
Profile <http://level3.rest/profiles/mixin/entity>

Cache-Aware Fetch

When a client makes subsequent fetch requests for an already-fetched resource, they can send validator headers to indicate the version of the representation they possess. If the resource has not changed, then the resource responds with 304 Not Modified, and the client can reuse already-fetched response payload.

Conditional Operation

A client can modify an Entity resource’s state using PUT and PATCH, remove the resource using DELETE, or use the resource’s POST operation to create new resources. Due to the distributed nature of the internet, clients usually do not want to miss other modifications, either from another client or a backend system, and cause inconsistent state with their request.

This problem, known as the “lost update” problem, is solved by reusing the validator headers from the fetch request. The client sends the ETag value in the If-Match header and the Last-Modified value in the If-Unmodified-Since header with their operation.

If the client’s version of the resource does not match the resource’s version and modification date, the resource responds with 412 Precondition Failed. The client must fetch the resource again and attempt the operation with new values for If-Match and If-Unmodified-Since.

If the client does not send If-Match or If-Unmodified-Since headers, and the resource requires them for the operations, it sends back 428 Precondition Required to indicate this requirement. The client should GET the resource, evaluate it’s state and then send a conditional operation request with the new data. For DELETE operations the client may use HEAD instead to collect the most-current validation values.

Once the client’s operation is successful, the resource sends back the new ETag and Last-Modified values in the response for PUT and PATCH operations. POST operations also return these headers, but they refer to the newly-created resource if it is an Entity resource. DELETE operations do not return validation headers.

Entity resources do not send back the representation payload on success, but rather 204 No Content. It is reasonable to assume the client who just sent the modification request already has this payload locally and need not receive it again.

Forced Modification

A client may decide that their change must override other client’s changes; they are not concerned with working from the most current version of the resource. To force a modification or deletion of an Entity resource, the client sends an If-Match: * header with their PUT or DELETE operation. Any current resource state is overwritten or deleted. However, if the Entity does not exist, the operation fails. One cannot create a nonexistent resource with PUT.

PATCH is not supported as PATCH requires contextual markers in the payload to facilitate the modification. Similarly, POST is also not supported because it’s semantics are specific to the resource profile.

Preflight Mixin

An Entity resource can mix in the Preflight profile to give the client the option of preflighting PUT, POST and PATCH operations with large payloads. The client can the Preflight Modification flow by adding the headers in the table below. Other profile of the resource may require additional preflight headers as well.

Header Value Rejection Status Codes
If-Match entity-tag, * 404, 410, 412 (for entity-tag)
If-Unmodified-Since HTTP-date 404, 410, 412

Once the resource responds with 100 Continue, then the client can send the full request including a payload.

Specifications

Additional HTTP Status Codes: RFC 6585

HTTP/1.1 Semantics and Content: RFC 7231

Conditional Requests: RFC 7232

Caching: RFC 7234


Copyright © 2019 Matt Bishop
Creative Commons Licence
This work is licensed under a Creative Commons Attribution-NoDerivatives 4.0 International License.