diff --git a/Octokit.Reactive/Clients/IObservableCommitStatusClient.cs b/Octokit.Reactive/Clients/IObservableCommitStatusClient.cs index b1a970fb..6a2efe16 100644 --- a/Octokit.Reactive/Clients/IObservableCommitStatusClient.cs +++ b/Octokit.Reactive/Clients/IObservableCommitStatusClient.cs @@ -2,6 +2,12 @@ namespace Octokit.Reactive { + /// + /// A client for GitHub's Git Repository Status API. + /// + /// + /// See the Repository Statuses API documentation for more information. + /// public interface IObservableCommitStatusClient { /// @@ -12,7 +18,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// The reference (SHA, branch name, or tag name) to list commits for - /// + /// A of es representing commit statuses for specified repository IObservable GetAll(string owner, string name, string reference); /// @@ -24,7 +30,7 @@ namespace Octokit.Reactive /// The name of the repository /// The reference (SHA, branch name, or tag name) to list commits for /// Options for changing the API response - /// + /// A of es representing commit statuses for specified repository IObservable GetAll(string owner, string name, string reference, ApiOptions options); /// @@ -35,7 +41,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// The reference (SHA, branch name, or tag name) to list commits for - /// + /// A of representing combined commit status for specified repository IObservable GetCombined(string owner, string name, string reference); /// @@ -44,8 +50,8 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// The reference (SHA, branch name, or tag name) to list commits for - /// The commit status to create - /// - IObservable Create(string owner, string name, string reference, NewCommitStatus commitStatus); + /// The commit status to create + /// A of representing created commit status for specified repository + IObservable Create(string owner, string name, string reference, NewCommitStatus newCommitStatus); } } diff --git a/Octokit.Reactive/Clients/ObservableCommitStatusClient.cs b/Octokit.Reactive/Clients/ObservableCommitStatusClient.cs index e34ed7a9..8d00f5f9 100644 --- a/Octokit.Reactive/Clients/ObservableCommitStatusClient.cs +++ b/Octokit.Reactive/Clients/ObservableCommitStatusClient.cs @@ -4,6 +4,12 @@ using Octokit.Reactive.Internal; namespace Octokit.Reactive { + /// + /// A client for GitHub's Git Repository Status API. + /// + /// + /// See the Repository Statuses API documentation for more information. + /// public class ObservableCommitStatusClient : IObservableCommitStatusClient { readonly ICommitStatusClient _client; @@ -25,7 +31,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// The reference (SHA, branch name, or tag name) to list commits for - /// + /// A of es representing commit statuses for specified repository public IObservable GetAll(string owner, string name, string reference) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -44,7 +50,7 @@ namespace Octokit.Reactive /// The name of the repository /// The reference (SHA, branch name, or tag name) to list commits for /// Options for changing the API response - /// + /// A of es representing commit statuses for specified repository public IObservable GetAll(string owner, string name, string reference, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -63,9 +69,13 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// The reference (SHA, branch name, or tag name) to list commits for - /// + /// A of representing combined commit status for specified repository public IObservable GetCombined(string owner, string name, string reference) { + Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); + Ensure.ArgumentNotNullOrEmptyString(name, "name"); + Ensure.ArgumentNotNullOrEmptyString(reference, "reference"); + return _client.GetCombined(owner, name, reference).ToObservable(); } @@ -75,11 +85,16 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// The reference (SHA, branch name, or tag name) to list commits for - /// The commit status to create - /// - public IObservable Create(string owner, string name, string reference, NewCommitStatus commitStatus) + /// The commit status to create + /// A of representing created commit status for specified repository + public IObservable Create(string owner, string name, string reference, NewCommitStatus newCommitStatus) { - return _client.Create(owner, name, reference, commitStatus).ToObservable(); + Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); + Ensure.ArgumentNotNullOrEmptyString(name, "name"); + Ensure.ArgumentNotNullOrEmptyString(reference, "reference"); + Ensure.ArgumentNotNull(newCommitStatus, "commitStatus"); + + return _client.Create(owner, name, reference, newCommitStatus).ToObservable(); } } } diff --git a/Octokit/Clients/CommitStatusClient.cs b/Octokit/Clients/CommitStatusClient.cs index b890bdff..9c3acad3 100644 --- a/Octokit/Clients/CommitStatusClient.cs +++ b/Octokit/Clients/CommitStatusClient.cs @@ -29,7 +29,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The reference (SHA, branch name, or tag name) to list commits for - /// + /// A of es representing commit statuses for specified repository public Task> GetAll(string owner, string name, string reference) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -50,7 +50,7 @@ namespace Octokit /// The name of the repository /// The reference (SHA, branch name, or tag name) to list commits for /// Options for changing the API response - /// + /// A of es representing commit statuses for specified repository public Task> GetAll(string owner, string name, string reference, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -71,7 +71,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The reference (SHA, branch name, or tag name) to list commits for - /// + /// A representing combined commit status for specified repository public Task GetCombined(string owner, string name, string reference) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -90,16 +90,16 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The reference (SHA, branch name, or tag name) to list commits for - /// The commit status to create - /// - public Task Create(string owner, string name, string reference, NewCommitStatus commitStatus) + /// The commit status to create + /// A representing created commit status for specified repository + public Task Create(string owner, string name, string reference, NewCommitStatus newCommitStatus) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(name, "name"); Ensure.ArgumentNotNullOrEmptyString(reference, "reference"); - Ensure.ArgumentNotNull(commitStatus, "commitStatus"); + Ensure.ArgumentNotNull(newCommitStatus, "newCommitStatus"); - return ApiConnection.Post(ApiUrls.CreateCommitStatus(owner, name, reference), commitStatus); + return ApiConnection.Post(ApiUrls.CreateCommitStatus(owner, name, reference), newCommitStatus); } } } diff --git a/Octokit/Clients/ICommitStatusClient.cs b/Octokit/Clients/ICommitStatusClient.cs index eb3c7209..980c7441 100644 --- a/Octokit/Clients/ICommitStatusClient.cs +++ b/Octokit/Clients/ICommitStatusClient.cs @@ -21,7 +21,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The reference (SHA, branch name, or tag name) to list commits for - /// + /// A of es representing commit statuses for specified repository Task> GetAll(string owner, string name, string reference); /// @@ -35,7 +35,7 @@ namespace Octokit /// The name of the repository /// The reference (SHA, branch name, or tag name) to list commits for /// Options for changing the API response - /// + /// A of es representing commit statuses for specified repository Task> GetAll(string owner, string name, string reference, ApiOptions options); /// @@ -48,7 +48,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The reference (SHA, branch name, or tag name) to list commits for - /// + /// A representing combined commit status for specified repository Task GetCombined(string owner, string name, string reference); /// @@ -60,8 +60,8 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The reference (SHA, branch name, or tag name) to list commits for - /// The commit status to create - /// - Task Create(string owner, string name, string reference, NewCommitStatus commitStatus); + /// The commit status to create + /// A representing created commit status for specified repository + Task Create(string owner, string name, string reference, NewCommitStatus newCommitStatus); } }