Skip to content

Commit

Permalink
add/edit preview note for preview endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
Joe Gallo committed Jun 22, 2016
1 parent 0176891 commit 7fb3a84
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 42 deletions.
42 changes: 21 additions & 21 deletions doc/apidoc.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@ github.authorization.delete({ ... });
/**
* @api {delete} /applications/grants/:id deleteGrant
* @apiName deleteGrant
* @apiDescription Delete a grant. In preview period. See README.
* @apiDescription Delete a grant. (In preview period. See README.)
* @apiGroup authorization
*
* @apiParam {String} id
Expand Down Expand Up @@ -482,7 +482,7 @@ github.authorization.getAll({ ... });
/**
* @api {get} /applications/grants/:id getGrant
* @apiName getGrant
* @apiDescription Get a single grant. In preview period. See README.
* @apiDescription Get a single grant. (In preview period. See README.)
* @apiGroup authorization
*
* @apiParam {String} id
Expand All @@ -495,7 +495,7 @@ github.authorization.getGrant({ ... });
/**
* @api {get} /applications/grants getGrants
* @apiName getGrants
* @apiDescription List your grants. In preview period. See README.
* @apiDescription List your grants. (In preview period. See README.)
* @apiGroup authorization
*
* @apiParam {Number} [page] Page number of the results to fetch.
Expand Down Expand Up @@ -1131,7 +1131,7 @@ github.issues.checkAssignee({ ... });
* @apiParam {String} [assignee] Login for the user that this issue should be assigned to.
* @apiParam {Number} [milestone] Milestone to associate this issue with.
* @apiParam {Json} [labels] Array of strings - Labels to associate with this issue.
* @apiParam {Array} [assignees] Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise. In preview period. See README.
* @apiParam {Array} [assignees] Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise. (In preview period. See README.)
* @apiExample {js} ex:
github.issues.create({ ... });
*/
Expand Down Expand Up @@ -1234,7 +1234,7 @@ github.issues.deleteMilestone({ ... });
* @apiParam {String} [state=open] open or closed
* @apiParam {Number} [milestone] Milestone to associate this issue with.
* @apiParam {Json} [labels] Array of strings - Labels to associate with this issue.
* @apiParam {Array} [assignees] Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. .Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise. In preview period. See README.
* @apiParam {Array} [assignees] Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. .Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise. (In preview period. See README.)
* @apiExample {js} ex:
github.issues.edit({ ... });
*/
Expand Down Expand Up @@ -1386,7 +1386,7 @@ github.issues.getEventsForRepo({ ... });
/**
* @api {get} /repos/:user/:repo/issues/:number/timeline getEventsTimeline
* @apiName getEventsTimeline
* @apiDescription List events for an issue. In preview period. See README.
* @apiDescription List events for an issue. (In preview period. See README.)
* @apiGroup issues
*
* @apiParam {String} user
Expand Down Expand Up @@ -2482,8 +2482,8 @@ github.pullRequests.getFiles({ ... });
* @apiParam {Number} number
* @apiParam {String} [commit_message] Extra detail to append to automatic commit message.
* @apiParam {String} [sha] SHA that pull request head must match to allow merge
* @apiParam {String} [commit_title] Title for the automatic commit message. In preview period. See README.
* @apiParam {Boolean} [squash] Commit a single commit to the head branch. In preview period. See README.
* @apiParam {String} [commit_title] Title for the automatic commit message. (In preview period. See README.)
* @apiParam {Boolean} [squash] Commit a single commit to the head branch. (In preview period. See README.)
* @apiExample {js} ex:
github.pullRequests.merge({ ... });
*/
Expand All @@ -2507,7 +2507,7 @@ github.pullRequests.update({ ... });
/**
* @api {post} /repos/:user/:repo/comments/:id/reactions createForCommitComment
* @apiName createForCommitComment
* @apiDescription Create reaction for a commit comment. In preview period. See README.
* @apiDescription Create reaction for a commit comment. (In preview period. See README.)
* @apiGroup reactions
*
* @apiParam {String} user
Expand All @@ -2521,7 +2521,7 @@ github.reactions.createForCommitComment({ ... });
/**
* @api {post} /repos/:user/:repo/issues/:number/reactions createForIssue
* @apiName createForIssue
* @apiDescription Create reaction for an issue. In preview period. See README.
* @apiDescription Create reaction for an issue. (In preview period. See README.)
* @apiGroup reactions
*
* @apiParam {String} user
Expand All @@ -2535,7 +2535,7 @@ github.reactions.createForIssue({ ... });
/**
* @api {post} /repos/:user/:repo/issues/comments/:id/reactions createForIssueComment
* @apiName createForIssueComment
* @apiDescription Create reaction for an issue comment. In preview period. See README.
* @apiDescription Create reaction for an issue comment. (In preview period. See README.)
* @apiGroup reactions
*
* @apiParam {String} user
Expand All @@ -2549,7 +2549,7 @@ github.reactions.createForIssueComment({ ... });
/**
* @api {post} /repos/:user/:repo/pulls/comments/:id/reactions createForPullRequestReviewComment
* @apiName createForPullRequestReviewComment
* @apiDescription Create reaction for a pull request review comment. In preview period. See README.
* @apiDescription Create reaction for a pull request review comment. (In preview period. See README.)
* @apiGroup reactions
*
* @apiParam {String} user
Expand All @@ -2563,7 +2563,7 @@ github.reactions.createForPullRequestReviewComment({ ... });
/**
* @api {delete} /reactions/:id delete
* @apiName delete
* @apiDescription Delete a reaction. In preview period. See README.
* @apiDescription Delete a reaction. (In preview period. See README.)
* @apiGroup reactions
*
* @apiParam {String} id
Expand All @@ -2574,7 +2574,7 @@ github.reactions.delete({ ... });
/**
* @api {get} /repos/:user/:repo/comments/:id/reactions getForCommitComment
* @apiName getForCommitComment
* @apiDescription List reactions for a commit comment. In preview period. See README.
* @apiDescription List reactions for a commit comment. (In preview period. See README.)
* @apiGroup reactions
*
* @apiParam {String} user
Expand All @@ -2588,7 +2588,7 @@ github.reactions.getForCommitComment({ ... });
/**
* @api {get} /repos/:user/:repo/issues/:number/reactions getForIssue
* @apiName getForIssue
* @apiDescription List reactions for an issue. In preview period. See README.
* @apiDescription List reactions for an issue. (In preview period. See README.)
* @apiGroup reactions
*
* @apiParam {String} user
Expand All @@ -2602,7 +2602,7 @@ github.reactions.getForIssue({ ... });
/**
* @api {get} /repos/:user/:repo/issues/comments/:id/reactions getForIssueComment
* @apiName getForIssueComment
* @apiDescription List reactions for an issue comment. In preview period. See README.
* @apiDescription List reactions for an issue comment. (In preview period. See README.)
* @apiGroup reactions
*
* @apiParam {String} user
Expand All @@ -2616,7 +2616,7 @@ github.reactions.getForIssueComment({ ... });
/**
* @api {get} /repos/:user/:repo/pulls/comments/:id/reactions getForPullRequestReviewComment
* @apiName getForPullRequestReviewComment
* @apiDescription List reactions for a pull request review comment. In preview period. See README.
* @apiDescription List reactions for a pull request review comment. (In preview period. See README.)
* @apiGroup reactions
*
* @apiParam {String} user
Expand Down Expand Up @@ -3890,7 +3890,7 @@ github.users.checkIfOneFollowersOther({ ... });
/**
* @api {post} /user/gpg_keys createGpgKey
* @apiName createGpgKey
* @apiDescription Create a GPG key
* @apiDescription Create a GPG key. (In preview period. See README.)
* @apiGroup users
*
* @apiParam {String} armored_public_key GPG key contents
Expand Down Expand Up @@ -3924,7 +3924,7 @@ github.users.deleteEmails({ ... });
/**
* @api {delete} /user/gpg_keys/:id deleteGpgKey
* @apiName deleteGpgKey
* @apiDescription Delete a GPG key
* @apiDescription Delete a GPG key. (In preview period. See README.)
* @apiGroup users
*
* @apiParam {String} id
Expand Down Expand Up @@ -4085,7 +4085,7 @@ github.users.getForUser({ ... });
/**
* @api {get} /user/gpg_keys/:id getGpgKey
* @apiName getGpgKey
* @apiDescription Get a single GPG key
* @apiDescription Get a single GPG key. (In preview period. See README.)
* @apiGroup users
*
* @apiParam {String} id
Expand All @@ -4096,7 +4096,7 @@ github.users.getGpgKey({ ... });
/**
* @api {get} /user/gpg_keys getGpgKeys
* @apiName getGpgKeys
* @apiDescription List your GPG keys
* @apiDescription List your GPG keys. (In preview period. See README.)
* @apiGroup users
*
* @apiParam {Number} [page] Page number of the results to fetch.
Expand Down
42 changes: 21 additions & 21 deletions lib/routes.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,7 @@
"$page": null,
"$per_page": null
},
"description": "List your grants. In preview period. See README."
"description": "List your grants. (In preview period. See README.)"
},

"get-grant": {
Expand All @@ -434,7 +434,7 @@
"$page": null,
"$per_page": null
},
"description": "Get a single grant. In preview period. See README."
"description": "Get a single grant. (In preview period. See README.)"
},

"delete-grant": {
Expand All @@ -443,7 +443,7 @@
"params": {
"$id": null
},
"description": "Delete a grant. In preview period. See README."
"description": "Delete a grant. (In preview period. See README.)"
},

"get-all": {
Expand Down Expand Up @@ -1740,7 +1740,7 @@
"required": false,
"validation": "",
"invalidmsg": "",
"description": "Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise. In preview period. See README."
"description": "Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise. (In preview period. See README.)"
}
},
"description": "Create an issue"
Expand Down Expand Up @@ -1801,7 +1801,7 @@
"required": false,
"validation": "",
"invalidmsg": "",
"description": "Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. .Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise. In preview period. See README."
"description": "Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. .Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise. (In preview period. See README.)"
}
},
"description": "Edit an issue"
Expand Down Expand Up @@ -1972,7 +1972,7 @@
"$page": null,
"$per_page": null
},
"description": "List events for an issue. In preview period. See README."
"description": "List events for an issue. (In preview period. See README.)"
},

"get-events-for-repo": {
Expand Down Expand Up @@ -3154,14 +3154,14 @@
"required": false,
"validation": "",
"invalidmsg": "",
"description": "Title for the automatic commit message. In preview period. See README."
"description": "Title for the automatic commit message. (In preview period. See README.)"
},
"squash": {
"type": "Boolean",
"required": false,
"validation": "",
"invalidmsg": "",
"description": "Commit a single commit to the head branch. In preview period. See README."
"description": "Commit a single commit to the head branch. (In preview period. See README.)"
}
},
"description": "Merge a pull request (Merge Button)"
Expand Down Expand Up @@ -3287,7 +3287,7 @@
"description": "Indicates which type of reaction to return."
}
},
"description": "List reactions for a commit comment. In preview period. See README."
"description": "List reactions for a commit comment. (In preview period. See README.)"
},

"create-for-commit-comment": {
Expand All @@ -3305,7 +3305,7 @@
"description": "The reaction type."
}
},
"description": "Create reaction for a commit comment. In preview period. See README."
"description": "Create reaction for a commit comment. (In preview period. See README.)"
},

"get-for-issue": {
Expand All @@ -3323,7 +3323,7 @@
"description": "Indicates which type of reaction to return."
}
},
"description": "List reactions for an issue. In preview period. See README."
"description": "List reactions for an issue. (In preview period. See README.)"
},

"create-for-issue": {
Expand All @@ -3341,7 +3341,7 @@
"description": "The reaction type."
}
},
"description": "Create reaction for an issue. In preview period. See README."
"description": "Create reaction for an issue. (In preview period. See README.)"
},

"get-for-issue-comment": {
Expand All @@ -3359,7 +3359,7 @@
"description": "Indicates which type of reaction to return."
}
},
"description": "List reactions for an issue comment. In preview period. See README."
"description": "List reactions for an issue comment. (In preview period. See README.)"
},

"create-for-issue-comment": {
Expand All @@ -3377,7 +3377,7 @@
"description": "The reaction type."
}
},
"description": "Create reaction for an issue comment. In preview period. See README."
"description": "Create reaction for an issue comment. (In preview period. See README.)"
},

"get-for-pull-request-review-comment": {
Expand All @@ -3395,7 +3395,7 @@
"description": "Indicates which type of reaction to return."
}
},
"description": "List reactions for a pull request review comment. In preview period. See README."
"description": "List reactions for a pull request review comment. (In preview period. See README.)"
},

"create-for-pull-request-review-comment": {
Expand All @@ -3413,7 +3413,7 @@
"description": "The reaction type."
}
},
"description": "Create reaction for a pull request review comment. In preview period. See README."
"description": "Create reaction for a pull request review comment. (In preview period. See README.)"
},

"delete": {
Expand All @@ -3422,7 +3422,7 @@
"params": {
"$id": null
},
"description": "Delete a reaction. In preview period. See README."
"description": "Delete a reaction. (In preview period. See README.)"
}
},

Expand Down Expand Up @@ -5373,7 +5373,7 @@
"$page": null,
"$per_page": null
},
"description": "List your GPG keys"
"description": "List your GPG keys. (In preview period. See README.)"
},

"get-gpg-key": {
Expand All @@ -5382,7 +5382,7 @@
"params": {
"$id": null
},
"description": "Get a single GPG key"
"description": "Get a single GPG key. (In preview period. See README.)"
},

"create-gpg-key": {
Expand All @@ -5397,7 +5397,7 @@
"description": "GPG key contents"
}
},
"description": "Create a GPG key"
"description": "Create a GPG key. (In preview period. See README.)"
},

"delete-gpg-key": {
Expand All @@ -5406,7 +5406,7 @@
"params": {
"$id": null
},
"description": "Delete a GPG key"
"description": "Delete a GPG key. (In preview period. See README.)"
},

"promote": {
Expand Down

0 comments on commit 7fb3a84

Please sign in to comment.