Voting Endpoint

[austinpray]

No description provided.

[austinpray]

@smspence @ridhoq

Let's decide on the voting endpoint.

POST /votes

Request

{"action": "water"}

Response

Some success or failure object that is consistent throughout the app.

Votes for the next action to be water

GET /votes

Response

{
  "actions": {
    "water": 1,
    "nothing": 0
  }
}

Gets all the votes

[smspence]

I was thinking the response from POST /votes could look like this:

{
   "success" : bool,
   "status_code" : int,
   "status_message" : string
}

Example response:

{
   "success": true,
   "status_code": 1,
   "status_message": "The vote was successfully recorded."
}

Or maybe we can omit the success bool and just use status_code to communicate success or failure. Thoughts?

[austinpray]

{
   "success" : bool,
   "status_code" : int
}

These are not necessary because we have this built into HTTP

http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

[austinpray]

We should probably just do this for the errors: http://jsonapi.org/format/#errors

[austinpray]

Lookin pretty good: