1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
use crate::models::pulls::{Review, ReviewAction};
use crate::pulls::specific_pr::pr_reviews::specific_review::list_comments::ListReviewCommentsBuilder;
use crate::pulls::PullRequestHandler;
mod list_comments;
#[derive(serde::Serialize)]
pub struct SpecificReviewBuilder<'octo, 'b> {
#[serde(skip)]
handler: &'b PullRequestHandler<'octo>,
pr_number: u64,
review_id: u64,
}
impl<'octo, 'b> SpecificReviewBuilder<'octo, 'b> {
pub(crate) fn new(
handler: &'b PullRequestHandler<'octo>,
pr_number: u64,
review_id: u64,
) -> Self {
Self {
handler,
pr_number,
review_id,
}
}
/// Retrieves a pull request review by its ID.
///
/// See: [GitHub API Documentation](https://docs.github.com/en/rest/pulls/reviews?apiVersion=2022-11-28#get-a-review-for-a-pull-request)
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let review = octocrab
/// .pulls("owner", "repo")
/// .pull_number(42)
/// .reviews()
/// .review(42)
/// .get()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub async fn get(&self) -> crate::Result<crate::models::pulls::Review> {
let route = format!(
"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}",
owner = self.handler.owner,
repo = self.handler.repo,
pull_number = self.pr_number,
review_id = self.review_id
);
self.handler.crab.get(route, Some(&self)).await
}
/// Updates the contents of a specified review summary comment.
///
/// See: [GitHub API Documentation](https://docs.github.com/en/rest/pulls/reviews?apiVersion=2022-11-28#update-a-review-for-a-pull-request)
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let review = octocrab
/// .pulls("owner", "repo")
/// .pull_number(42)
/// .reviews()
/// .review(42)
/// .update("this is a new body")
/// .await?;
/// # Ok(())
/// # }
/// ```
pub async fn update(
&self,
body: impl Into<String>,
) -> crate::Result<crate::models::pulls::Review> {
let route = format!(
"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}",
owner = self.handler.owner,
repo = self.handler.repo,
pull_number = self.pr_number,
review_id = self.review_id
);
self.handler.crab.put(route, Some(&body.into())).await
}
/// Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.
///
/// See: [GitHub API Documentation](https://docs.github.com/en/rest/pulls/reviews?apiVersion=2022-11-28#delete-a-pending-review-for-a-pull-request)
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let review = octocrab
/// .pulls("owner", "repo")
/// .pull_number(42)
/// .reviews()
/// .review(42)
/// .delete_pending()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub async fn delete_pending(&self) -> crate::Result<Review> {
let route = format!(
"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}",
owner = self.handler.owner,
repo = self.handler.repo,
pull_number = self.pr_number,
review_id = self.review_id
);
self.handler.crab.delete(route, None::<&()>).await
}
/// Submits a pending review for a pull request.
///
/// See: [GitHub API Documentation](https://docs.github.com/en/rest/pulls/reviews?apiVersion=2022-11-28#submit-a-review-for-a-pull-request)
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// use octocrab::models::pulls::ReviewAction;
///
/// let review = octocrab
/// .pulls("owner", "repo")
/// .pull_number(42)
/// .reviews()
/// .review(42)
/// .submit(ReviewAction::RequestChanges, "comment body")
/// .await?;
/// # Ok(())
/// # }
/// ```
pub async fn submit(
&self,
action: ReviewAction,
body: impl Into<String>,
) -> crate::Result<Review> {
let route = format!(
"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events",
owner = self.handler.owner,
repo = self.handler.repo,
pull_number = self.pr_number,
review_id = self.review_id
);
self.handler
.crab
.post(
route,
Some(&serde_json::json!({ "body": body.into(), "event": action })),
)
.await
}
/// Dismisses a specified review on a pull request.
///
/// See: [GitHub API Documentation](https://docs.github.com/en/rest/pulls/reviews?apiVersion=2022-11-28#dismiss-a-review-for-a-pull-request)
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let review = octocrab
/// .pulls("owner", "repo")
/// .pull_number(42)
/// .reviews()
/// .review(42)
/// .dismiss("message")
/// .await?;
/// # Ok(())
/// # }
/// ```
pub async fn dismiss(&self, message: impl Into<String>) -> crate::Result<Review> {
let route = format!(
"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals",
owner = self.handler.owner,
repo = self.handler.repo,
pull_number = self.pr_number,
review_id = self.review_id
);
self.handler
.crab
.put(
route,
Some(&serde_json::json!({ "message": message.into(), "event": "DISMISS" })),
)
.await
}
/// Lists comments for a specific pull request review.
///
/// See: [GitHub API Documentation](https://docs.github.com/en/rest/pulls/reviews?apiVersion=2022-11-28#list-comments-for-a-pull-request-review)
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let comments = octocrab
/// .pulls("owner", "repo")
/// .pull_number(42)
/// .reviews()
/// .review(42)
/// .list_comments()
/// .per_page(10)
/// .page(3u32)
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn list_comments(&self) -> ListReviewCommentsBuilder<'octo, '_> {
ListReviewCommentsBuilder::new(self.handler, self.pr_number, self.review_id)
}
}