Skip to content

Commit 30e1311

Browse files
authored
Merge pull request #3556 from scala-steward-org/topic/update-gh-api-links
Update links to the GitHub REST API docs
2 parents 9813e68 + 14eb257 commit 30e1311

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,11 @@ final class GitHubApiAlg[F[_]](
8989
} yield ()
9090
}
9191

92-
/** https://docs.github.com/en/rest/repos/branches?apiVersion=2022-11-28#get-branch */
92+
/** https://docs.github.com/en/rest/branches/branches?apiVersion=2022-11-28#get-a-branch */
9393
override def getBranch(repo: Repo, branch: Branch): F[BranchOut] =
9494
client.get(url.branches(repo, branch), modify)
9595

96-
/** https://docs.github.com/en/rest/repos?apiVersion=2022-11-28#get */
96+
/** https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#get-a-repository */
9797
override def getRepo(repo: Repo): F[RepoOut] =
9898
client.get[RepoOut](url.repos(repo), modify).flatTap { repoOut =>
9999
F.raiseWhen(repoOut.archived)(RepositoryArchived(repo))
@@ -103,15 +103,16 @@ final class GitHubApiAlg[F[_]](
103103
override def listPullRequests(repo: Repo, head: String, base: Branch): F[List[PullRequestOut]] =
104104
client.get(url.listPullRequests(repo, head, base), modify)
105105

106-
/** https://docs.github.com/en/rest/pulls?apiVersion=2022-11-28#update-a-pull-request */
106+
/** https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#update-a-pull-request */
107107
override def closePullRequest(repo: Repo, number: PullRequestNumber): F[PullRequestOut] =
108108
client.patchWithBody[PullRequestOut, UpdateState](
109109
url.pull(repo, number),
110110
UpdateState(PullRequestState.Closed),
111111
modify
112112
)
113113

114-
/** https://docs.github.com/en/rest/issues?apiVersion=2022-11-28#create-an-issue-comment */
114+
/** https://docs.github.com/en/rest/issues/comments?apiVersion=2022-11-28#create-an-issue-comment
115+
*/
115116
override def commentPullRequest(
116117
repo: Repo,
117118
number: PullRequestNumber,
@@ -120,8 +121,7 @@ final class GitHubApiAlg[F[_]](
120121
client
121122
.postWithBody(url.comments(repo, number), Comment(comment), modify)
122123

123-
/** https://docs.github.com/en/rest/reference/issues?apiVersion=2022-11-28#add-labels-to-an-issue
124-
*/
124+
/** https://docs.github.com/en/rest/issues/labels?apiVersion=2022-11-28#add-labels-to-an-issue */
125125
private def labelPullRequest(
126126
repo: Repo,
127127
number: PullRequestNumber,

0 commit comments

Comments
 (0)