Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

updated documentation

  • Loading branch information...
commit 47e00d30f20791769882e4d0602f472b70d7e25d 1 parent 2ee68bb
Leo P. authored
Showing with 10 additions and 5 deletions.
  1. +10 −5 README
15 README
View
@@ -86,7 +86,7 @@ at push_client:
code.
at push_server:
- POST, PUT, and DELETE requests are allowed at this location.
+ POST, PUT, GET, and DELETE requests are allowed at this location.
A POST request will have its body ("the message"), sent to the request identified by
$push_id, with the Content-Type header forwarded. If no such request exists, the message
will be queued until it can be sent. Multiple messages can be queued, and will be received
@@ -98,11 +98,16 @@ at push_server:
Instead, if this request is sent while there is no waiting request identified by $push_id,
the message will be lost, and the server will return a 200 OK status code.
- (NOT IMPLEMENTED YET) a DELETE deletes all messages intended for $push_id. If there is a waiting
+ A DELETE deletes all messages intended for $push_id. If there is a waiting
request on push_client identified by $push_id, it will be immediately responded to with a
- 204 No Content status code.
-
-
+ 410 Gone status code.
+
+ All valid requests will be responded to with a 200 OK (everything went well, and no message was
+ or will be sent), 201 Created (Message was sent), 202 Accepted (message was queued), or
+ 404 Not Found (only for GET, and DELETE, if no such id is known). All 2xx-status responses
+ will contain a body with information about the id -- the # of queued messaged and the number of
+ seconds since a client made a request on that id (or "never" if it was never made or if it had
+ expired)
-----------------------------
TODO:
Please sign in to comment.
Something went wrong with that request. Please try again.