diff --git a/Octokit.Reactive/Clients/IObservableDeploymentStatusClient.cs b/Octokit.Reactive/Clients/IObservableDeploymentStatusClient.cs index 2b67fae7..b069eade 100644 --- a/Octokit.Reactive/Clients/IObservableDeploymentStatusClient.cs +++ b/Octokit.Reactive/Clients/IObservableDeploymentStatusClient.cs @@ -2,6 +2,13 @@ using System; namespace Octokit.Reactive { + /// + /// A client for GitHub's Repository Deployment Statuses API. + /// Gets and creates Deployment Statuses. + /// + /// + /// See the Repository Deployment Statuses API documentation for more information. + /// public interface IObservableDeploymentStatusClient { /// @@ -14,7 +21,7 @@ namespace Octokit.Reactive /// The owner of the repository. /// The name of the repository. /// The id of the deployment. - /// All deployment statuses for the given deployment. + /// A of es for the given deployment. IObservable GetAll(string owner, string name, int deploymentId); /// @@ -28,7 +35,7 @@ namespace Octokit.Reactive /// The name of the repository. /// The id of the deployment. /// Options for changing the API response - /// All deployment statuses for the given deployment. + /// A of es for the given deployment. IObservable GetAll(string owner, string name, int deploymentId, ApiOptions options); /// @@ -42,7 +49,7 @@ namespace Octokit.Reactive /// The name of the repository. /// The id of the deployment. /// The new deployment status to create. - /// + /// A representing created deployment status. IObservable Create(string owner, string name, int deploymentId, NewDeploymentStatus newDeploymentStatus); } } \ No newline at end of file diff --git a/Octokit.Reactive/Clients/ObservableDeploymentStatusClient.cs b/Octokit.Reactive/Clients/ObservableDeploymentStatusClient.cs index 8295f6b0..3da21c7b 100644 --- a/Octokit.Reactive/Clients/ObservableDeploymentStatusClient.cs +++ b/Octokit.Reactive/Clients/ObservableDeploymentStatusClient.cs @@ -4,6 +4,13 @@ using Octokit.Reactive.Internal; namespace Octokit.Reactive.Clients { + /// + /// A client for GitHub's Repository Deployment Statuses API. + /// Gets and creates Deployment Statuses. + /// + /// + /// See the Repository Deployment Statuses API documentation for more information. + /// public class ObservableDeploymentStatusClient : IObservableDeploymentStatusClient { private readonly IDeploymentStatusClient _client; @@ -27,7 +34,7 @@ namespace Octokit.Reactive.Clients /// The owner of the repository. /// The name of the repository. /// The id of the deployment. - /// All deployment statuses for the given deployment. + /// A of es for the given deployment. public IObservable GetAll(string owner, string name, int deploymentId) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -47,7 +54,7 @@ namespace Octokit.Reactive.Clients /// The name of the repository. /// The id of the deployment. /// Options for changing the API response - /// All deployment statuses for the given deployment. + /// A of es for the given deployment. public IObservable GetAll(string owner, string name, int deploymentId, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -69,7 +76,7 @@ namespace Octokit.Reactive.Clients /// The name of the repository. /// The id of the deployment. /// The new deployment status to create. - /// + /// A representing created deployment status. public IObservable Create(string owner, string name, int deploymentId, NewDeploymentStatus newDeploymentStatus) { return _client.Create(owner, name, deploymentId, newDeploymentStatus).ToObservable(); diff --git a/Octokit/Clients/DeploymentStatusClient.cs b/Octokit/Clients/DeploymentStatusClient.cs index 7495c462..9b12c99d 100644 --- a/Octokit/Clients/DeploymentStatusClient.cs +++ b/Octokit/Clients/DeploymentStatusClient.cs @@ -27,7 +27,7 @@ namespace Octokit /// The owner of the repository. /// The name of the repository. /// The id of the deployment. - /// All deployment statuses for the given deployment. + /// A of es for the given deployment. public Task> GetAll(string owner, string name, int deploymentId) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -47,7 +47,7 @@ namespace Octokit /// The name of the repository. /// The id of the deployment. /// Options for changing the API response - /// All deployment statuses for the given deployment. + /// A of es for the given deployment. public Task> GetAll(string owner, string name, int deploymentId, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -71,7 +71,7 @@ namespace Octokit /// The name of the repository. /// The id of the deployment. /// - /// + /// A representing created deployment status. public Task Create(string owner, string name, int deploymentId, NewDeploymentStatus newDeploymentStatus) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); diff --git a/Octokit/Clients/IDeploymentStatusClient.cs b/Octokit/Clients/IDeploymentStatusClient.cs index 077c17c1..cead485e 100644 --- a/Octokit/Clients/IDeploymentStatusClient.cs +++ b/Octokit/Clients/IDeploymentStatusClient.cs @@ -22,7 +22,7 @@ namespace Octokit /// The owner of the repository. /// The name of the repository. /// The id of the deployment. - /// All deployment statuses for the given deployment. + /// A of es for the given deployment. Task> GetAll(string owner, string name, int deploymentId); /// @@ -36,7 +36,7 @@ namespace Octokit /// The name of the repository. /// The id of the deployment. /// Options for changing the API response - /// All deployment statuses for the given deployment. + /// A of es for the given deployment. Task> GetAll(string owner, string name, int deploymentId, ApiOptions options); /// @@ -50,7 +50,7 @@ namespace Octokit /// The name of the repository. /// The id of the deployment. /// - /// + /// A representing created deployment status. Task Create(string owner, string name, int deploymentId, NewDeploymentStatus newDeploymentStatus); } } \ No newline at end of file