diff --git a/Octokit/Clients/GistCommentsClient.cs b/Octokit/Clients/GistCommentsClient.cs
index a9c705ef..aa717cb6 100644
--- a/Octokit/Clients/GistCommentsClient.cs
+++ b/Octokit/Clients/GistCommentsClient.cs
@@ -9,6 +9,13 @@ namespace Octokit
{
}
+ ///
+ /// Gets a single comment by gist- and comment id.
+ ///
+ /// http://developer.github.com/v3/gists/comments/#get-a-single-comment
+ /// The id of the gist
+ /// The id of the comment
+ /// Task{GistComment}.
public Task Get(string gistId, string commentId)
{
Ensure.ArgumentNotNullOrEmptyString(gistId, "gistId");
@@ -17,6 +24,12 @@ namespace Octokit
return ApiConnection.Get(ApiUrls.GistComment(gistId, commentId));
}
+ ///
+ /// Gets all comments for the gist with the specified id.
+ ///
+ /// http://developer.github.com/v3/gists/comments/#list-comments-on-a-gist
+ /// The id of the gist
+ /// Task{IReadOnlyList{GistComment}}.
public Task> GetForGist(string gistId)
{
Ensure.ArgumentNotNullOrEmptyString(gistId, "gistId");
@@ -24,6 +37,13 @@ namespace Octokit
return ApiConnection.GetAll(ApiUrls.GistComments(gistId));
}
+ ///
+ /// Creates a comment for the gist with the specified id.
+ ///
+ /// http://developer.github.com/v3/gists/comments/#create-a-comment
+ /// The id of the gist
+ /// The body of the comment
+ /// Task{GistComment}.
public Task Create(string gistId, string comment)
{
Ensure.ArgumentNotNullOrEmptyString(gistId, "gistId");
@@ -32,6 +52,14 @@ namespace Octokit
return ApiConnection.Post(ApiUrls.GistComments(gistId), comment);
}
+ ///
+ /// Updates the comment with the specified gist- and comment id.
+ ///
+ /// http://developer.github.com/v3/gists/comments/#edit-a-comment
+ /// The id of the gist
+ /// The id of the comment
+ /// The updated body of the comment
+ /// Task{GistComment}.
public Task Update(string gistId, string commentId, string comment)
{
Ensure.ArgumentNotNullOrEmptyString(gistId, "gistId");
@@ -41,6 +69,13 @@ namespace Octokit
return ApiConnection.Patch(ApiUrls.GistComment(gistId, commentId), comment);
}
+ ///
+ /// Deletes the comment with the specified gist- and comment id.
+ ///
+ /// http://developer.github.com/v3/gists/comments/#delete-a-comment
+ /// The id of the gist
+ /// The id of the comment
+ /// Task.
public Task Delete(string gistId, string commentId)
{
Ensure.ArgumentNotNullOrEmptyString(gistId, "gistId");
diff --git a/Octokit/Clients/IGistCommentsClient.cs b/Octokit/Clients/IGistCommentsClient.cs
index fbf0d55b..49005986 100644
--- a/Octokit/Clients/IGistCommentsClient.cs
+++ b/Octokit/Clients/IGistCommentsClient.cs
@@ -6,12 +6,51 @@ namespace Octokit
{
public interface IGistCommentsClient
{
+ ///
+ /// Gets a single comment by gist- and comment id.
+ ///
+ /// http://developer.github.com/v3/gists/comments/#get-a-single-comment
+ /// The id of the gist
+ /// The id of the comment
+ /// Task{GistComment}.
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
Task Get(string gistId, string commentId);
+
+ ///
+ /// Gets all comments for the gist with the specified id.
+ ///
+ /// http://developer.github.com/v3/gists/comments/#list-comments-on-a-gist
+ /// The id of the gist
+ /// Task{IReadOnlyList{GistComment}}.
Task> GetForGist(string gistId);
+
+ ///
+ /// Creates a comment for the gist with the specified id.
+ ///
+ /// http://developer.github.com/v3/gists/comments/#create-a-comment
+ /// The id of the gist
+ /// The body of the comment
+ /// Task{GistComment}.
Task Create(string gistId, string comment);
+
+ ///
+ /// Updates the comment with the specified gist- and comment id.
+ ///
+ /// http://developer.github.com/v3/gists/comments/#edit-a-comment
+ /// The id of the gist
+ /// The id of the comment
+ /// The updated body of the comment
+ /// Task{GistComment}.
Task Update(string gistId, string commentId, string comment);
+
+ ///
+ /// Deletes the comment with the specified gist- and comment id.
+ ///
+ /// http://developer.github.com/v3/gists/comments/#delete-a-comment
+ /// The id of the gist
+ /// The id of the comment
+ /// Task.
Task Delete(string gistId, string commentId);
}
}