zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2026-06-03 03:01:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add repositoryId overloads to methods on I(Observable)RepositoryCommentsClient (#1344)

Browse Source
This commit is contained in:
Alexander Efremov
2016-06-18 04:47:43 +07:00
committed by Brendan Forster
parent 637802c90a
commit 6bd1f06962
7 changed files with 986 additions and 134 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit.Reactive/Clients/IObservableRepositoryCommentsClient.cs
+75 -9
View File
@@ -4,6 +4,12 @@ using System.Reactive;
namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Repository Comments API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/repos/comments/">Repository Comments API documentation</a> for more information.
/// </remarks>
public interface IObservableRepositoryCommentsClient
{
/// <summary>
@@ -13,20 +19,35 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The comment id</param>
/// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
Justification = "Method makes a network request")]
IObservable<CommitComment> Get(string owner, string name, int number);
/// <summary>
/// Gets a single Repository Comment by number.
/// </summary>
/// <remarks>http://developer.github.com/v3/repos/comments/#get-a-single-commit-comment</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The comment id</param>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
IObservable<CommitComment> Get(int repositoryId, int number);
/// <summary>
/// Gets Commit Comments for a repository.
/// </summary>
/// <remarks>http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns></returns>
IObservable<CommitComment> GetAllForRepository(string owner, string name);
/// <summary>
/// Gets Commit Comments for a repository.
/// </summary>
/// <remarks>http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository</remarks>
/// <param name="repositoryId">The ID of the repository</param>
IObservable<CommitComment> GetAllForRepository(int repositoryId);
/// <summary>
/// Gets Commit Comments for a repository.
/// </summary>
@@ -34,9 +55,16 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="options">Options to change the API response</param>
/// <returns></returns>
IObservable<CommitComment> GetAllForRepository(string owner, string name, ApiOptions options);
/// <summary>
/// Gets Commit Comments for a repository.
/// </summary>
/// <remarks>http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="options">Options to change the API response</param>
IObservable<CommitComment> GetAllForRepository(int repositoryId, ApiOptions options);
/// <summary>
/// Gets Commit Comments for a specified Commit.
/// </summary>
@@ -44,9 +72,16 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="sha">The sha of the commit</param>
/// <returns></returns>
IObservable<CommitComment> GetAllForCommit(string owner, string name, string sha);
/// <summary>
/// Gets Commit Comments for a specified Commit.
/// </summary>
/// <remarks>http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="sha">The sha of the commit</param>
IObservable<CommitComment> GetAllForCommit(int repositoryId, string sha);
/// <summary>
/// Gets Commit Comments for a specified Commit.
/// </summary>
@@ -55,9 +90,17 @@ namespace Octokit.Reactive
/// <param name="name">The name of the repository</param>
/// <param name="sha">The sha of the commit</param>
/// <param name="options">Options to change the API response</param>
/// <returns></returns>
IObservable<CommitComment> GetAllForCommit(string owner, string name, string sha, ApiOptions options);
/// <summary>
/// Gets Commit Comments for a specified Commit.
/// </summary>
/// <remarks>http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="sha">The sha of the commit</param>
/// <param name="options">Options to change the API response</param>
IObservable<CommitComment> GetAllForCommit(int repositoryId, string sha, ApiOptions options);
/// <summary>
/// Creates a new Commit Comment for a specified Commit.
/// </summary>
@@ -66,9 +109,17 @@ namespace Octokit.Reactive
/// <param name="name">The name of the repository</param>
/// <param name="sha">The sha reference of commit</param>
/// <param name="newCommitComment">The new comment to add to the commit</param>
/// <returns></returns>
IObservable<CommitComment> Create(string owner, string name, string sha, NewCommitComment newCommitComment);
/// <summary>
/// Creates a new Commit Comment for a specified Commit.
/// </summary>
/// <remarks>http://developer.github.com/v3/repos/comments/#create-a-commit-comment</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="sha">The sha reference of commit</param>
/// <param name="newCommitComment">The new comment to add to the commit</param>
IObservable<CommitComment> Create(int repositoryId, string sha, NewCommitComment newCommitComment);
/// <summary>
/// Updates a specified Commit Comment.
/// </summary>
@@ -77,9 +128,17 @@ namespace Octokit.Reactive
/// <param name="name">The name of the repository</param>
/// <param name="number">The comment number</param>
/// <param name="commentUpdate">The modified comment</param>
/// <returns></returns>
IObservable<CommitComment> Update(string owner, string name, int number, string commentUpdate);
/// <summary>
/// Updates a specified Commit Comment.
/// </summary>
/// <remarks>http://developer.github.com/v3/repos/comments/#update-a-commit-comment</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The comment number</param>
/// <param name="commentUpdate">The modified comment</param>
IObservable<CommitComment> Update(int repositoryId, int number, string commentUpdate);
/// <summary>
/// Deletes the specified Commit Comment
/// </summary>
@@ -87,7 +146,14 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The comment id</param>
/// <returns></returns>
IObservable<Unit> Delete(string owner, string name, int number);
/// <summary>
/// Deletes the specified Commit Comment
/// </summary>
/// <remarks>http://developer.github.com/v3/repos/comments/#delete-a-commit-comment</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The comment id</param>
IObservable<Unit> Delete(int repositoryId, int number);
}
}