[
  {
    "type": "get",
    "url": "/:user/:talk",
    "title": "Read data of a Talk",
    "version": "0.0.1",
    "name": "GetTalk",
    "group": "Talk",
    "description": "<p>Get talk data from speakerdeck.com</p> ",
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "user",
            "description": "<p>The Users ID.</p> "
          },
          {
            "group": "Parameter",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "talk",
            "description": "<p>The Talk ID.</p> "
          }
        ]
      }
    },
    "examples": [
      {
        "title": "Example usage:",
        "content": "curl -i http://speakerdeck-api.herokuapps.com/patrickhamann/breaking-news-at-1000ms-velocity-eu-2014",
        "type": "json"
      }
    ],
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "<p>Object</p> ",
            "optional": false,
            "field": "user",
            "description": "<p>The User object.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "user.data.id",
            "description": "<p>The Users id.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "user.data.name",
            "description": "<p>The Users name.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "user.data.avatar",
            "description": "<p>The Users avatar.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "user.data.presentations",
            "description": "<p>The ammount of other Talks the Users has.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "id",
            "description": "<p>The id of the Talk.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "title",
            "description": "<p>The title of the Talk.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "date",
            "description": "<p>The date of the Talk.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "description",
            "description": "<p>The description of the Talk.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "thumbnail",
            "description": "<p>The Talk cover slide thumbnail.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Number</p> ",
            "optional": false,
            "field": "views",
            "description": "<p>The ammount of times the Talk has been viewed.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Number</p> ",
            "optional": false,
            "field": "stars",
            "description": "<p>The ammount of times the Talk has been starred.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "embed",
            "description": "<p>The embed code for the Talk.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "download",
            "description": "<p>The direct link to the Talks .pdf file.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Object[]</p> ",
            "optional": false,
            "field": "links",
            "description": "<p>Array of hyperlinks related to the Talk.</p> "
          }
        ]
      }
    },
    "sampleRequest": [
      {
        "url": "http://speakerdeck-api.herokuapps.com"
      }
    ],
    "error": {
      "fields": {
        "Error 4xx": [
          {
            "group": "Error 4xx",
            "optional": false,
            "field": "TalkNotFound",
            "description": "<p>The <code>id</code> of the Talk was not found.</p> "
          }
        ]
      }
    },
    "filename": "controllers/talk.js",
    "groupTitle": "Talk"
  },
  {
    "type": "get",
    "url": "/:user",
    "title": "Read data of a User",
    "version": "0.0.1",
    "name": "GetUser",
    "group": "User",
    "description": "<p>Get user data from speakerdeck.com</p> ",
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "user",
            "description": "<p>The Users ID.</p> "
          },
          {
            "group": "Parameter",
            "type": "<p>Number</p> ",
            "optional": true,
            "field": "page",
            "description": "<p>The page to query.</p> "
          }
        ]
      }
    },
    "examples": [
      {
        "title": "Example usage:",
        "content": "curl -i http://speakerdeck-api.herokuapps.com/patrickhamann",
        "type": "json"
      }
    ],
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "<p>Object</p> ",
            "optional": false,
            "field": "user",
            "description": "<p>The User object.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "user.data.id",
            "description": "<p>The Users id.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "user.data.name",
            "description": "<p>The Users name.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "user.data.bio",
            "description": "<p>The Users bio.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "user.data.avatar",
            "description": "<p>The Users avatar.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Number</p> ",
            "optional": false,
            "field": "count",
            "description": "<p>Count of Talks returned in current query.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Object[]</p> ",
            "optional": false,
            "field": "talks",
            "description": "<p>Array of Talks by the User.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "talks.data.id",
            "description": "<p>The id of the Talk.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "talks.data.title",
            "description": "<p>The title of the Talk.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "talks.data.date",
            "description": "<p>The date of the Talk.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Number</p> ",
            "optional": false,
            "field": "talks.data.slides",
            "description": "<p>The total number of slides within the Talk.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>String</p> ",
            "optional": false,
            "field": "talks.data.thumbnail",
            "description": "<p>The talks cover slide thumbnail.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Object[]</p> ",
            "optional": false,
            "field": "talks.links",
            "description": "<p>Array of hyperlinks related to the Talk.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Object</p> ",
            "optional": false,
            "field": "pagination",
            "description": "<p>Pagination data.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Number</p> ",
            "optional": false,
            "field": "pagination.currentPage",
            "description": "<p>The index of the current page.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Number</p> ",
            "optional": true,
            "field": "pagination.nextPage",
            "description": "<p>The index of the next page.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Number</p> ",
            "optional": true,
            "field": "pagination.previousPage",
            "description": "<p>The index of the next page.</p> "
          },
          {
            "group": "Success 200",
            "type": "<p>Object[]</p> ",
            "optional": false,
            "field": "pagination.links",
            "description": "<p>Array of hyperlinks related to the pagination.</p> "
          }
        ]
      }
    },
    "error": {
      "fields": {
        "Error 4xx": [
          {
            "group": "Error 4xx",
            "optional": false,
            "field": "UserNotFound",
            "description": "<p>The <code>id</code> of the User was not found.</p> "
          }
        ]
      }
    },
    "filename": "controllers/user.js",
    "groupTitle": "User"
  }
]