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 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
//! The issue API. mod create; mod list; mod list_labels; mod update; use crate::{models, params, Octocrab, Result}; pub use self::{ create::CreateIssueBuilder, list::ListIssuesBuilder, list_labels::{ListLabelsForIssueBuilder, ListLabelsForRepoBuilder}, update::UpdateIssueBuilder, }; /// Handler for GitHub's issue API. /// /// Note: GitHub's REST API v3 considers every pull request an issue, but not /// every issue is a pull request. For this reason, "Issues" endpoints may /// return both issues and pull requests in the response. You can identify pull /// requests by the `pull_request` key. /// /// Created with [`Octocrab::issues`]. /// /// [`Octocrab::issues`]: ../struct.Octocrab.html#method.issues pub struct IssueHandler<'octo> { crab: &'octo Octocrab, owner: String, repo: String, } impl<'octo> IssueHandler<'octo> { pub(crate) fn new(crab: &'octo Octocrab, owner: String, repo: String) -> Self { Self { crab, owner, repo } } /// Gets a label from the repository. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// # let octocrab = octocrab::Octocrab::default(); /// let label = octocrab.issues("owner", "repo").get_label("help wanted").await?; /// # Ok(()) /// # } /// ``` pub async fn get(&self, number: u64) -> Result<models::Issue> { let route = format!( "/repos/{owner}/{repo}/issues/{number}", owner = self.owner, repo = self.repo, number = number, ); self.crab.get(route, None::<&()>).await } /// Create a issue in the repository. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// # let octocrab = octocrab::Octocrab::default(); /// let issue = octocrab.issues("owner", "repo").create("My first issue") /// // Optional Parameters /// .body("This is an autogenerated issue..") /// .milestone(1001) /// .labels(vec![String::from("help-wanted")]) /// .assignees(vec![String::from("ferris")]) /// // Send the request /// .send() /// .await?; /// # Ok(()) /// # } /// ``` pub fn create(&self, title: impl Into<String>) -> create::CreateIssueBuilder<'_, '_> { create::CreateIssueBuilder::new(self, title.into()) } /// List issues in the repository. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// # let octocrab = octocrab::Octocrab::default(); /// use octocrab::params; /// /// let issue = octocrab.issues("owner", "repo") /// .list() /// // Optional Parameters /// .state(params::State::All) /// .milestone(1234) /// .assignee("ferris") /// .creator("octocrab") /// .mentioned("octocat") /// .labels(&[String::from("help wanted"), String::from("good first issue")]) /// .sort(params::issues::Sort::Comments) /// .direction(params::Direction::Ascending) /// .per_page(100) /// .page(1u8) /// // Send the request /// .send() /// .await?; /// # Ok(()) /// # } /// ``` pub fn list(&self) -> list::ListIssuesBuilder<'_, '_, '_, '_> { list::ListIssuesBuilder::new(self) } /// Update an issue in the repository. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// # let octocrab = octocrab::Octocrab::default(); /// use octocrab::models; /// /// let issue = octocrab.issues("owner", "repo") /// .update(1234u64) /// // Optional Parameters /// .title("Updated title") /// .body("New body") /// .state(models::IssueState::Closed) /// .milestone(1234u64) /// .assignees(&[String::from("ferris")]) /// .labels(&[String::from("help wanted"), String::from("good first issue")]) /// // Send the request /// .send() /// .await?; /// # Ok(()) /// # } /// ``` pub fn update(&self, number: u64) -> update::UpdateIssueBuilder<'_, '_, '_, '_, '_, '_> { update::UpdateIssueBuilder::new(self, number) } /// Users with push access can lock an issue or pull request's conversation. /// /// *Note* Providing a reason requires the `sailor-v` preview to enabled. /// /// See also: https://developer.github.com/v3/issues/#lock-an-issue /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// use octocrab::params; /// /// assert!(octocrab::instance().issues("owner", "repo").lock(404, params::LockReason::OffTopic).await?); /// # Ok(()) /// # } /// ``` pub async fn lock( &self, number: u64, reason: impl Into<Option<params::LockReason>>, ) -> Result<bool> { let route = format!( "/repos/{owner}/{repo}/issues/{number}/lock", owner = self.owner, repo = self.repo, number = number, ); let response = self .crab ._put( self.crab.absolute_url(route)?, reason .into() .map(|reason| { serde_json::json!({ "lock_reason": reason, }) }) .as_ref(), ) .await?; Ok(response.status() == 204) } /// Users with push access can unlock an issue or pull request's conversation. /// /// See also: https://developer.github.com/v3/issues/#unlock-an-issue /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// use octocrab::params; /// /// assert!(octocrab::instance().issues("owner", "repo").unlock(404).await?); /// # Ok(()) /// # } /// ``` pub async fn unlock(&self, number: u64) -> Result<bool> { let route = format!( "/repos/{owner}/{repo}/issues/{number}/lock", owner = self.owner, repo = self.repo, number = number, ); let response = self .crab ._delete(self.crab.absolute_url(route)?, None::<&()>) .await?; Ok(response.status() == 204) } } /// # Assignees impl<'octo> IssueHandler<'octo> { /// Adds up to 10 assignees to an issue. Users already assigned to an issue /// are not replaced. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// # let octocrab = octocrab::Octocrab::default(); /// let issue = octocrab.issues("owner", "repo").add_assignees(101, &[56982]).await?; /// # Ok(()) /// # } /// ``` pub async fn add_assignees(&self, number: u64, assignees: &[u64]) -> Result<models::Issue> { let route = format!( "/repos/{owner}/{repo}/issues/{issue}/assignees", owner = self.owner, repo = self.repo, issue = number ); self.crab .post(route, Some(&serde_json::json!({ "assignees": assignees }))) .await } /// Checks if a user has permission to be assigned to an issue in /// the repository. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// # let octocrab = octocrab::Octocrab::default(); /// assert!(octocrab.issues("owner", "repo").check_assignee("ferris").await?); /// # Ok(()) /// # } /// ``` pub async fn check_assignee(&self, assignee: impl AsRef<str>) -> Result<bool> { let route = format!( "/repos/{owner}/{repo}/assignees/{assignee}", owner = self.owner, repo = self.repo, assignee = assignee.as_ref() ); let response = self .crab ._get(self.crab.absolute_url(route)?, None::<&()>) .await?; let status = response.status(); if status == 204 { Ok(true) } else if status == 404 { Ok(false) } else { Err(crate::map_github_error(response).await.unwrap_err()) } } /// Lists the available assignees for issues in a repository. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// # let octocrab = octocrab::Octocrab::default(); /// let assignees = octocrab /// .issues("owner", "repo") /// .list_assignees() /// .per_page(15) /// .page(2u32) /// .send() /// .await?; /// # Ok(()) /// # } /// ``` pub fn list_assignees(&self) -> ListAssigneesBuilder { ListAssigneesBuilder::new(self) } } #[derive(serde::Serialize)] pub struct ListAssigneesBuilder<'octo, 'r> { #[serde(skip)] handler: &'r IssueHandler<'octo>, #[serde(skip_serializing_if = "Option::is_none")] per_page: Option<u8>, #[serde(skip_serializing_if = "Option::is_none")] page: Option<u32>, } impl<'octo, 'r> ListAssigneesBuilder<'octo, 'r> { pub(crate) fn new(handler: &'r IssueHandler<'octo>) -> Self { Self { handler, per_page: None, page: None, } } /// Results per page (max 100). pub fn per_page(mut self, per_page: impl Into<u8>) -> Self { self.per_page = Some(per_page.into()); self } /// Page number of the results to fetch. pub fn page(mut self, page: impl Into<u32>) -> Self { self.page = Some(page.into()); self } /// Send the actual request. pub async fn send(self) -> Result<crate::Page<models::User>> { let route = format!( "/repos/{owner}/{repo}/assignees", owner = self.handler.owner, repo = self.handler.repo, ); self.handler.crab.get(route, Some(&self)).await } } /// # Labels impl<'octo> IssueHandler<'octo> { /// Adds `labels` to an issue. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// let labels = octocrab::instance() /// .issues("owner", "repo") /// .add_labels(101, &[String::from("help wanted")]) /// .await?; /// # Ok(()) /// # } /// ``` pub async fn add_labels(&self, number: u64, labels: &[String]) -> Result<Vec<models::Label>> { let route = format!( "/repos/{owner}/{repo}/issues/{issue}/labels", owner = self.owner, repo = self.repo, issue = number ); self.crab .post(route, Some(&serde_json::json!({ "labels": labels }))) .await } /// Replaces all labels for an issue. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// let labels = octocrab::instance() /// .issues("owner", "repo") /// .replace_all_labels(101, &[String::from("help wanted")]) /// .await?; /// # Ok(()) /// # } /// ``` pub async fn replace_all_labels( &self, number: u64, labels: &[String], ) -> Result<Vec<models::Label>> { let route = format!( "/repos/{owner}/{repo}/issues/{issue}/labels", owner = self.owner, repo = self.repo, issue = number ); self.crab .put(route, Some(&serde_json::json!({ "labels": labels }))) .await } /// Creates a label in the repository. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// let label = octocrab::instance() /// .issues("owner", "repo") /// .create_label("help wanted", "59dd5a", "") /// .await?; /// # Ok(()) /// # } /// ``` pub async fn create_label( &self, name: impl AsRef<str>, color: impl AsRef<str>, description: impl AsRef<str>, ) -> Result<models::Label> { let route = format!( "/repos/{owner}/{repo}/labels", owner = self.owner, repo = self.repo, ); self.crab .post( route, Some(&serde_json::json!({ "name": name.as_ref(), "color": color.as_ref(), "description": description.as_ref() })), ) .await } /// Gets a label from the repository. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// let label = octocrab::instance() /// .issues("owner", "repo") /// .get_label("help wanted") /// .await?; /// # Ok(()) /// # } /// ``` pub async fn get_label(&self, name: impl AsRef<str>) -> Result<models::Label> { let route = format!( "/repos/{owner}/{repo}/labels/{name}", owner = self.owner, repo = self.repo, name = name.as_ref(), ); self.crab.get(route, None::<&()>).await } /// Deletes a label in the repository. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// let label = octocrab::instance() /// .issues("owner", "repo") /// .delete_label("help wanted") /// .await?; /// # Ok(()) /// # } /// ``` pub async fn delete_label(&self, name: impl AsRef<str>) -> Result<models::Label> { let route = format!( "/repos/{owner}/{repo}/labels/{name}", owner = self.owner, repo = self.repo, name = name.as_ref(), ); self.crab.delete(route, None::<&()>).await } /// List labels from an issue on a repository. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// let page = octocrab::instance() /// .issues("owner", "repo") /// .list_labels_for_issue(404) /// // Optional Parameters /// .per_page(20) /// .page(2u32) /// .send() /// .await?; /// # Ok(()) /// # } /// ``` pub fn list_labels_for_issue(&self, number: u64) -> ListLabelsForIssueBuilder { ListLabelsForIssueBuilder::new(self, number) } /// List all labels from a repository. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// let page = octocrab::instance() /// .issues("owner", "repo") /// .list_labels_for_repo() /// // Optional Parameters /// .per_page(20) /// .page(2u32) /// .send() /// .await?; /// # Ok(()) /// # } /// ``` pub fn list_labels_for_repo(&self) -> ListLabelsForRepoBuilder { ListLabelsForRepoBuilder::new(self) } } /// # Comments impl<'octo> IssueHandler<'octo> { /// Creates a comment in the issue. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// let comment = octocrab::instance() /// .issues("owner", "repo") /// .create_comment(101, "Beep Boop") /// .await?; /// # Ok(()) /// # } /// ``` pub async fn create_comment( &self, number: u64, body: impl AsRef<str>, ) -> Result<models::Comment> { let route = format!( "/repos/{owner}/{repo}/issues/{issue}/comments", owner = self.owner, repo = self.repo, issue = number ); self.crab .post(route, Some(&serde_json::json!({ "body": body.as_ref() }))) .await } /// Gets a comment in the issue. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// let comment = octocrab::instance() /// .issues("owner", "repo") /// .get_comment(101) /// .await?; /// # Ok(()) /// # } /// ``` pub async fn get_comment(&self, comment_id: u64) -> Result<models::Comment> { let route = format!( "/repos/{owner}/{repo}/issues/comments/{comment_id}", owner = self.owner, repo = self.repo, comment_id = comment_id ); self.crab.get(route, None::<&()>).await } /// Deletes a comment in an issue. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// octocrab::instance().issues("owner", "repo").delete_comment(101).await?; /// # Ok(()) /// # } /// ``` pub async fn delete_comment(&self, comment_id: u64) -> Result<()> { let route = format!( "/repos/{owner}/{repo}/issues/comments/{comment_id}", owner = self.owner, repo = self.repo, comment_id = comment_id ); let response = self .crab ._delete(self.crab.absolute_url(route)?, None::<&()>) .await?; if response.status() == 204 { Ok(()) } else { crate::map_github_error(response).await.map(drop) } } /// Lists comments in the issue. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// let comment = octocrab::instance() /// .issues("owner", "repo") /// .list_comments(101) /// .since(chrono::Utc::now()) /// .per_page(100) /// .page(2u32) /// .send() /// .await?; /// # Ok(()) /// # } /// ``` pub fn list_comments(&self, issue_number: u64) -> ListCommentsBuilder<'_, '_> { ListCommentsBuilder::new(self, issue_number) } } #[derive(serde::Serialize)] pub struct ListCommentsBuilder<'octo, 'r> { #[serde(skip)] handler: &'r IssueHandler<'octo>, #[serde(skip)] issue_number: u64, #[serde(skip_serializing_if = "Option::is_none")] since: Option<chrono::DateTime<chrono::Utc>>, #[serde(skip_serializing_if = "Option::is_none")] per_page: Option<u8>, #[serde(skip_serializing_if = "Option::is_none")] page: Option<u32>, } impl<'octo, 'r> ListCommentsBuilder<'octo, 'r> { pub(crate) fn new(handler: &'r IssueHandler<'octo>, issue_number: u64) -> Self { Self { handler, issue_number, since: None, per_page: None, page: None, } } /// Results per page (max 100). pub fn per_page(mut self, per_page: impl Into<u8>) -> Self { self.per_page = Some(per_page.into()); self } /// Only comments updated at or after this time are returned. pub fn since(mut self, since: impl Into<chrono::DateTime<chrono::Utc>>) -> Self { self.since = Some(since.into()); self } /// Page number of the results to fetch. pub fn page(mut self, page: impl Into<u32>) -> Self { self.page = Some(page.into()); self } /// Send the actual request. pub async fn send(self) -> Result<crate::Page<models::Comment>> { let route = format!( "/repos/{owner}/{repo}/issues/{issue}/comments", owner = self.handler.owner, repo = self.handler.repo, issue = self.issue_number, ); self.handler.crab.get(route, Some(&self)).await } }