Skip to content

Commit 6a1cdad

Browse files
authored
Merge pull request #1733 from scala-steward-org/topic/github-api-docs
Add links to GitHub's API documentation
2 parents 4e132ca + ae34972 commit 6a1cdad

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

modules/core/src/main/scala/org/scalasteward/core/vcs/github/GitHubApiAlg.scala

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,21 +30,27 @@ final class GitHubApiAlg[F[_]](
3030
) extends VCSApiAlg[F] {
3131
private val url = new Url(gitHubApiHost)
3232

33+
/** https://developer.github.com/v3/repos/forks/#create-a-fork */
3334
override def createFork(repo: Repo): F[RepoOut] =
3435
client.post(url.forks(repo), modify(repo))
3536

37+
/** https://developer.github.com/v3/pulls/#create-a-pull-request */
3638
override def createPullRequest(repo: Repo, data: NewPullRequestData): F[PullRequestOut] =
3739
client.postWithBody(url.pulls(repo), data, modify(repo))
3840

41+
/** https://developer.github.com/v3/repos/branches/#get-branch */
3942
override def getBranch(repo: Repo, branch: Branch): F[BranchOut] =
4043
client.get(url.branches(repo, branch), modify(repo))
4144

45+
/** https://developer.github.com/v3/repos/#get */
4246
override def getRepo(repo: Repo): F[RepoOut] =
4347
client.get(url.repos(repo), modify(repo))
4448

49+
/** https://developer.github.com/v3/pulls/#list-pull-requests */
4550
override def listPullRequests(repo: Repo, head: String, base: Branch): F[List[PullRequestOut]] =
4651
client.get(url.listPullRequests(repo, head, base), modify(repo))
4752

53+
/** https://developer.github.com/v3/pulls/#update-a-pull-request */
4854
override def closePullRequest(repo: Repo, id: Int): F[PullRequestOut] =
4955
client.patchWithBody[PullRequestOut, UpdateState](
5056
url.pull(repo, id),

0 commit comments

Comments
 (0)