zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2025-12-21 06:35:11 +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

125
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")]
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);
}
}