zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2025-12-22 15:15:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

modified XML docs

Browse Source 
added new overloads
This commit is contained in:
aedampir@gmail.com
2016-06-16 19:15:20 +07:00
parent 4d8c07eee6
commit 691eded548
4 changed files with 601 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

123
Octokit.Reactive/Clients/IObservablePullRequestsClient.cs
View File

@@ -3,6 +3,12 @@ using System.Diagnostics.CodeAnalysis;
namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Pull Requests API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/activity/notifications/">Pull Requests API documentation</a> for more information.
/// </remarks>
public interface IObservablePullRequestsClient
{
/// <summary>
@@ -16,11 +22,27 @@ namespace Octokit.Reactive
/// <remarks>
/// http://developer.github.com/v3/pulls/#get-a-single-pull-request
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The number of the pull request</param>
/// <returns>A <see cref="PullRequest"/> result</returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
IObservable<PullRequest> Get(string owner, string name, int number);
/// <summary>
/// Gets a single Pull Request by number.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#get-a-single-pull-request
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The number of the pull request</param>
/// <returns>A <see cref="PullRequest"/> result</returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
IObservable<PullRequest> Get(int repositoryId, int number);
/// <summary>
/// Gets all open pull requests for the repository.
/// </summary>
@@ -32,6 +54,16 @@ namespace Octokit.Reactive
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
IObservable<PullRequest> GetAllForRepository(string owner, string name);
/// <summary>
/// Gets all open pull requests for the repository.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
IObservable<PullRequest> GetAllForRepository(int repositoryId);
/// <summary>
/// Gets all open pull requests for the repository.
/// </summary>
@@ -44,6 +76,17 @@ namespace Octokit.Reactive
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
IObservable<PullRequest> GetAllForRepository(string owner, string name, ApiOptions options);
/// <summary>
/// Gets all open pull requests for the repository.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
IObservable<PullRequest> GetAllForRepository(int repositoryId, ApiOptions options);
/// <summary>
/// Query pull requests for the repository based on criteria
/// </summary>
@@ -56,6 +99,17 @@ namespace Octokit.Reactive
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
IObservable<PullRequest> GetAllForRepository(string owner, string name, PullRequestRequest request);
/// <summary>
/// Query pull requests for the repository based on criteria
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
IObservable<PullRequest> GetAllForRepository(int repositoryId, PullRequestRequest request);
/// <summary>
/// Query pull requests for the repository based on criteria
/// </summary>
@@ -69,6 +123,18 @@ namespace Octokit.Reactive
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
IObservable<PullRequest> GetAllForRepository(string owner, string name, PullRequestRequest request, ApiOptions options);
/// <summary>
/// Query pull requests for the repository based on criteria
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
IObservable<PullRequest> GetAllForRepository(int repositoryId, PullRequestRequest request, ApiOptions options);
/// <summary>
/// Creates a pull request for the specified repository.
/// </summary>
@@ -79,6 +145,15 @@ namespace Octokit.Reactive
/// <returns>A created <see cref="PullRequest"/> result</returns>
IObservable<PullRequest> Create(string owner, string name, NewPullRequest newPullRequest);
/// <summary>
/// Creates a pull request for the specified repository.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#create-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="newPullRequest">A <see cref="NewPullRequest"/> instance describing the new PullRequest to create</param>
/// <returns>A created <see cref="PullRequest"/> result</returns>
IObservable<PullRequest> Create(int repositoryId, NewPullRequest newPullRequest);
/// <summary>
/// Update a pull request for the specified repository.
/// </summary>
@@ -91,6 +166,17 @@ namespace Octokit.Reactive
/// <returns>An updated <see cref="PullRequest"/> result</returns>
IObservable<PullRequest> Update(string owner, string name, int number, PullRequestUpdate pullRequestUpdate);
/// <summary>
/// Update a pull request for the specified repository.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#update-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The PullRequest number</param>
/// <param name="pullRequestUpdate">An <see cref="PullRequestUpdate"/> instance describing the changes to make to the PullRequest
/// </param>
/// <returns>An updated <see cref="PullRequest"/> result</returns>
IObservable<PullRequest> Update(int repositoryId, int number, PullRequestUpdate pullRequestUpdate);
/// <summary>
/// Merge a pull request.
/// </summary>
@@ -102,6 +188,16 @@ namespace Octokit.Reactive
/// <returns>A <see cref="PullRequestMerge"/> result</returns>
IObservable<PullRequestMerge> Merge(string owner, string name, int number, MergePullRequest mergePullRequest);
/// <summary>
/// Merge a pull request.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="mergePullRequest">A <see cref="MergePullRequest"/> instance describing a pull request merge</param>
/// <returns>A <see cref="PullRequestMerge"/> result</returns>
IObservable<PullRequestMerge> Merge(int repositoryId, int number, MergePullRequest mergePullRequest);
/// <summary>
/// Gets the pull request merge status.
/// </summary>
@@ -112,6 +208,15 @@ namespace Octokit.Reactive
/// <returns>A <see cref="bool"/> result - true if the pull request has been merged, false otherwise</returns>
IObservable<bool> Merged(string owner, string name, int number);
/// <summary>
/// Gets the pull request merge status.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="bool"/> result - true if the pull request has been merged, false otherwise</returns>
IObservable<bool> Merged(int repositoryId, int number);
/// <summary>
/// Gets the list of commits on a pull request.
/// </summary>
@@ -122,6 +227,15 @@ namespace Octokit.Reactive
/// <returns>A collection of <see cref="PullRequestCommit"/> results</returns>
IObservable<PullRequestCommit> Commits(string owner, string name, int number);
/// <summary>
/// Gets the list of commits on a pull request.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A collection of <see cref="PullRequestCommit"/> results</returns>
IObservable<PullRequestCommit> Commits(int repositoryId, int number);
/// <summary>
/// Get the list of files on a pull request.
/// </summary>
@@ -131,5 +245,14 @@ namespace Octokit.Reactive
/// <param name="number">The pull request number</param>
/// <returns>A collection of <see cref="PullRequestFile"/> results</returns>
IObservable<PullRequestFile> Files(string owner, string name, int number);
/// <summary>
/// Get the list of files on a pull request.
/// </summary>
/// <remarks>https://developer.github.com/v3/pulls/#list-pull-requests-files</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A collection of <see cref="PullRequestFile"/> results</returns>
IObservable<PullRequestFile> Files(int repositoryId, int number);
}
}

165
Octokit.Reactive/Clients/ObservablePullRequestsClient.cs
View File

@@ -4,6 +4,12 @@ using Octokit.Reactive.Internal;
namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Pull Requests API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/activity/notifications/">Pull Requests API documentation</a> for more information.
/// </remarks>
public class ObservablePullRequestsClient : IObservablePullRequestsClient
{
readonly IPullRequestsClient _client;
@@ -38,6 +44,20 @@ namespace Octokit.Reactive
return _client.Get(owner, name, number).ToObservable();
}
/// <summary>
/// Gets a single Pull Request by number.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#get-a-single-pull-request
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The number of the pull request</param>
/// <returns>A <see cref="PullRequest"/> result</returns>
public IObservable<PullRequest> Get(int repositoryId, int number)
{
return _client.Get(repositoryId, number).ToObservable();
}
/// <summary>
/// Gets all open pull requests for the repository.
/// </summary>
@@ -55,6 +75,19 @@ namespace Octokit.Reactive
return GetAllForRepository(owner, name, ApiOptions.None);
}
/// <summary>
/// Gets all open pull requests for the repository.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
public IObservable<PullRequest> GetAllForRepository(int repositoryId)
{
return GetAllForRepository(repositoryId, ApiOptions.None);
}
/// <summary>
/// Gets all open pull requests for the repository.
/// </summary>
@@ -74,6 +107,22 @@ namespace Octokit.Reactive
return _connection.GetAndFlattenAllPages<PullRequest>(ApiUrls.PullRequests(owner, name), options);
}
/// <summary>
/// Gets all open pull requests for the repository.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
public IObservable<PullRequest> GetAllForRepository(int repositoryId, ApiOptions options)
{
Ensure.ArgumentNotNull(options, "options");
return _connection.GetAndFlattenAllPages<PullRequest>(ApiUrls.PullRequests(repositoryId), options);
}
/// <summary>
/// Query pull requests for the repository based on criteria
/// </summary>
@@ -93,6 +142,22 @@ namespace Octokit.Reactive
return GetAllForRepository(owner, name, request, ApiOptions.None);
}
/// <summary>
/// Query pull requests for the repository based on criteria
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
public IObservable<PullRequest> GetAllForRepository(int repositoryId, PullRequestRequest request)
{
Ensure.ArgumentNotNull(request, "request");
return GetAllForRepository(repositoryId, request, ApiOptions.None);
}
/// <summary>
/// Query pull requests for the repository based on criteria
/// </summary>
@@ -115,6 +180,25 @@ namespace Octokit.Reactive
request.ToParametersDictionary(), options);
}
/// <summary>
/// Query pull requests for the repository based on criteria
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
public IObservable<PullRequest> GetAllForRepository(int repositoryId, PullRequestRequest request, ApiOptions options)
{
Ensure.ArgumentNotNull(request, "request");
Ensure.ArgumentNotNull(options, "options");
return _connection.GetAndFlattenAllPages<PullRequest>(ApiUrls.PullRequests(repositoryId),
request.ToParametersDictionary(), options);
}
/// <summary>
/// Creates a pull request for the specified repository.
/// </summary>
@@ -132,6 +216,20 @@ namespace Octokit.Reactive
return _client.Create(owner, name, newPullRequest).ToObservable();
}
/// <summary>
/// Creates a pull request for the specified repository.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#create-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="newPullRequest">A <see cref="NewPullRequest"/> instance describing the new PullRequest to create</param>
/// <returns>A created <see cref="PullRequest"/> result</returns>
public IObservable<PullRequest> Create(int repositoryId, NewPullRequest newPullRequest)
{
Ensure.ArgumentNotNull(newPullRequest, "newPullRequest");
return _client.Create(repositoryId, newPullRequest).ToObservable();
}
/// <summary>
/// Update a pull request for the specified repository.
/// </summary>
@@ -151,6 +249,22 @@ namespace Octokit.Reactive
return _client.Update(owner, name, number, pullRequestUpdate).ToObservable();
}
/// <summary>
/// Update a pull request for the specified repository.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#update-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The PullRequest number</param>
/// <param name="pullRequestUpdate">An <see cref="PullRequestUpdate"/> instance describing the changes to make to the PullRequest
/// </param>
/// <returns>An updated <see cref="PullRequest"/> result</returns>
public IObservable<PullRequest> Update(int repositoryId, int number, PullRequestUpdate pullRequestUpdate)
{
Ensure.ArgumentNotNull(pullRequestUpdate, "pullRequestUpdate");
return _client.Update(repositoryId, number, pullRequestUpdate).ToObservable();
}
/// <summary>
/// Merge a pull request.
/// </summary>
@@ -169,6 +283,21 @@ namespace Octokit.Reactive
return _client.Merge(owner, name, number, mergePullRequest).ToObservable();
}
/// <summary>
/// Merge a pull request.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="mergePullRequest">A <see cref="MergePullRequest"/> instance describing a pull request merge</param>
/// <returns>A <see cref="PullRequestMerge"/> result</returns>
public IObservable<PullRequestMerge> Merge(int repositoryId, int number, MergePullRequest mergePullRequest)
{
Ensure.ArgumentNotNull(mergePullRequest, "mergePullRequest");
return _client.Merge(repositoryId, number, mergePullRequest).ToObservable();
}
/// <summary>
/// Gets the pull request merge status.
/// </summary>
@@ -185,6 +314,18 @@ namespace Octokit.Reactive
return _client.Merged(owner, name, number).ToObservable();
}
/// <summary>
/// Gets the pull request merge status.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="bool"/> result - true if the pull request has been merged, false otherwise</returns>
public IObservable<bool> Merged(int repositoryId, int number)
{
return _client.Merged(repositoryId, number).ToObservable();
}
/// <summary>
/// Gets the list of commits on a pull request.
/// </summary>
@@ -201,6 +342,18 @@ namespace Octokit.Reactive
return _connection.GetAndFlattenAllPages<PullRequestCommit>(ApiUrls.PullRequestCommits(owner, name, number));
}
/// <summary>
/// Gets the list of commits on a pull request.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A collection of <see cref="PullRequestCommit"/> results</returns>
public IObservable<PullRequestCommit> Commits(int repositoryId, int number)
{
return _connection.GetAndFlattenAllPages<PullRequestCommit>(ApiUrls.PullRequestCommits(repositoryId, number));
}
/// <summary>
/// Get the list of files on a pull request.
/// </summary>
@@ -216,5 +369,17 @@ namespace Octokit.Reactive
return _connection.GetAndFlattenAllPages<PullRequestFile>(ApiUrls.PullRequestFiles(owner, name, number));
}
/// <summary>
/// Get the list of files on a pull request.
/// </summary>
/// <remarks>https://developer.github.com/v3/pulls/#list-pull-requests-files</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A collection of <see cref="PullRequestFile"/> results</returns>
public IObservable<PullRequestFile> Files(int repositoryId, int number)
{
return _connection.GetAndFlattenAllPages<PullRequestFile>(ApiUrls.PullRequestFiles(repositoryId, number));
}
}
}

118
Octokit/Clients/IPullRequestsClient.cs
View File

@@ -4,6 +4,12 @@ using System.Threading.Tasks;
namespace Octokit
{
/// <summary>
/// A client for GitHub's Pull Requests API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/activity/notifications/">Pull Requests API documentation</a> for more information.
/// </remarks>
public interface IPullRequestsClient
{
/// <summary>
@@ -22,6 +28,17 @@ namespace Octokit
Justification = "Method makes a network request")]
Task<PullRequest> Get(string owner, string name, int number);
/// <summary>
/// Get a pull request by number.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#get-a-single-pull-request
/// </remarks>
/// <returns>A <see cref="PullRequest"/> result</returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
Task<PullRequest> Get(int repositoryId, int number);
/// <summary>
/// Get all open pull requests for the repository.
/// </summary>
@@ -33,6 +50,16 @@ namespace Octokit
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which are currently open</returns>
Task<IReadOnlyList<PullRequest>> GetAllForRepository(string owner, string name);
/// <summary>
/// Get all open pull requests for the repository.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which are currently open</returns>
Task<IReadOnlyList<PullRequest>> GetAllForRepository(int repositoryId);
/// <summary>
/// Get all open pull requests for the repository.
/// </summary>
@@ -45,6 +72,17 @@ namespace Octokit
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which are currently open</returns>
Task<IReadOnlyList<PullRequest>> GetAllForRepository(string owner, string name, ApiOptions options);
/// <summary>
/// Get all open pull requests for the repository.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which are currently open</returns>
Task<IReadOnlyList<PullRequest>> GetAllForRepository(int repositoryId, ApiOptions options);
/// <summary>
/// Query pull requests for the repository based on criteria
/// </summary>
@@ -57,6 +95,17 @@ namespace Octokit
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which match the criteria</returns>
Task<IReadOnlyList<PullRequest>> GetAllForRepository(string owner, string name, PullRequestRequest request);
/// <summary>
/// Query pull requests for the repository based on criteria
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which match the criteria</returns>
Task<IReadOnlyList<PullRequest>> GetAllForRepository(int repositoryId, PullRequestRequest request);
/// <summary>
/// Query pull requests for the repository based on criteria
/// </summary>
@@ -70,6 +119,18 @@ namespace Octokit
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which match the criteria</returns>
Task<IReadOnlyList<PullRequest>> GetAllForRepository(string owner, string name, PullRequestRequest request, ApiOptions options);
/// <summary>
/// Query pull requests for the repository based on criteria
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which match the criteria</returns>
Task<IReadOnlyList<PullRequest>> GetAllForRepository(int repositoryId, PullRequestRequest request, ApiOptions options);
/// <summary>
/// Create a pull request for the specified repository.
/// </summary>
@@ -80,6 +141,15 @@ namespace Octokit
/// <returns>A <see cref="PullRequest"/> result which was created on the server</returns>
Task<PullRequest> Create(string owner, string name, NewPullRequest newPullRequest);
/// <summary>
/// Create a pull request for the specified repository.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#create-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="newPullRequest">A <see cref="NewPullRequest"/> instance describing the new PullRequest to create</param>
/// <returns>A <see cref="PullRequest"/> result which was created on the server</returns>
Task<PullRequest> Create(int repositoryId, NewPullRequest newPullRequest);
/// <summary>
/// Create a pull request for the specified repository.
/// </summary>
@@ -92,6 +162,17 @@ namespace Octokit
/// <returns>An updated <see cref="PullRequest"/> result</returns>
Task<PullRequest> Update(string owner, string name, int number, PullRequestUpdate pullRequestUpdate);
/// <summary>
/// Create a pull request for the specified repository.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#update-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The PullRequest number</param>
/// <param name="pullRequestUpdate">An <see cref="PullRequestUpdate"/> instance describing the changes to make to the PullRequest
/// </param>
/// <returns>An updated <see cref="PullRequest"/> result</returns>
Task<PullRequest> Update(int repositoryId, int number, PullRequestUpdate pullRequestUpdate);
/// <summary>
/// Merge a pull request.
/// </summary>
@@ -103,6 +184,16 @@ namespace Octokit
/// <returns>An <see cref="PullRequestMerge"/> result which indicates the merge result</returns>
Task<PullRequestMerge> Merge(string owner, string name, int number, MergePullRequest mergePullRequest);
/// <summary>
/// Merge a pull request.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="mergePullRequest">A <see cref="MergePullRequest"/> instance describing a pull request merge</param>
/// <returns>An <see cref="PullRequestMerge"/> result which indicates the merge result</returns>
Task<PullRequestMerge> Merge(int repositoryId, int number, MergePullRequest mergePullRequest);
/// <summary>
/// Get the pull request merge status.
/// </summary>
@@ -113,6 +204,15 @@ namespace Octokit
/// <returns>True if the operation has been merged, false otherwise</returns>
Task<bool> Merged(string owner, string name, int number);
/// <summary>
/// Get the pull request merge status.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>True if the operation has been merged, false otherwise</returns>
Task<bool> Merged(int repositoryId, int number);
/// <summary>
/// Get the list of commits on a pull request.
/// </summary>
@@ -123,6 +223,15 @@ namespace Octokit
/// <returns>A <see cref="IReadOnlyList{PullRequestCommit}"/> of <see cref="Commit"/>s which are part of this pull request</returns>
Task<IReadOnlyList<PullRequestCommit>> Commits(string owner, string name, int number);
/// <summary>
/// Get the list of commits on a pull request.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="IReadOnlyList{PullRequestCommit}"/> of <see cref="Commit"/>s which are part of this pull request</returns>
Task<IReadOnlyList<PullRequestCommit>> Commits(int repositoryId, int number);
/// <summary>
/// Get the list of files on a pull request.
/// </summary>
@@ -132,5 +241,14 @@ namespace Octokit
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="IReadOnlyList{PullRequestFile}"/> which are part of this pull request</returns>
Task<IReadOnlyList<PullRequestFile>> Files(string owner, string name, int number);
/// <summary>
/// Get the list of files on a pull request.
/// </summary>
/// <remarks>https://developer.github.com/v3/pulls/#list-pull-requests-files</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="IReadOnlyList{PullRequestFile}"/> which are part of this pull request</returns>
Task<IReadOnlyList<PullRequestFile>> Files(int repositoryId, int number);
}
}

193
Octokit/Clients/PullRequestsClient.cs
View File

@@ -4,6 +4,12 @@ using System.Threading.Tasks;
namespace Octokit
{
/// <summary>
/// A client for GitHub's Pull Requests API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/activity/notifications/">Pull Requests API documentation</a> for more information.
/// </remarks>
public class PullRequestsClient : ApiClient, IPullRequestsClient
{
public PullRequestsClient(IApiConnection apiConnection) : base(apiConnection)
@@ -31,6 +37,18 @@ namespace Octokit
return ApiConnection.Get<PullRequest>(ApiUrls.PullRequest(owner, name, number));
}
/// <summary>
/// Get a pull request by number.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#get-a-single-pull-request
/// </remarks>
/// <returns>A <see cref="PullRequest"/> result</returns>
public Task<PullRequest> Get(int repositoryId, int number)
{
return ApiConnection.Get<PullRequest>(ApiUrls.PullRequest(repositoryId, number));
}
/// <summary>
/// Get all open pull requests for the repository.
/// </summary>
@@ -48,6 +66,19 @@ namespace Octokit
return GetAllForRepository(owner, name, new PullRequestRequest(), ApiOptions.None);
}
/// <summary>
/// Get all open pull requests for the repository.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which are currently open</returns>
public Task<IReadOnlyList<PullRequest>> GetAllForRepository(int repositoryId)
{
return GetAllForRepository(repositoryId, new PullRequestRequest(), ApiOptions.None);
}
/// <summary>
/// Get all open pull requests for the repository.
/// </summary>
@@ -67,6 +98,22 @@ namespace Octokit
return GetAllForRepository(owner, name, new PullRequestRequest(), options);
}
/// <summary>
/// Get all open pull requests for the repository.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which are currently open</returns>
public Task<IReadOnlyList<PullRequest>> GetAllForRepository(int repositoryId, ApiOptions options)
{
Ensure.ArgumentNotNull(options, "options");
return GetAllForRepository(repositoryId, new PullRequestRequest(), options);
}
/// <summary>
/// Query pull requests for the repository based on criteria
/// </summary>
@@ -86,6 +133,22 @@ namespace Octokit
return GetAllForRepository(owner, name, request, ApiOptions.None);
}
/// <summary>
/// Query pull requests for the repository based on criteria
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which match the criteria</returns>
public Task<IReadOnlyList<PullRequest>> GetAllForRepository(int repositoryId, PullRequestRequest request)
{
Ensure.ArgumentNotNull(request, "request");
return GetAllForRepository(repositoryId, request, ApiOptions.None);
}
/// <summary>
/// Query pull requests for the repository based on criteria
/// </summary>
@@ -108,6 +171,25 @@ namespace Octokit
request.ToParametersDictionary(), options);
}
/// <summary>
/// Query pull requests for the repository based on criteria
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which match the criteria</returns>
public Task<IReadOnlyList<PullRequest>> GetAllForRepository(int repositoryId, PullRequestRequest request, ApiOptions options)
{
Ensure.ArgumentNotNull(request, "request");
Ensure.ArgumentNotNull(options, "options");
return ApiConnection.GetAll<PullRequest>(ApiUrls.PullRequests(repositoryId),
request.ToParametersDictionary(), options);
}
/// <summary>
/// Create a pull request for the specified repository.
/// </summary>
@@ -125,6 +207,20 @@ namespace Octokit
return ApiConnection.Post<PullRequest>(ApiUrls.PullRequests(owner, name), newPullRequest);
}
/// <summary>
/// Create a pull request for the specified repository.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#create-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="newPullRequest">A <see cref="NewPullRequest"/> instance describing the new PullRequest to create</param>
/// <returns>A <see cref="PullRequest"/> result which was created on the server</returns>
public Task<PullRequest> Create(int repositoryId, NewPullRequest newPullRequest)
{
Ensure.ArgumentNotNull(newPullRequest, "newPullRequest");
return ApiConnection.Post<PullRequest>(ApiUrls.PullRequests(repositoryId), newPullRequest);
}
/// <summary>
/// Create a pull request for the specified repository.
/// </summary>
@@ -144,6 +240,22 @@ namespace Octokit
return ApiConnection.Patch<PullRequest>(ApiUrls.PullRequest(owner, name, number), pullRequestUpdate);
}
/// <summary>
/// Create a pull request for the specified repository.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#update-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The PullRequest number</param>
/// <param name="pullRequestUpdate">An <see cref="PullRequestUpdate"/> instance describing the changes to make to the PullRequest
/// </param>
/// <returns>An updated <see cref="PullRequest"/> result</returns>
public Task<PullRequest> Update(int repositoryId, int number, PullRequestUpdate pullRequestUpdate)
{
Ensure.ArgumentNotNull(pullRequestUpdate, "pullRequestUpdate");
return ApiConnection.Patch<PullRequest>(ApiUrls.PullRequest(repositoryId, number), pullRequestUpdate);
}
/// <summary>
/// Merge a pull request.
/// </summary>
@@ -162,7 +274,41 @@ namespace Octokit
try
{
var endpoint = ApiUrls.MergePullRequest(owner, name, number);
return await ApiConnection.Put<PullRequestMerge>(endpoint, mergePullRequest,null,
return await ApiConnection.Put<PullRequestMerge>(endpoint, mergePullRequest, null,
AcceptHeaders.SquashCommitPreview).ConfigureAwait(false);
}
catch (ApiException ex)
{
if (ex.StatusCode == HttpStatusCode.MethodNotAllowed)
{
throw new PullRequestNotMergeableException(ex.HttpResponse);
}
if (ex.StatusCode == HttpStatusCode.Conflict)
{
throw new PullRequestMismatchException(ex.HttpResponse);
}
throw;
}
}
/// <summary>
/// Merge a pull request.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="mergePullRequest">A <see cref="MergePullRequest"/> instance describing a pull request merge</param>
/// <returns>An <see cref="PullRequestMerge"/> result which indicates the merge result</returns>
public async Task<PullRequestMerge> Merge(int repositoryId, int number, MergePullRequest mergePullRequest)
{
Ensure.ArgumentNotNull(mergePullRequest, "mergePullRequest");
try
{
var endpoint = ApiUrls.MergePullRequest(repositoryId, number);
return await ApiConnection.Put<PullRequestMerge>(endpoint, mergePullRequest, null,
AcceptHeaders.SquashCommitPreview).ConfigureAwait(false);
}
catch (ApiException ex)
@@ -206,6 +352,27 @@ namespace Octokit
}
}
/// <summary>
/// Get the pull request merge status.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>True if the operation has been merged, false otherwise</returns>
public async Task<bool> Merged(int repositoryId, int number)
{
try
{
var endpoint = ApiUrls.MergePullRequest(repositoryId, number);
var response = await Connection.Get<object>(endpoint, null, null).ConfigureAwait(false);
return response.HttpResponse.IsTrue();
}
catch (NotFoundException)
{
return false;
}
}
/// <summary>
/// Get the list of commits on a pull request.
/// </summary>
@@ -222,6 +389,18 @@ namespace Octokit
return ApiConnection.GetAll<PullRequestCommit>(ApiUrls.PullRequestCommits(owner, name, number));
}
/// <summary>
/// Get the list of commits on a pull request.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="IReadOnlyList{PullRequestCommit}"/> of <see cref="Commit"/>s which are part of this pull request</returns>
public Task<IReadOnlyList<PullRequestCommit>> Commits(int repositoryId, int number)
{
return ApiConnection.GetAll<PullRequestCommit>(ApiUrls.PullRequestCommits(repositoryId, number));
}
/// <summary>
/// Get the list of files on a pull request.
/// </summary>
@@ -237,5 +416,17 @@ namespace Octokit
return ApiConnection.GetAll<PullRequestFile>(ApiUrls.PullRequestFiles(owner, name, number));
}
/// <summary>
/// Get the list of files on a pull request.
/// </summary>
/// <remarks>https://developer.github.com/v3/pulls/#list-pull-requests-files</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="IReadOnlyList{PullRequestFile}"/> which are part of this pull request</returns>
public Task<IReadOnlyList<PullRequestFile>> Files(int repositoryId, int number)
{
return ApiConnection.GetAll<PullRequestFile>(ApiUrls.PullRequestFiles(repositoryId, number));
}
}
}