diff --git a/Octokit.Reactive/Clients/IObservableRepositoryPagesClient.cs b/Octokit.Reactive/Clients/IObservableRepositoryPagesClient.cs index 1293eb31..0de69772 100644 --- a/Octokit.Reactive/Clients/IObservableRepositoryPagesClient.cs +++ b/Octokit.Reactive/Clients/IObservableRepositoryPagesClient.cs @@ -3,52 +3,58 @@ using System.Diagnostics.CodeAnalysis; namespace Octokit.Reactive { + /// + /// A client for GitHub's Repository Pages API. + /// + /// + /// See the Repository Pages API documentation for more information. + /// public interface IObservableRepositoryPagesClient { /// /// Gets the page metadata for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// - /// + /// A of representing page metadata of specified repository. [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")] - IObservable Get(string owner, string repositoryName); + IObservable Get(string owner, string name); /// /// Gets all build metadata for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// - /// - IObservable GetAll(string owner, string repositoryName); + /// A of s representing pages build metadata of specified repository. + IObservable GetAll(string owner, string name); /// /// Gets all build metadata for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// Options to change the API response /// /// See the API documentation for more information. /// - /// - IObservable GetAll(string owner, string repositoryName, ApiOptions options); + /// A of s representing pages build metadata of specified repository. + IObservable GetAll(string owner, string name, ApiOptions options); /// /// Gets the build metadata for the last build for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// - /// - IObservable GetLatest(string owner, string repositoryName); + /// A of representing latest pages build metadata of specified repository. + IObservable GetLatest(string owner, string name); } } diff --git a/Octokit.Reactive/Clients/ObservableRepositoryPagesClient.cs b/Octokit.Reactive/Clients/ObservableRepositoryPagesClient.cs index 28d06ccc..432abd48 100644 --- a/Octokit.Reactive/Clients/ObservableRepositoryPagesClient.cs +++ b/Octokit.Reactive/Clients/ObservableRepositoryPagesClient.cs @@ -5,6 +5,12 @@ using System.Reactive.Threading.Tasks; namespace Octokit.Reactive { + /// + /// A client for GitHub's Repository Pages API. + /// + /// + /// See the Repository Pages API documentation for more information. + /// public class ObservableRepositoryPagesClient : IObservableRepositoryPagesClient { readonly IRepositoryPagesClient _client; @@ -22,71 +28,71 @@ namespace Octokit.Reactive /// Gets the page metadata for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// - /// + /// A of representing page metadata of specified repository. [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")] - public IObservable Get(string owner, string repositoryName) + public IObservable Get(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); - Ensure.ArgumentNotNullOrEmptyString(repositoryName, "repositoryName"); + Ensure.ArgumentNotNullOrEmptyString(name, "name"); - return _client.Get(owner, repositoryName).ToObservable(); + return _client.Get(owner, name).ToObservable(); } /// /// Gets all build metadata for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// - /// - public IObservable GetAll(string owner, string repositoryName) + /// A of s representing pages build metadata of specified repository. + public IObservable GetAll(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); - Ensure.ArgumentNotNullOrEmptyString(repositoryName, "repositoryName"); + Ensure.ArgumentNotNullOrEmptyString(name, "name"); - return GetAll(owner, repositoryName, ApiOptions.None); + return GetAll(owner, name, ApiOptions.None); } /// /// Gets all build metadata for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// Options to change the API response /// /// See the API documentation for more information. /// - /// - public IObservable GetAll(string owner, string repositoryName, ApiOptions options) + /// A of s representing pages build metadata of specified repository. + public IObservable GetAll(string owner, string name, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); - Ensure.ArgumentNotNullOrEmptyString(repositoryName, "repositoryName"); + Ensure.ArgumentNotNullOrEmptyString(name, "name"); Ensure.ArgumentNotNull(options, "options"); - return _connection.GetAndFlattenAllPages(ApiUrls.RepositoryPageBuilds(owner, repositoryName), options); + return _connection.GetAndFlattenAllPages(ApiUrls.RepositoryPageBuilds(owner, name), options); } /// /// Gets the build metadata for the last build for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// - /// - public IObservable GetLatest(string owner, string repositoryName) + /// A of representing latest pages build metadata of specified repository. + public IObservable GetLatest(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); - Ensure.ArgumentNotNullOrEmptyString(repositoryName, "repositoryName"); + Ensure.ArgumentNotNullOrEmptyString(name, "name"); - return _client.GetLatest(owner, repositoryName).ToObservable(); + return _client.GetLatest(owner, name).ToObservable(); } } } diff --git a/Octokit/Clients/IRepositoryPagesClient.cs b/Octokit/Clients/IRepositoryPagesClient.cs index 0716152a..f58aa82e 100644 --- a/Octokit/Clients/IRepositoryPagesClient.cs +++ b/Octokit/Clients/IRepositoryPagesClient.cs @@ -16,46 +16,46 @@ namespace Octokit /// Gets the page metadata for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// - /// + /// A representing page metadata of specified repository. [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")] - Task Get(string owner, string repositoryName); + Task Get(string owner, string name); /// /// Gets all build metadata for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// - /// - Task> GetAll(string owner, string repositoryName); + /// A of s representing pages build metadata of specified repository. + Task> GetAll(string owner, string name); /// /// Gets all build metadata for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// Options to change the API response /// /// See the API documentation for more information. /// - /// - Task> GetAll(string owner, string repositoryName, ApiOptions options); + /// A of s representing pages build metadata of specified repository. + Task> GetAll(string owner, string name, ApiOptions options); /// /// Gets the build metadata for the last build for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// - /// - Task GetLatest(string owner, string repositoryName); + /// A representing latest pages build metadata of specified repository. + Task GetLatest(string owner, string name); } -} \ No newline at end of file +} diff --git a/Octokit/Clients/RepositoryPagesClient.cs b/Octokit/Clients/RepositoryPagesClient.cs index 9958daef..87c4c79b 100644 --- a/Octokit/Clients/RepositoryPagesClient.cs +++ b/Octokit/Clients/RepositoryPagesClient.cs @@ -23,53 +23,53 @@ namespace Octokit /// Gets the page metadata for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// - /// - public Task Get(string owner, string repositoryName) + /// A representing page metadata of specified repository. + public Task Get(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); - Ensure.ArgumentNotNullOrEmptyString(repositoryName, "repositoryName"); + Ensure.ArgumentNotNullOrEmptyString(name, "name"); - return ApiConnection.Get(ApiUrls.RepositoryPage(owner, repositoryName)); + return ApiConnection.Get(ApiUrls.RepositoryPage(owner, name)); } /// /// Gets all build metadata for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// - /// - public Task> GetAll(string owner, string repositoryName) + /// A of s representing pages build metadata of specified repository. + public Task> GetAll(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); - Ensure.ArgumentNotNullOrEmptyString(repositoryName, "repositoryName"); + Ensure.ArgumentNotNullOrEmptyString(name, "name"); - return GetAll(owner, repositoryName, ApiOptions.None); + return GetAll(owner, name, ApiOptions.None); } /// /// Gets all build metadata for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// Options to change the API response /// /// See the API documentation for more information. /// - /// - public Task> GetAll(string owner, string repositoryName, ApiOptions options) + /// A of s representing pages build metadata of specified repository. + public Task> GetAll(string owner, string name, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); - Ensure.ArgumentNotNullOrEmptyString(repositoryName, "repositoryName"); + Ensure.ArgumentNotNullOrEmptyString(name, "name"); Ensure.ArgumentNotNull(options, "options"); - var endpoint = ApiUrls.RepositoryPageBuilds(owner, repositoryName); + var endpoint = ApiUrls.RepositoryPageBuilds(owner, name); return ApiConnection.GetAll(endpoint, options); } @@ -77,17 +77,17 @@ namespace Octokit /// Gets the build metadata for the last build for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// - /// - public Task GetLatest(string owner, string repositoryName) + /// A representing latest pages build metadata of specified repository. + public Task GetLatest(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); - Ensure.ArgumentNotNullOrEmptyString(repositoryName, "repositoryName"); + Ensure.ArgumentNotNullOrEmptyString(name, "name"); - return ApiConnection.Get(ApiUrls.RepositoryPageBuildsLatest(owner, repositoryName)); + return ApiConnection.Get(ApiUrls.RepositoryPageBuildsLatest(owner, name)); } } }