pulls_reviewers.go 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. // Copyright 2017 The go-github AUTHORS. All rights reserved.
  2. //
  3. // Use of this source code is governed by a BSD-style
  4. // license that can be found in the LICENSE file.
  5. package github
  6. import (
  7. "context"
  8. "fmt"
  9. )
  10. // ReviewersRequest specifies users and teams for a pull request review request.
  11. type ReviewersRequest struct {
  12. Reviewers []string `json:"reviewers,omitempty"`
  13. TeamReviewers []string `json:"team_reviewers,omitempty"`
  14. }
  15. // Reviewers represents reviewers of a pull request.
  16. type Reviewers struct {
  17. Users []*User `json:"users,omitempty"`
  18. Teams []*Team `json:"teams,omitempty"`
  19. }
  20. // RequestReviewers creates a review request for the provided reviewers for the specified pull request.
  21. //
  22. // GitHub API docs: https://developer.github.com/v3/pulls/review_requests/#create-a-review-request
  23. func (s *PullRequestsService) RequestReviewers(ctx context.Context, owner, repo string, number int, reviewers ReviewersRequest) (*PullRequest, *Response, error) {
  24. u := fmt.Sprintf("repos/%s/%s/pulls/%d/requested_reviewers", owner, repo, number)
  25. req, err := s.client.NewRequest("POST", u, &reviewers)
  26. if err != nil {
  27. return nil, nil, err
  28. }
  29. // TODO: remove custom Accept header when this API fully launches.
  30. req.Header.Set("Accept", mediaTypeTeamReviewPreview)
  31. r := new(PullRequest)
  32. resp, err := s.client.Do(ctx, req, r)
  33. if err != nil {
  34. return nil, resp, err
  35. }
  36. return r, resp, nil
  37. }
  38. // ListReviewers lists reviewers whose reviews have been requested on the specified pull request.
  39. //
  40. // GitHub API docs: https://developer.github.com/v3/pulls/review_requests/#list-review-requests
  41. func (s *PullRequestsService) ListReviewers(ctx context.Context, owner, repo string, number int, opt *ListOptions) (*Reviewers, *Response, error) {
  42. u := fmt.Sprintf("repos/%v/%v/pulls/%d/requested_reviewers", owner, repo, number)
  43. u, err := addOptions(u, opt)
  44. if err != nil {
  45. return nil, nil, err
  46. }
  47. req, err := s.client.NewRequest("GET", u, nil)
  48. if err != nil {
  49. return nil, nil, err
  50. }
  51. // TODO: remove custom Accept header when this API fully launches.
  52. req.Header.Set("Accept", mediaTypeTeamReviewPreview)
  53. reviewers := new(Reviewers)
  54. resp, err := s.client.Do(ctx, req, reviewers)
  55. if err != nil {
  56. return nil, resp, err
  57. }
  58. return reviewers, resp, nil
  59. }
  60. // RemoveReviewers removes the review request for the provided reviewers for the specified pull request.
  61. //
  62. // GitHub API docs: https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request
  63. func (s *PullRequestsService) RemoveReviewers(ctx context.Context, owner, repo string, number int, reviewers ReviewersRequest) (*Response, error) {
  64. u := fmt.Sprintf("repos/%s/%s/pulls/%d/requested_reviewers", owner, repo, number)
  65. req, err := s.client.NewRequest("DELETE", u, &reviewers)
  66. if err != nil {
  67. return nil, err
  68. }
  69. // TODO: remove custom Accept header when this API fully launches.
  70. req.Header.Set("Accept", mediaTypeTeamReviewPreview)
  71. return s.client.Do(ctx, req, nil)
  72. }