README.md

liveplant Server

Structs

User

Example

{
  "twitterSecret": "big long string",
  "screenName": "@austinpray",
  "email": "austin@austinpray.com",
  "avatarUrl": "https://example.com/shermm.jpg"
}

Poll

Example

{
  "id": "UUID",
  "action": "water",
  "displayname": "Water The Plant",
  "deadline": "2015-01-1T00:00:00Z",
  "yee": [
    // []User
  ],
  "orNah": [
    // []User
  ],
  "yeeCount": 1,
  "orNahCount": 1
}

Plant

Example

{
  "name": "big-john",
  "displayName": "Big John",
  "currentPolls": [
    // []Poll
  ]
}

Endpoints

All endpoints are prefixed with /api/v1/

GET plants

Return all the plants the server knows about.

GET plants/:name

Return a specific plant.

GET whatdo

Return what the bot client should be doing right now. Grabs freshly expired deadlines (5 minutes).