search

braid-org / braid-spec

Working area for Braid extensions to HTTP
https://braid.org
236 stars 16 forks source link

Added comment about specific version requests being optional #90

Closed josephg closed 3 years ago

josephg commented 3 years ago

The current spec implies the server must either support requesting all historical versions or none of them. We should make it clear servers can support all, none or some historical version requests based on implementation details.

My language here feels awkward.

toomim commented 3 years ago

@josephg Please also add yourself as an author to the spec once you've made a change, following the instructions at https://github.com/braid-work/braid-spec#contributing

josephg commented 3 years ago

I've updated the wording to this:

A server does not need to honor historical version requests for all documents, for all history. If a server no longer has the historical context needed to honor a request, it may respond using the 416 Range Not Satisfiable status code. (Defined in RFC7233, Section 4.4)

With an example:

      Request:

         GET /chat
         Version: "ej4lhb9z78"

      Response:

         HTTP/1.1 416 Range Not Satisfiable
         Version: "ej4lhb9z78"

I'm not actually sure that 416 is the right error code - but I think its a reasonable choice. 404 will cause problems with caching proxies, since it implies the specific requested document no longer exists. 416 responses usually name the invalid range. From the spec in RFC7233:

     HTTP/1.1 416 Range Not Satisfiable
     Date: Fri, 20 Jan 2012 15:41:54 GMT
     Content-Range: bytes */47022

... So I think its reasonable to extend the semantics to instead specify the version from which historical data is not available.

josephg commented 3 years ago

Concerns:

Path forward: Change 416 to XXX and merge before 03. We will decide an error status code in a subsequent issue / discussion.

Also: What should the client do in situations like this?

josephg commented 3 years ago

I've left the error code open for now, as discussed at the meeting. We will need to revisit this at some point in the future.