@octokit/plugin-enterprise-rest - npm Package Compare versions

Comparing version 3.0.0 to 3.1.0

ghe-2.14/README.md

@@ -160,7 +160,7 @@ # @octokit/plugin-enterprise-rest/ghe-2.14
 octokit.gitignore.listTemplates()
-octokit.issues.addAssignees(assignees, number, owner, repo)
-octokit.issues.addLabels(labels, number, owner, repo)
+octokit.issues.addAssignees(assignees, issue_number, owner, repo)
+octokit.issues.addLabels(issue_number, labels, owner, repo)
 octokit.issues.checkAssignee(assignee, owner, repo)
 octokit.issues.create(assignee, assignees, body, labels, milestone, owner, repo, title)
-octokit.issues.createComment(body, number, owner, repo)
+octokit.issues.createComment(body, issue_number, owner, repo)
 octokit.issues.createLabel(color, description, name, owner, repo)
@@ -170,32 +170,32 @@ octokit.issues.createMilestone(description, due_on, owner, repo, state, title)
 octokit.issues.deleteLabel(name, owner, repo)
-octokit.issues.deleteMilestone(number, owner, repo)
-octokit.issues.get(number, owner, repo)
+octokit.issues.deleteMilestone(milestone_number, owner, repo)
+octokit.issues.get(issue_number, owner, repo)
 octokit.issues.getComment(comment_id, owner, page, per_page, repo)
 octokit.issues.getEvent(event_id, owner, repo)
 octokit.issues.getLabel(name, owner, repo)
-octokit.issues.getMilestone(number, owner, repo)
+octokit.issues.getMilestone(milestone_number, owner, repo)
 octokit.issues.list(direction, filter, labels, page, per_page, since, sort, state)
 octokit.issues.listAssignees(owner, page, per_page, repo)
-octokit.issues.listComments(number, owner, page, per_page, repo, since)
+octokit.issues.listComments(issue_number, owner, page, per_page, repo, since)
 octokit.issues.listCommentsForRepo(direction, owner, repo, since, sort)
-octokit.issues.listEvents(number, owner, page, per_page, repo)
+octokit.issues.listEvents(issue_number, owner, page, per_page, repo)
 octokit.issues.listEventsForRepo(owner, page, per_page, repo)
-octokit.issues.listEventsForTimeline(number, owner, page, per_page, repo)
+octokit.issues.listEventsForTimeline(issue_number, owner, page, per_page, repo)
 octokit.issues.listForAuthenticatedUser(direction, filter, labels, page, per_page, since, sort, state)
 octokit.issues.listForOrg(direction, filter, labels, org, page, per_page, since, sort, state)
 octokit.issues.listForRepo(assignee, creator, direction, labels, mentioned, milestone, owner, page, per_page, repo, since, sort, state)
-octokit.issues.listLabelsForMilestone(number, owner, page, per_page, repo)
+octokit.issues.listLabelsForMilestone(milestone_number, owner, page, per_page, repo)
 octokit.issues.listLabelsForRepo(owner, page, per_page, repo)
-octokit.issues.listLabelsOnIssue(number, owner, page, per_page, repo)
+octokit.issues.listLabelsOnIssue(issue_number, owner, page, per_page, repo)
 octokit.issues.listMilestonesForRepo(direction, owner, page, per_page, repo, sort, state)
-octokit.issues.lock(lock_reason, number, owner, repo)
-octokit.issues.removeAssignees(assignees, number, owner, repo)
-octokit.issues.removeLabel(name, number, owner, repo)
-octokit.issues.removeLabels(number, owner, repo)
-octokit.issues.replaceLabels(labels, number, owner, repo)
-octokit.issues.unlock(number, owner, repo)
-octokit.issues.update(assignee, assignees, body, labels, milestone, number, owner, repo, state, title)
+octokit.issues.lock(issue_number, lock_reason, owner, repo)
+octokit.issues.removeAssignees(assignees, issue_number, owner, repo)
+octokit.issues.removeLabel(issue_number, name, owner, repo)
+octokit.issues.removeLabels(issue_number, owner, repo)
+octokit.issues.replaceLabels(issue_number, labels, owner, repo)
+octokit.issues.unlock(issue_number, owner, repo)
+octokit.issues.update(assignee, assignees, body, issue_number, labels, milestone, owner, repo, state, title)
 octokit.issues.updateComment(body, comment_id, owner, repo)
 octokit.issues.updateLabel(color, current_name, description, name, owner, repo)
-octokit.issues.updateMilestone(description, due_on, number, owner, repo, state, title)
+octokit.issues.updateMilestone(description, due_on, milestone_number, owner, repo, state, title)
 octokit.licenses.get(license)
@@ -273,31 +273,31 @@ octokit.licenses.getForRepo(owner, repo)
 octokit.projects.updateColumn(column_id, name)
-octokit.pulls.checkIfMerged(number, owner, repo)
+octokit.pulls.checkIfMerged(owner, pull_number, repo)
 octokit.pulls.create(base, body, head, maintainer_can_modify, owner, repo, title)
-octokit.pulls.createComment(body, commit_id, number, owner, path, position, repo)
-octokit.pulls.createCommentReply(body, in_reply_to, number, owner, repo)
+octokit.pulls.createComment(body, commit_id, owner, path, position, pull_number, repo)
+octokit.pulls.createCommentReply(body, in_reply_to, owner, pull_number, repo)
 octokit.pulls.createFromIssue(base, head, issue, maintainer_can_modify, owner, repo)
-octokit.pulls.createReview(body, comments, commit_id, event, number, owner, repo)
-octokit.pulls.createReviewRequest(number, owner, repo, reviewers, team_reviewers)
+octokit.pulls.createReview(body, comments, commit_id, event, owner, pull_number, repo)
+octokit.pulls.createReviewRequest(owner, pull_number, repo, reviewers, team_reviewers)
 octokit.pulls.deleteComment(comment_id, owner, repo)
-octokit.pulls.deletePendingReview(number, owner, repo, review_id)
-octokit.pulls.deleteReviewRequest(number, owner, repo, reviewers, team_reviewers)
-octokit.pulls.dismissReview(message, number, owner, repo, review_id)
-octokit.pulls.get(number, owner, repo)
+octokit.pulls.deletePendingReview(owner, pull_number, repo, review_id)
+octokit.pulls.deleteReviewRequest(owner, pull_number, repo, reviewers, team_reviewers)
+octokit.pulls.dismissReview(message, owner, pull_number, repo, review_id)
+octokit.pulls.get(owner, pull_number, repo)
 octokit.pulls.getComment(comment_id, owner, repo)
-octokit.pulls.getCommentsForReview(number, owner, page, per_page, repo, review_id)
-octokit.pulls.getReview(number, owner, repo, review_id)
+octokit.pulls.getCommentsForReview(owner, page, per_page, pull_number, repo, review_id)
+octokit.pulls.getReview(owner, pull_number, repo, review_id)
 octokit.pulls.list(base, direction, head, owner, page, per_page, repo, sort, state)
-octokit.pulls.listComments(direction, number, owner, page, per_page, repo, since, sort)
+octokit.pulls.listComments(direction, owner, page, per_page, pull_number, repo, since, sort)
 octokit.pulls.listCommentsForRepo(direction, owner, page, per_page, repo, since, sort)
-octokit.pulls.listCommits(number, owner, page, per_page, repo)
-octokit.pulls.listFiles(number, owner, page, per_page, repo)
-octokit.pulls.listReviewRequests(number, owner, page, per_page, repo)
-octokit.pulls.listReviews(number, owner, page, per_page, repo)
-octokit.pulls.merge(commit_message, commit_title, merge_method, number, owner, repo, sha)
-octokit.pulls.submitReview(body, event, number, owner, repo, review_id)
-octokit.pulls.update(base, body, maintainer_can_modify, number, owner, repo, state, title)
+octokit.pulls.listCommits(owner, page, per_page, pull_number, repo)
+octokit.pulls.listFiles(owner, page, per_page, pull_number, repo)
+octokit.pulls.listReviewRequests(owner, page, per_page, pull_number, repo)
+octokit.pulls.listReviews(owner, page, per_page, pull_number, repo)
+octokit.pulls.merge(commit_message, commit_title, merge_method, owner, pull_number, repo, sha)
+octokit.pulls.submitReview(body, event, owner, pull_number, repo, review_id)
+octokit.pulls.update(base, body, maintainer_can_modify, owner, pull_number, repo, state, title)
 octokit.pulls.updateComment(body, comment_id, owner, repo)
 octokit.rateLimit.get()
 octokit.reactions.createForCommitComment(comment_id, content, owner, repo)
-octokit.reactions.createForIssue(content, number, owner, repo)
+octokit.reactions.createForIssue(content, issue_number, owner, repo)
 octokit.reactions.createForIssueComment(comment_id, content, owner, repo)
@@ -309,3 +309,3 @@ octokit.reactions.createForPullRequestReviewComment(comment_id, content, owner, repo)
 octokit.reactions.listForCommitComment(comment_id, content, owner, page, per_page, repo)
-octokit.reactions.listForIssue(content, number, owner, page, per_page, repo)
+octokit.reactions.listForIssue(content, issue_number, owner, page, per_page, repo)
 octokit.reactions.listForIssueComment(comment_id, content, owner, page, per_page, repo)
@@ -351,3 +351,3 @@ octokit.reactions.listForPullRequestReviewComment(comment_id, content, owner, page, per_page, repo)
 octokit.repos.getCombinedStatusForRef(owner, ref, repo)
-octokit.repos.getCommit(owner, repo, sha)
+octokit.repos.getCommit(commit_sha, owner, repo)
 octokit.repos.getCommitActivityStats(owner, repo)
@@ -354,0 +354,0 @@ octokit.repos.getCommitComment(comment_id, owner, repo)

ghe-2.15/README.md

@@ -160,7 +160,7 @@ # @octokit/plugin-enterprise-rest/ghe-2.15
 octokit.gitignore.listTemplates()
-octokit.issues.addAssignees(assignees, number, owner, repo)
-octokit.issues.addLabels(labels, number, owner, repo)
+octokit.issues.addAssignees(assignees, issue_number, owner, repo)
+octokit.issues.addLabels(issue_number, labels, owner, repo)
 octokit.issues.checkAssignee(assignee, owner, repo)
 octokit.issues.create(assignee, assignees, body, labels, milestone, owner, repo, title)
-octokit.issues.createComment(body, number, owner, repo)
+octokit.issues.createComment(body, issue_number, owner, repo)
 octokit.issues.createLabel(color, description, name, owner, repo)
@@ -170,32 +170,32 @@ octokit.issues.createMilestone(description, due_on, owner, repo, state, title)
 octokit.issues.deleteLabel(name, owner, repo)
-octokit.issues.deleteMilestone(number, owner, repo)
-octokit.issues.get(number, owner, repo)
+octokit.issues.deleteMilestone(milestone_number, owner, repo)
+octokit.issues.get(issue_number, owner, repo)
 octokit.issues.getComment(comment_id, owner, page, per_page, repo)
 octokit.issues.getEvent(event_id, owner, repo)
 octokit.issues.getLabel(name, owner, repo)
-octokit.issues.getMilestone(number, owner, repo)
+octokit.issues.getMilestone(milestone_number, owner, repo)
 octokit.issues.list(direction, filter, labels, page, per_page, since, sort, state)
 octokit.issues.listAssignees(owner, page, per_page, repo)
-octokit.issues.listComments(number, owner, page, per_page, repo, since)
+octokit.issues.listComments(issue_number, owner, page, per_page, repo, since)
 octokit.issues.listCommentsForRepo(direction, owner, repo, since, sort)
-octokit.issues.listEvents(number, owner, page, per_page, repo)
+octokit.issues.listEvents(issue_number, owner, page, per_page, repo)
 octokit.issues.listEventsForRepo(owner, page, per_page, repo)
-octokit.issues.listEventsForTimeline(number, owner, page, per_page, repo)
+octokit.issues.listEventsForTimeline(issue_number, owner, page, per_page, repo)
 octokit.issues.listForAuthenticatedUser(direction, filter, labels, page, per_page, since, sort, state)
 octokit.issues.listForOrg(direction, filter, labels, org, page, per_page, since, sort, state)
 octokit.issues.listForRepo(assignee, creator, direction, labels, mentioned, milestone, owner, page, per_page, repo, since, sort, state)
-octokit.issues.listLabelsForMilestone(number, owner, page, per_page, repo)
+octokit.issues.listLabelsForMilestone(milestone_number, owner, page, per_page, repo)
 octokit.issues.listLabelsForRepo(owner, page, per_page, repo)
-octokit.issues.listLabelsOnIssue(number, owner, page, per_page, repo)
+octokit.issues.listLabelsOnIssue(issue_number, owner, page, per_page, repo)
 octokit.issues.listMilestonesForRepo(direction, owner, page, per_page, repo, sort, state)
-octokit.issues.lock(lock_reason, number, owner, repo)
-octokit.issues.removeAssignees(assignees, number, owner, repo)
-octokit.issues.removeLabel(name, number, owner, repo)
-octokit.issues.removeLabels(number, owner, repo)
-octokit.issues.replaceLabels(labels, number, owner, repo)
-octokit.issues.unlock(number, owner, repo)
-octokit.issues.update(assignee, assignees, body, labels, milestone, number, owner, repo, state, title)
+octokit.issues.lock(issue_number, lock_reason, owner, repo)
+octokit.issues.removeAssignees(assignees, issue_number, owner, repo)
+octokit.issues.removeLabel(issue_number, name, owner, repo)
+octokit.issues.removeLabels(issue_number, owner, repo)
+octokit.issues.replaceLabels(issue_number, labels, owner, repo)
+octokit.issues.unlock(issue_number, owner, repo)
+octokit.issues.update(assignee, assignees, body, issue_number, labels, milestone, owner, repo, state, title)
 octokit.issues.updateComment(body, comment_id, owner, repo)
 octokit.issues.updateLabel(color, current_name, description, name, owner, repo)
-octokit.issues.updateMilestone(description, due_on, number, owner, repo, state, title)
+octokit.issues.updateMilestone(description, due_on, milestone_number, owner, repo, state, title)
 octokit.licenses.get(license)
@@ -273,31 +273,31 @@ octokit.licenses.getForRepo(owner, repo)
 octokit.projects.updateColumn(column_id, name)
-octokit.pulls.checkIfMerged(number, owner, repo)
+octokit.pulls.checkIfMerged(owner, pull_number, repo)
 octokit.pulls.create(base, body, head, maintainer_can_modify, owner, repo, title)
-octokit.pulls.createComment(body, commit_id, number, owner, path, position, repo)
-octokit.pulls.createCommentReply(body, in_reply_to, number, owner, repo)
+octokit.pulls.createComment(body, commit_id, owner, path, position, pull_number, repo)
+octokit.pulls.createCommentReply(body, in_reply_to, owner, pull_number, repo)
 octokit.pulls.createFromIssue(base, head, issue, maintainer_can_modify, owner, repo)
-octokit.pulls.createReview(body, comments, commit_id, event, number, owner, repo)
-octokit.pulls.createReviewRequest(number, owner, repo, reviewers, team_reviewers)
+octokit.pulls.createReview(body, comments, commit_id, event, owner, pull_number, repo)
+octokit.pulls.createReviewRequest(owner, pull_number, repo, reviewers, team_reviewers)
 octokit.pulls.deleteComment(comment_id, owner, repo)
-octokit.pulls.deletePendingReview(number, owner, repo, review_id)
-octokit.pulls.deleteReviewRequest(number, owner, repo, reviewers, team_reviewers)
-octokit.pulls.dismissReview(message, number, owner, repo, review_id)
-octokit.pulls.get(number, owner, repo)
+octokit.pulls.deletePendingReview(owner, pull_number, repo, review_id)
+octokit.pulls.deleteReviewRequest(owner, pull_number, repo, reviewers, team_reviewers)
+octokit.pulls.dismissReview(message, owner, pull_number, repo, review_id)
+octokit.pulls.get(owner, pull_number, repo)
 octokit.pulls.getComment(comment_id, owner, repo)
-octokit.pulls.getCommentsForReview(number, owner, page, per_page, repo, review_id)
-octokit.pulls.getReview(number, owner, repo, review_id)
+octokit.pulls.getCommentsForReview(owner, page, per_page, pull_number, repo, review_id)
+octokit.pulls.getReview(owner, pull_number, repo, review_id)
 octokit.pulls.list(base, direction, head, owner, page, per_page, repo, sort, state)
-octokit.pulls.listComments(direction, number, owner, page, per_page, repo, since, sort)
+octokit.pulls.listComments(direction, owner, page, per_page, pull_number, repo, since, sort)
 octokit.pulls.listCommentsForRepo(direction, owner, page, per_page, repo, since, sort)
-octokit.pulls.listCommits(number, owner, page, per_page, repo)
-octokit.pulls.listFiles(number, owner, page, per_page, repo)
-octokit.pulls.listReviewRequests(number, owner, page, per_page, repo)
-octokit.pulls.listReviews(number, owner, page, per_page, repo)
-octokit.pulls.merge(commit_message, commit_title, merge_method, number, owner, repo, sha)
-octokit.pulls.submitReview(body, event, number, owner, repo, review_id)
-octokit.pulls.update(base, body, maintainer_can_modify, number, owner, repo, state, title)
+octokit.pulls.listCommits(owner, page, per_page, pull_number, repo)
+octokit.pulls.listFiles(owner, page, per_page, pull_number, repo)
+octokit.pulls.listReviewRequests(owner, page, per_page, pull_number, repo)
+octokit.pulls.listReviews(owner, page, per_page, pull_number, repo)
+octokit.pulls.merge(commit_message, commit_title, merge_method, owner, pull_number, repo, sha)
+octokit.pulls.submitReview(body, event, owner, pull_number, repo, review_id)
+octokit.pulls.update(base, body, maintainer_can_modify, owner, pull_number, repo, state, title)
 octokit.pulls.updateComment(body, comment_id, owner, repo)
 octokit.rateLimit.get()
 octokit.reactions.createForCommitComment(comment_id, content, owner, repo)
-octokit.reactions.createForIssue(content, number, owner, repo)
+octokit.reactions.createForIssue(content, issue_number, owner, repo)
 octokit.reactions.createForIssueComment(comment_id, content, owner, repo)
@@ -309,3 +309,3 @@ octokit.reactions.createForPullRequestReviewComment(comment_id, content, owner, repo)
 octokit.reactions.listForCommitComment(comment_id, content, owner, page, per_page, repo)
-octokit.reactions.listForIssue(content, number, owner, page, per_page, repo)
+octokit.reactions.listForIssue(content, issue_number, owner, page, per_page, repo)
 octokit.reactions.listForIssueComment(comment_id, content, owner, page, per_page, repo)
@@ -351,3 +351,3 @@ octokit.reactions.listForPullRequestReviewComment(comment_id, content, owner, page, per_page, repo)
 octokit.repos.getCombinedStatusForRef(owner, ref, repo)
-octokit.repos.getCommit(owner, repo, sha)
+octokit.repos.getCommit(commit_sha, owner, repo)
 octokit.repos.getCommitActivityStats(owner, repo)
@@ -354,0 +354,0 @@ octokit.repos.getCommitComment(comment_id, owner, repo)

ghe-2.16/README.md

@@ -161,7 +161,7 @@ # @octokit/plugin-enterprise-rest/ghe-2.16
 octokit.gitignore.listTemplates()
-octokit.issues.addAssignees(assignees, number, owner, repo)
-octokit.issues.addLabels(labels, number, owner, repo)
+octokit.issues.addAssignees(assignees, issue_number, owner, repo)
+octokit.issues.addLabels(issue_number, labels, owner, repo)
 octokit.issues.checkAssignee(assignee, owner, repo)
 octokit.issues.create(assignee, assignees, body, labels, milestone, owner, repo, title)
-octokit.issues.createComment(body, number, owner, repo)
+octokit.issues.createComment(body, issue_number, owner, repo)
 octokit.issues.createLabel(color, description, name, owner, repo)
@@ -171,32 +171,32 @@ octokit.issues.createMilestone(description, due_on, owner, repo, state, title)
 octokit.issues.deleteLabel(name, owner, repo)
-octokit.issues.deleteMilestone(number, owner, repo)
-octokit.issues.get(number, owner, repo)
+octokit.issues.deleteMilestone(milestone_number, owner, repo)
+octokit.issues.get(issue_number, owner, repo)
 octokit.issues.getComment(comment_id, owner, page, per_page, repo)
 octokit.issues.getEvent(event_id, owner, repo)
 octokit.issues.getLabel(name, owner, repo)
-octokit.issues.getMilestone(number, owner, repo)
+octokit.issues.getMilestone(milestone_number, owner, repo)
 octokit.issues.list(direction, filter, labels, page, per_page, since, sort, state)
 octokit.issues.listAssignees(owner, page, per_page, repo)
-octokit.issues.listComments(number, owner, page, per_page, repo, since)
+octokit.issues.listComments(issue_number, owner, page, per_page, repo, since)
 octokit.issues.listCommentsForRepo(direction, owner, repo, since, sort)
-octokit.issues.listEvents(number, owner, page, per_page, repo)
+octokit.issues.listEvents(issue_number, owner, page, per_page, repo)
 octokit.issues.listEventsForRepo(owner, page, per_page, repo)
-octokit.issues.listEventsForTimeline(number, owner, page, per_page, repo)
+octokit.issues.listEventsForTimeline(issue_number, owner, page, per_page, repo)
 octokit.issues.listForAuthenticatedUser(direction, filter, labels, page, per_page, since, sort, state)
 octokit.issues.listForOrg(direction, filter, labels, org, page, per_page, since, sort, state)
 octokit.issues.listForRepo(assignee, creator, direction, labels, mentioned, milestone, owner, page, per_page, repo, since, sort, state)
-octokit.issues.listLabelsForMilestone(number, owner, page, per_page, repo)
+octokit.issues.listLabelsForMilestone(milestone_number, owner, page, per_page, repo)
 octokit.issues.listLabelsForRepo(owner, page, per_page, repo)
-octokit.issues.listLabelsOnIssue(number, owner, page, per_page, repo)
+octokit.issues.listLabelsOnIssue(issue_number, owner, page, per_page, repo)
 octokit.issues.listMilestonesForRepo(direction, owner, page, per_page, repo, sort, state)
-octokit.issues.lock(lock_reason, number, owner, repo)
-octokit.issues.removeAssignees(assignees, number, owner, repo)
-octokit.issues.removeLabel(name, number, owner, repo)
-octokit.issues.removeLabels(number, owner, repo)
-octokit.issues.replaceLabels(labels, number, owner, repo)
-octokit.issues.unlock(number, owner, repo)
-octokit.issues.update(assignee, assignees, body, labels, milestone, number, owner, repo, state, title)
+octokit.issues.lock(issue_number, lock_reason, owner, repo)
+octokit.issues.removeAssignees(assignees, issue_number, owner, repo)
+octokit.issues.removeLabel(issue_number, name, owner, repo)
+octokit.issues.removeLabels(issue_number, owner, repo)
+octokit.issues.replaceLabels(issue_number, labels, owner, repo)
+octokit.issues.unlock(issue_number, owner, repo)
+octokit.issues.update(assignee, assignees, body, issue_number, labels, milestone, owner, repo, state, title)
 octokit.issues.updateComment(body, comment_id, owner, repo)
 octokit.issues.updateLabel(color, current_name, description, name, owner, repo)
-octokit.issues.updateMilestone(description, due_on, number, owner, repo, state, title)
+octokit.issues.updateMilestone(description, due_on, milestone_number, owner, repo, state, title)
 octokit.licenses.get(license)
@@ -274,31 +274,31 @@ octokit.licenses.getForRepo(owner, repo)
 octokit.projects.updateColumn(column_id, name)
-octokit.pulls.checkIfMerged(number, owner, repo)
+octokit.pulls.checkIfMerged(owner, pull_number, repo)
 octokit.pulls.create(base, body, head, maintainer_can_modify, owner, repo, title)
-octokit.pulls.createComment(body, commit_id, number, owner, path, position, repo)
-octokit.pulls.createCommentReply(body, in_reply_to, number, owner, repo)
+octokit.pulls.createComment(body, commit_id, owner, path, position, pull_number, repo)
+octokit.pulls.createCommentReply(body, in_reply_to, owner, pull_number, repo)
 octokit.pulls.createFromIssue(base, head, issue, maintainer_can_modify, owner, repo)
-octokit.pulls.createReview(body, comments, commit_id, event, number, owner, repo)
-octokit.pulls.createReviewRequest(number, owner, repo, reviewers, team_reviewers)
+octokit.pulls.createReview(body, comments, commit_id, event, owner, pull_number, repo)
+octokit.pulls.createReviewRequest(owner, pull_number, repo, reviewers, team_reviewers)
 octokit.pulls.deleteComment(comment_id, owner, repo)
-octokit.pulls.deletePendingReview(number, owner, repo, review_id)
-octokit.pulls.deleteReviewRequest(number, owner, repo, reviewers, team_reviewers)
-octokit.pulls.dismissReview(message, number, owner, repo, review_id)
-octokit.pulls.get(number, owner, repo)
+octokit.pulls.deletePendingReview(owner, pull_number, repo, review_id)
+octokit.pulls.deleteReviewRequest(owner, pull_number, repo, reviewers, team_reviewers)
+octokit.pulls.dismissReview(message, owner, pull_number, repo, review_id)
+octokit.pulls.get(owner, pull_number, repo)
 octokit.pulls.getComment(comment_id, owner, repo)
-octokit.pulls.getCommentsForReview(number, owner, page, per_page, repo, review_id)
-octokit.pulls.getReview(number, owner, repo, review_id)
+octokit.pulls.getCommentsForReview(owner, page, per_page, pull_number, repo, review_id)
+octokit.pulls.getReview(owner, pull_number, repo, review_id)
 octokit.pulls.list(base, direction, head, owner, page, per_page, repo, sort, state)
-octokit.pulls.listComments(direction, number, owner, page, per_page, repo, since, sort)
+octokit.pulls.listComments(direction, owner, page, per_page, pull_number, repo, since, sort)
 octokit.pulls.listCommentsForRepo(direction, owner, page, per_page, repo, since, sort)
-octokit.pulls.listCommits(number, owner, page, per_page, repo)
-octokit.pulls.listFiles(number, owner, page, per_page, repo)
-octokit.pulls.listReviewRequests(number, owner, page, per_page, repo)
-octokit.pulls.listReviews(number, owner, page, per_page, repo)
-octokit.pulls.merge(commit_message, commit_title, merge_method, number, owner, repo, sha)
-octokit.pulls.submitReview(body, event, number, owner, repo, review_id)
-octokit.pulls.update(base, body, maintainer_can_modify, number, owner, repo, state, title)
+octokit.pulls.listCommits(owner, page, per_page, pull_number, repo)
+octokit.pulls.listFiles(owner, page, per_page, pull_number, repo)
+octokit.pulls.listReviewRequests(owner, page, per_page, pull_number, repo)
+octokit.pulls.listReviews(owner, page, per_page, pull_number, repo)
+octokit.pulls.merge(commit_message, commit_title, merge_method, owner, pull_number, repo, sha)
+octokit.pulls.submitReview(body, event, owner, pull_number, repo, review_id)
+octokit.pulls.update(base, body, maintainer_can_modify, owner, pull_number, repo, state, title)
 octokit.pulls.updateComment(body, comment_id, owner, repo)
 octokit.rateLimit.get()
 octokit.reactions.createForCommitComment(comment_id, content, owner, repo)
-octokit.reactions.createForIssue(content, number, owner, repo)
+octokit.reactions.createForIssue(content, issue_number, owner, repo)
 octokit.reactions.createForIssueComment(comment_id, content, owner, repo)
@@ -310,3 +310,3 @@ octokit.reactions.createForPullRequestReviewComment(comment_id, content, owner, repo)
 octokit.reactions.listForCommitComment(comment_id, content, owner, page, per_page, repo)
-octokit.reactions.listForIssue(content, number, owner, page, per_page, repo)
+octokit.reactions.listForIssue(content, issue_number, owner, page, per_page, repo)
 octokit.reactions.listForIssueComment(comment_id, content, owner, page, per_page, repo)
@@ -352,3 +352,3 @@ octokit.reactions.listForPullRequestReviewComment(comment_id, content, owner, page, per_page, repo)
 octokit.repos.getCombinedStatusForRef(owner, ref, repo)
-octokit.repos.getCommit(owner, repo, sha)
+octokit.repos.getCommit(commit_sha, owner, repo)
 octokit.repos.getCommitActivityStats(owner, repo)
@@ -355,0 +355,0 @@ octokit.repos.getCommitComment(comment_id, owner, repo)

package.json

 {
   "name": "@octokit/plugin-enterprise-rest",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "publishConfig": {
@@ -38,7 +38,7 @@ "access": "public",
   "devDependencies": {
-    "@octokit/routes": "19.1.0",
+    "@octokit/routes": "20.0.0",
     "coveralls": "^3.0.2",
     "lodash.camelcase": "^4.3.0",
-    "make-dir": "^2.1.0",
-    "semantic-release": "^15.10.7",
+    "make-dir": "^3.0.0",
+    "semantic-release": "^15.13.8",
     "simple-mock": "^0.8.0",
@@ -48,5 +48,5 @@ "sort-keys": "^2.0.0",
     "standard-markdown": "^5.0.1",
-    "tap": "^12.0.1"
+    "tap": "^12.6.1"
   },
   "dependencies": {}
 }

scripts/generate-routes.js

@@ -14,3 +14,3 @@ const { writeFileSync } = require('fs')
 function normalize (endpoint) {
-  endpoint.idName = camelCase(endpoint.idName.replace(/^edit/, 'update'))
+  endpoint.idName = camelCase(endpoint.idName)
 }
@@ -39,44 +39,2 @@
     endpoints.forEach(normalize)
-
-    // handle some exceptions. TODO: move this into @octokit/routes
-    endpoints.forEach(endpoint => {
-      // exception for uploadReleaseAssets which passes parameters as header values
-      // see https://github.com/octokit/rest.js/pull/1043
-      if (endpoint.idName === 'uploadReleaseAsset') {
-        const contentLengthParam = endpoint.params.find(param => param.name === 'Content-Length')
-        const contentTypeParam = endpoint.params.find(param => param.name === 'Content-Type')
-        const indexes = endpoint.params.reduce((result, param, i) => {
-          if (['Content-Length', 'Content-Type'].includes(param.name)) {
-            result.unshift(i)
-          }
-
-          return result
-        }, [])
-        indexes.forEach(i => endpoint.params.splice(i, 1))
-
-        if (contentLengthParam) {
-          endpoint.params.unshift(
-            Object.assign(contentLengthParam, { name: 'headers.content-length' })
-          )
-        }
-        endpoint.params.unshift(
-          Object.assign(contentTypeParam, { name: 'headers.content-type' }),
-          {
-            name: 'headers',
-            location: 'headers',
-            required: true,
-            type: 'object',
-            description: 'Request headers containing `content-type` and `content-length`'
-          }
-        )
-      }
-
-      // exception for markdown.renderRaw which requires a content-type header
-      // see https://github.com/octokit/rest.js/pull/1043
-      if (endpoint.idName === 'renderRaw') {
-        endpoint.headers = {
-          'content-type': 'text/plain; charset=utf-8'
-        }
-      }
-    })
   })
@@ -134,2 +92,6 @@
         }
+        if (param.deprecated) {
+          result[param.name].deprecated = true
+          result[param.name].alias = param.deprecated.after.name
+        }
         return result
@@ -150,2 +112,6 @@ }, {}),
     }
+
+    if (endpoint.deprecated) {
+      newRoutes[scope][idName].deprecated = `octokit.${scope}.${camelCase(endpoint.deprecated.before.idName)}() has been renamed to octokit.${scope}.${camelCase(endpoint.deprecated.after.idName)}() (${endpoint.deprecated.date})`
+    }
   })
@@ -177,3 +143,3 @@
 function endpointToMethod (scope, methodName, meta) {
-  return `octokit.${scope}.${methodName}(${Object.keys(meta.params).filter(param => !/\./.test(param)).join(', ')})`
+  return `octokit.${scope}.${methodName}(${Object.keys(meta.params).filter(param => !/\./.test(param) && !meta.params[param].deprecated).join(', ')})`
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

846561

increased by2.12%

Lines of code

33922

increased by1.78%

No dependency changes