Files
octokit.net/Octokit.Reactive/Clients/IObservablePullRequestReviewRequestsClient.cs
Grzegorz Dziadkiewicz 97ae3cb3de Add Pull Request Review Request API. (#1588)
* Add Pull Request Review Request API.

* Add Reactive Pull Request Review Request API.

* Add PullRequestReviewRequestClient tests.

* Add ObservablePullRequestReviewRequestClient tests.

* Fix sub-client property naming.

* Remove redundant model and update PullRequest model.

* Add repositoryId based methods and missing Observable documentation.

* Add missing parameter to PullRequest ctor.

* Add integration tests for PullRequestReviewRequest.

* Upgrade PullRequestReviewRequest integration tests.

* Add integration tests for repositoryId methods and fix url bug.

* Add missing unit tests and fix PR issues.

* Add pagination support for PullRequestReviewRequst.GetAll and tests for it.

* Revert changes on `PullRequestReviewCommentsClientTests.cs`

* Small upgrades - remove unused using and compress property to expression body.

* Revert use of expression body in property.

* Add pagination tests for PullRequestReviewRequest.GetAll.

* Change pagination tests to use 2 users.

* Correct class/file name

* Reword the integration test names for consistency
Move the plumbing to create reviews into CreateTheWorld to clean up the actual tests

* Fix DebuggerDisplay of requested reviewers

* fix reviewRequestToCreate parameter to be consistent
2017-05-14 22:07:57 +10:00

88 lines
4.8 KiB
C#

using System;
using System.Reactive;
namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Pull Request Review Requests API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/pulls/review_requests/">Review Requests API documentation</a> for more information.
/// </remarks>
public interface IObservablePullRequestReviewRequestsClient
{
/// <summary>
/// Gets review requests for a specified pull request.
/// </summary>
/// <remarks>https://developer.github.com/v3/pulls/review_requests/#list-review-requests</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
IObservable<User> GetAll(string owner, string name, int number);
/// <summary>
/// Gets review requests for a specified pull request.
/// </summary>
/// <remarks>https://developer.github.com/v3/pulls/review_requests/#list-review-requests</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="options">Options for changing the API response</param>
IObservable<User> GetAll(string owner, string name, int number, ApiOptions options);
/// <summary>
/// Gets review requests for a specified pull request.
/// </summary>
/// <remarks>https://developer.github.com/v3/pulls/review_requests/#list-review-requests</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The pull request number</param>
IObservable<User> GetAll(long repositoryId, int number);
/// <summary>
/// Gets review requests for a specified pull request.
/// </summary>
/// <remarks>https://developer.github.com/v3/pulls/review_requests/#list-review-requests</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="options">Options for changing the API response</param>
IObservable<User> GetAll(long repositoryId, int number, ApiOptions options);
/// <summary>
/// Creates review requests on a pull request for specified users.
/// </summary>
/// <remarks>https://developer.github.com/v3/pulls/review_requests/#create-a-review-request</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The Pull Request number</param>
/// <param name="users">List of logins of user will be requested for review</param>
IObservable<PullRequest> Create(string owner, string name, int number, PullRequestReviewRequest users);
/// <summary>
/// Creates review requests on a pull request for specified users.
/// </summary>
/// <remarks>https://developer.github.com/v3/pulls/review_requests/#create-a-review-request</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The Pull Request number</param>
/// <param name="users">List of logins of user will be requested for review</param>
IObservable<PullRequest> Create(long repositoryId, int number, PullRequestReviewRequest users);
/// <summary>
/// Deletes review request for given users on a pull request.
/// </summary>
/// <remarks>https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request review comment number</param>
/// <param name="users">List of logins of users that will be not longer requested for review</param>
IObservable<Unit> Delete(string owner, string name, int number, PullRequestReviewRequest users);
/// <summary>
/// Deletes review request for given users on a pull request.
/// </summary>
/// <remarks>https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The pull request review comment number</param>
/// <param name="users">List of logins of users that will be not longer requested for review</param>
IObservable<Unit> Delete(long repositoryId, int number, PullRequestReviewRequest users);
}
}