mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-20 14:15:12 +00:00
Add IObservableRepositoryCommentsClient as well as an implementation
This commit is contained in:
@@ -0,0 +1,72 @@
|
||||
using System;
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using System.Reactive;
|
||||
|
||||
namespace Octokit.Reactive
|
||||
{
|
||||
public interface IObservableRepositoryCommentsClient
|
||||
{
|
||||
/// <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="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")]
|
||||
IObservable<CommitComment> Get(string owner, string name, 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> GetForRepository(string owner, string name);
|
||||
|
||||
/// <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="owner">The owner of the repository</param>
|
||||
/// <param name="name">The name of the repository</param>
|
||||
/// <param name="number">The sha of the commit</param>
|
||||
/// <returns></returns>
|
||||
IObservable<CommitComment> GetForCommit(string owner, string name, string sha);
|
||||
|
||||
/// <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="owner">The owner of the repository</param>
|
||||
/// <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>
|
||||
/// Updates a specified Commit Comment.
|
||||
/// </summary>
|
||||
/// <remarks>http://developer.github.com/v3/repos/comments/#update-a-commit-comment</remarks>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <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>
|
||||
/// Deletes the specified Commit Comment
|
||||
/// </summary>
|
||||
/// <remarks>http://developer.github.com/v3/repos/comments/#delete-a-commit-comment</remarks>
|
||||
/// <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);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user