Merge pull request octokit#241 from mikedeboer/docUrls

Auto-generate documentation URLs by parsing them from a fresh grab of th...

Author: mikedeboer

api/v3.0.0/authorization.js

@@ -29,6 +29,8 @@ var authorization = module.exports = {
      *  - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
      *  - page (Number): Optional. Page number of the results to fetch. Validation rule: ` ^[0-9]+$ `.
      *  - per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
+     *
+     * https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations
      **/
     this.getAll = function(msg, block, callback) {
         var self = this;
@@ -74,6 +76,8 @@ var authorization = module.exports = {
      *
      *  - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
      *  - id (String): Required. 
+     *
+     * https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization
      **/
     this.get = function(msg, block, callback) {
         var self = this;
@@ -121,6 +125,8 @@ var authorization = module.exports = {
      *  - scopes (Array): Optional. A list of scopes that this authorization is in.
      *  - note (String): Optional. A note to remind you what the OAuth token is for.
      *  - note_url (String): Optional. A URL to remind you what app the OAuth token is for.
+     *
+     * https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization
      **/
     this.create = function(msg, block, callback) {
         var self = this;
@@ -171,6 +177,8 @@ var authorization = module.exports = {
      *  - remove_scopes (Array): Optional. A list of scopes to remove from this authorization.
      *  - note (String): Optional. A note to remind you what the OAuth token is for.
      *  - note_url (String): Optional. A URL to remind you what app the OAuth token is for.
+     *
+     * https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization
      **/
     this.update = function(msg, block, callback) {
         var self = this;
@@ -216,6 +224,8 @@ var authorization = module.exports = {
      *
      *  - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
      *  - id (String): Required. 
+     *
+     * https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization
      **/
     this.delete = function(msg, block, callback) {
         var self = this;

api/v3.0.0/gists.js

@@ -30,6 +30,8 @@ var gists = module.exports = {
      *  - page (Number): Optional. Page number of the results to fetch. Validation rule: ` ^[0-9]+$ `.
      *  - per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
      *  - since (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
+     *
+     * https://developer.github.com/v3/gists/#list-gists
      **/
     this.getAll = function(msg, block, callback) {
         var self = this;
@@ -125,6 +127,8 @@ var gists = module.exports = {
      *  - description (String): Optional. 
      *  - public (Boolean): Required. 
      *  - files (Json): Required. Files that make up this gist. The key of which should be a required string filename and the value another required hash with parameters: 'content'
+     *
+     * https://developer.github.com/v3/gists/#create-a-gist
      **/
     this.create = function(msg, block, callback) {
         var self = this;
@@ -172,6 +176,8 @@ var gists = module.exports = {
      *  - id (String): Required. 
      *  - description (String): Optional. 
      *  - files (Json): Required. Files that make up this gist. The key of which should be a required string filename and the value another required hash with parameters: 'content'
+     *
+     * https://developer.github.com/v3/gists/#edit-a-gist
      **/
     this.edit = function(msg, block, callback) {
         var self = this;
@@ -217,6 +223,8 @@ var gists = module.exports = {
      *
      *  - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
      *  - since (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
+     *
+     * https://developer.github.com/v3/gists/#list-gists
      **/
     this.public = function(msg, block, callback) {
         var self = this;
@@ -262,6 +270,8 @@ var gists = module.exports = {
      *
      *  - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
      *  - since (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
+     *
+     * https://developer.github.com/v3/gists/#list-gists
      **/
     this.starred = function(msg, block, callback) {
         var self = this;
@@ -307,6 +317,8 @@ var gists = module.exports = {
      *
      *  - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
      *  - id (String): Required. 
+     *
+     * https://developer.github.com/v3/gists/#get-a-single-gist
      **/
     this.get = function(msg, block, callback) {
         var self = this;
@@ -352,6 +364,8 @@ var gists = module.exports = {
      *
      *  - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
      *  - id (String): Required. 
+     *
+     * https://developer.github.com/v3/gists/#star-a-gist
      **/
     this.star = function(msg, block, callback) {
         var self = this;
@@ -397,6 +411,8 @@ var gists = module.exports = {
      *
      *  - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
      *  - id (String): Required. 
+     *
+     * https://developer.github.com/v3/gists/#unstar-a-gist
      **/
     this.deleteStar = function(msg, block, callback) {
         var self = this;
@@ -442,6 +458,8 @@ var gists = module.exports = {
      *
      *  - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
      *  - id (String): Required. 
+     *
+     * https://developer.github.com/v3/gists/#check-if-a-gist-is-starred
      **/
     this.checkStar = function(msg, block, callback) {
         var self = this;
@@ -487,6 +505,8 @@ var gists = module.exports = {
      *
      *  - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
      *  - id (String): Required. 
+     *
+     * https://developer.github.com/v3/gists/#fork-a-gist
      **/
     this.fork = function(msg, block, callback) {
         var self = this;
@@ -532,6 +552,8 @@ var gists = module.exports = {
      *
      *  - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
      *  - id (String): Required. 
+     *
+     * https://developer.github.com/v3/gists/#unstar-a-gist
      **/
     this.delete = function(msg, block, callback) {
         var self = this;

api/v3.0.0/gitignore.js

@@ -28,6 +28,8 @@ var gitignore = module.exports = {
      *
      *  - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
      *  No other params, simply pass an empty Object literal `{}`
+     *
+     * https://developer.github.com/v3/gitignore/#listing-available-templates
      **/
     this.templates = function(msg, block, callback) {
         var self = this;

api/v3.0.0/issues.js

@@ -35,6 +35,8 @@ var issues = module.exports = {
      *  - since (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
      *  - page (Number): Optional. Page number of the results to fetch. Validation rule: ` ^[0-9]+$ `.
      *  - per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
+     *
+     * https://developer.github.com/v3/issues/#list-issues
      **/
     this.getAll = function(msg, block, callback) {
         var self = this;
@@ -92,6 +94,8 @@ var issues = module.exports = {
      *  - since (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
      *  - page (Number): Optional. Page number of the results to fetch. Validation rule: ` ^[0-9]+$ `.
      *  - per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
+     *
+     * https://developer.github.com/v3/issues/#list-issues-for-a-repository
      **/
     this.repoIssues = function(msg, block, callback) {
         var self = this;
@@ -139,6 +143,8 @@ var issues = module.exports = {
      *  - user (String): Required. 
      *  - repo (String): Required. 
      *  - number (Number): Required.  Validation rule: ` ^[0-9]+$ `.
+     *
+     * https://developer.github.com/v3/issues/#get-a-single-issue
      **/
     this.getRepoIssue = function(msg, block, callback) {
         var self = this;
@@ -190,6 +196,8 @@ var issues = module.exports = {
      *  - assignee (String): Optional. Login for the user that this issue should be assigned to.
      *  - milestone (Number): Optional. Milestone to associate this issue with. Validation rule: ` ^[0-9]+$ `.
      *  - labels (Json): Optional. Array of strings - Labels to associate with this issue.
+     *
+     * https://developer.github.com/v3/issues/#create-an-issue
      **/
     this.create = function(msg, block, callback) {
         var self = this;
@@ -243,6 +251,8 @@ var issues = module.exports = {
      *  - milestone (Number): Optional. Milestone to associate this issue with. Validation rule: ` ^[0-9]+$ `.
      *  - labels (Json): Optional. Array of strings - Labels to associate with this issue.
      *  - state (String): Optional. open or closed Validation rule: ` ^(open|closed)$ `.
+     *
+     * https://developer.github.com/v3/issues/#edit-an-issue
      **/
     this.edit = function(msg, block, callback) {
         var self = this;

api/v3.0.0/markdown.js

@@ -30,6 +30,8 @@ var markdown = module.exports = {
      *  - text (String): Required. The Markdown text to render
      *  - mode (String): Optional. The rendering mode, `markdown` to render a document as plain Markdown, just like README files are rendered. `gfm` to render a document as user-content, e.g. like user comments or issues are rendered. In GFM mode, hard line breaks are always taken into account, and issue and user mentions are linked accordingly. Validation rule: ` ^(markdown|gfm)$ `.
      *  - context (String): Optional. The repository context, only taken into account when rendering as `gfm`
+     *
+     * https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document
      **/
     this.render = function(msg, block, callback) {
         var self = this;
@@ -75,6 +77,8 @@ var markdown = module.exports = {
      *
      *  - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
      *  - data (String): Required. Raw data to send as the body of the request
+     *
+     * https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode
      **/
     this.renderRaw = function(msg, block, callback) {
         var self = this;

api/v3.0.0/orgs.js

@@ -77,6 +77,8 @@ var orgs = module.exports = {
      *  - org (String): Required. 
      *  - page (Number): Optional. Page number of the results to fetch. Validation rule: ` ^[0-9]+$ `.
      *  - per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
+     *
+     * https://developer.github.com/v3/orgs/#get-an-organization
      **/
     this.get = function(msg, block, callback) {
         var self = this;
@@ -127,6 +129,8 @@ var orgs = module.exports = {
      *  - email (String): Optional. Publicly visible email address.
      *  - location (String): Optional. 
      *  - name (String): Optional. 
+     *
+     * https://developer.github.com/v3/orgs/#edit-an-organization
      **/
     this.update = function(msg, block, callback) {
         var self = this;

api/v3.0.0/pullRequests.js

@@ -36,6 +36,8 @@ var pullRequests = module.exports = {
      *  - per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
      *  - sort (String): Optional. Possible values are: `created`, `updated`, `popularity`, `long-running`, Default: `created` Validation rule: ` ^(created|updated|popularity|long-running)$ `.
      *  - direction (String): Optional.  Validation rule: ` ^(asc|desc)$ `.
+     *
+     * https://developer.github.com/v3/pulls/#list-pull-requests
      **/
     this.getAll = function(msg, block, callback) {
         var self = this;
@@ -83,6 +85,8 @@ var pullRequests = module.exports = {
      *  - user (String): Required. 
      *  - repo (String): Required. 
      *  - number (Number): Required.  Validation rule: ` ^[0-9]+$ `.
+     *
+     * https://developer.github.com/v3/pulls/#get-a-single-pull-request
      **/
     this.get = function(msg, block, callback) {
         var self = this;
@@ -133,6 +137,8 @@ var pullRequests = module.exports = {
      *  - body (String): Optional. 
      *  - base (String): Required. The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo.
      *  - head (String): Required. The branch (or git ref) where your changes are implemented.
+     *
+     * https://developer.github.com/v3/pulls/#create-a-pull-request
      **/
     this.create = function(msg, block, callback) {
         var self = this;
@@ -182,6 +188,8 @@ var pullRequests = module.exports = {
      *  - issue (Number): Required.  Validation rule: ` ^[0-9]+$ `.
      *  - base (String): Required. The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo.
      *  - head (String): Required. The branch (or git ref) where your changes are implemented.
+     *
+     * https://developer.github.com/v3/pulls/#create-a-pull-request
      **/
     this.createFromIssue = function(msg, block, callback) {
         var self = this;
@@ -232,6 +240,8 @@ var pullRequests = module.exports = {
      *  - state (String): Optional.  Validation rule: ` ^(open|closed)$ `.
      *  - title (String): Required. 
      *  - body (String): Optional. 
+     *
+     * https://developer.github.com/v3/pulls/#update-a-pull-request
      **/
     this.update = function(msg, block, callback) {
         var self = this;
@@ -281,6 +291,8 @@ var pullRequests = module.exports = {
      *  - number (Number): Required.  Validation rule: ` ^[0-9]+$ `.
      *  - page (Number): Optional. Page number of the results to fetch. Validation rule: ` ^[0-9]+$ `.
      *  - per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
+     *
+     * https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request
      **/
     this.getCommits = function(msg, block, callback) {
         var self = this;
@@ -330,6 +342,8 @@ var pullRequests = module.exports = {
      *  - number (Number): Required.  Validation rule: ` ^[0-9]+$ `.
      *  - page (Number): Optional. Page number of the results to fetch. Validation rule: ` ^[0-9]+$ `.
      *  - per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
+     *
+     * https://developer.github.com/v3/pulls/#list-pull-requests-files
      **/
     this.getFiles = function(msg, block, callback) {
         var self = this;
@@ -379,6 +393,8 @@ var pullRequests = module.exports = {
      *  - number (Number): Required.  Validation rule: ` ^[0-9]+$ `.
      *  - page (Number): Optional. Page number of the results to fetch. Validation rule: ` ^[0-9]+$ `.
      *  - per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
+     *
+     * https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged
      **/
     this.getMerged = function(msg, block, callback) {
         var self = this;
@@ -427,6 +443,8 @@ var pullRequests = module.exports = {
      *  - repo (String): Required. 
      *  - number (Number): Required.  Validation rule: ` ^[0-9]+$ `.
      *  - commit_message (String): Optional. The message that will be used for the merge commit
+     *
+     * https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button
      **/
     this.merge = function(msg, block, callback) {
         var self = this;