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

Merge pull request #1027 from gabrielweyer/issue-comment-id-not-number

Browse Source 
Issue comments are identified by Id instead of Number
This commit is contained in:
Brendan Forster
2015-12-23 12:27:30 +10:30
parent b7e0a35a0c c98c865aff
commit 2ede6e2b26
5 changed files with 37 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit.Reactive/Clients/IObservableIssueCommentsClient.cs
+7 -7
View File
@@ -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);
}
}
Octokit.Reactive/Clients/ObservableIssueCommentsClient.cs
+10 -10
View File
@@ -19,19 +19,19 @@ namespace Octokit.Reactive
}
/// <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>
public IObservable<IssueComment> Get(string owner, string name, int number)
public IObservable<IssueComment> Get(string owner, string name, int id)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "name");
return _client.Get(owner, name, number).ToObservable();
return _client.Get(owner, name, id).ToObservable();
}
/// <summary>
@@ -89,16 +89,16 @@ 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>
public IObservable<IssueComment> Update(string owner, string name, int number, string commentUpdate)
public IObservable<IssueComment> Update(string owner, string name, int id, string commentUpdate)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "name");
Ensure.ArgumentNotNull(commentUpdate, "commentUpdate");
return _client.Update(owner, name, number, commentUpdate).ToObservable();
return _client.Update(owner, name, id, commentUpdate).ToObservable();
}
/// <summary>
@@ -107,14 +107,14 @@ 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>
public IObservable<Unit> Delete(string owner, string name, int number)
public IObservable<Unit> Delete(string owner, string name, int id)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "name");
return _client.Delete(owner, name, number).ToObservable();
return _client.Delete(owner, name, id).ToObservable();
}
}
}
Octokit/Clients/IIssueCommentsClient.cs
+7 -7
View File
@@ -13,16 +13,16 @@ namespace Octokit
public interface IIssueCommentsClient
{
/// <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 number</param>
/// <param name="id">The issue comment id</param>
/// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
Task<IssueComment> Get(string owner, string name, int number);
Task<IssueComment> Get(string owner, string name, int id);
/// <summary>
/// Gets Issue Comments for a repository.
@@ -60,10 +60,10 @@ namespace Octokit
/// <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></returns>
Task<IssueComment> Update(string owner, string name, int number, string commentUpdate);
Task<IssueComment> Update(string owner, string name, int id, string commentUpdate);
/// <summary>
/// Deletes the specified Issue Comment
@@ -71,8 +71,8 @@ namespace Octokit
/// <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>
Task Delete(string owner, string name, int number);
Task Delete(string owner, string name, int id);
}
}
Octokit/Clients/IssueCommentsClient.cs
+10 -10
View File
@@ -20,19 +20,19 @@ namespace Octokit
}
/// <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 number</param>
/// <param name="id">The issue comment id</param>
/// <returns></returns>
public Task<IssueComment> Get(string owner, string name, int number)
public Task<IssueComment> Get(string owner, string name, int id)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "name");
return ApiConnection.Get<IssueComment>(ApiUrls.IssueComment(owner, name, number));
return ApiConnection.Get<IssueComment>(ApiUrls.IssueComment(owner, name, id));
}
/// <summary>
@@ -90,16 +90,16 @@ namespace Octokit
/// <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></returns>
public Task<IssueComment> Update(string owner, string name, int number, string commentUpdate)
public Task<IssueComment> Update(string owner, string name, int id, string commentUpdate)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "name");
Ensure.ArgumentNotNull(commentUpdate, "commentUpdate");
return ApiConnection.Patch<IssueComment>(ApiUrls.IssueComment(owner, name, number), new BodyWrapper(commentUpdate));
return ApiConnection.Patch<IssueComment>(ApiUrls.IssueComment(owner, name, id), new BodyWrapper(commentUpdate));
}
/// <summary>
@@ -108,14 +108,14 @@ namespace Octokit
/// <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>
public Task Delete(string owner, string name, int number)
public Task Delete(string owner, string name, int id)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "name");
return ApiConnection.Delete(ApiUrls.IssueComment(owner, name, number));
return ApiConnection.Delete(ApiUrls.IssueComment(owner, name, id));
}
}
}
Octokit/Helpers/ApiUrls.cs
+3 -3
View File
@@ -285,11 +285,11 @@ namespace Octokit
/// </summary>
/// <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>
public static Uri IssueComment(string owner, string name, int number)
public static Uri IssueComment(string owner, string name, int id)
{
return "repos/{0}/{1}/issues/comments/{2}".FormatUri(owner, name, number);
return "repos/{0}/{1}/issues/comments/{2}".FormatUri(owner, name, id);
}
/// <summary>