Issue comments are identified by Id instead of Number

This commit is contained in:
Gabriel Weyer
2015-12-23 12:17:04 +11:00
parent b7e0a35a0c
commit cbd9e76cb2
5 changed files with 37 additions and 37 deletions
@@ -7,16 +7,16 @@ namespace Octokit.Reactive
public interface IObservableIssueCommentsClient
{
/// <summary>
/// Gets a single Issue Comment by number.
/// Gets a single Issue Comment by id.
/// </summary>
/// <remarks>http://developer.github.com/v3/issues/comments/#get-a-single-comment</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue comment number</param>
/// <param name="id">The issue comment id</param>
/// <returns>The <see cref="IssueComment"/>s for the specified Issue Comment.</returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
IObservable<IssueComment> Get(string owner, string name, int number);
IObservable<IssueComment> Get(string owner, string name, int id);
/// <summary>
/// Gets Issue Comments for a repository.
@@ -54,10 +54,10 @@ namespace Octokit.Reactive
/// <remarks>http://developer.github.com/v3/issues/comments/#edit-a-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="id">The comment id</param>
/// <param name="commentUpdate">The modified comment</param>
/// <returns>The <see cref="IssueComment"/> that was just updated.</returns>
IObservable<IssueComment> Update(string owner, string name, int number, string commentUpdate);
IObservable<IssueComment> Update(string owner, string name, int id, string commentUpdate);
/// <summary>
/// Deletes the specified Issue Comment
@@ -65,8 +65,8 @@ namespace Octokit.Reactive
/// <remarks>http://developer.github.com/v3/issues/comments/#delete-a-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="id">The comment id</param>
/// <returns></returns>
IObservable<Unit> Delete(string owner, string name, int number);
IObservable<Unit> Delete(string owner, string name, int id);
}
}