zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2026-06-05 11:40:42 +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
Octokit/Clients/IPullRequestsClient.cs
+119 -1
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>
@@ -19,9 +25,20 @@ namespace Octokit
/// </remarks>
/// <returns>A <see cref="PullRequest"/> result</returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
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);
}
}