diff --git a/Octokit.Reactive/Clients/IObservableRepositoryForksClient.cs b/Octokit.Reactive/Clients/IObservableRepositoryForksClient.cs index 212d582b..ccc58d70 100644 --- a/Octokit.Reactive/Clients/IObservableRepositoryForksClient.cs +++ b/Octokit.Reactive/Clients/IObservableRepositoryForksClient.cs @@ -2,41 +2,72 @@ namespace Octokit.Reactive { + /// + /// A client for GitHub's Repository Forks API. + /// + /// + /// See the Forks API documentation for more information. + /// public interface IObservableRepositoryForksClient { /// /// Gets the list of forks defined for a repository /// - /// See API documentation for more information. - /// - IObservable GetAll(string owner, string repositoryName); - + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// A of s representing forks of specified repository. + IObservable GetAll(string owner, string name); + /// /// Gets the list of forks defined for a repository /// - /// See API documentation for more information. - /// - IObservable GetAll(string owner, string repositoryName, ApiOptions options); - + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// Options for changing the API response + /// A of s representing forks of specified repository. + IObservable GetAll(string owner, string name, ApiOptions options); + /// /// Gets the list of forks defined for a repository /// - /// See API documentation for more information. - /// - IObservable GetAll(string owner, string repositoryName, RepositoryForksListRequest request); - + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// Used to request and filter a list of repository forks + /// A of s representing forks of specified repository. + IObservable GetAll(string owner, string name, RepositoryForksListRequest request); + /// /// Gets the list of forks defined for a repository /// - /// See API documentation for more information. - /// - IObservable GetAll(string owner, string repositoryName, RepositoryForksListRequest request, ApiOptions options); + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// Used to request and filter a list of repository forks + /// Options for changing the API response + /// A of s representing forks of specified repository. + IObservable GetAll(string owner, string name, RepositoryForksListRequest request, ApiOptions options); /// /// Creates a fork for a repository. Specify organization in the fork parameter to create for an organization. /// - /// See API documentation for more information. - /// - IObservable Create(string owner, string repositoryName, NewRepositoryFork fork); + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// Used to fork a repository + /// A of representing the created fork of specified repository. + IObservable Create(string owner, string name, NewRepositoryFork fork); } } diff --git a/Octokit.Reactive/Clients/ObservableRepositoryForksClient.cs b/Octokit.Reactive/Clients/ObservableRepositoryForksClient.cs index f4c2a0f3..25b0b325 100644 --- a/Octokit.Reactive/Clients/ObservableRepositoryForksClient.cs +++ b/Octokit.Reactive/Clients/ObservableRepositoryForksClient.cs @@ -4,6 +4,12 @@ using Octokit.Reactive.Internal; namespace Octokit.Reactive { + /// + /// A client for GitHub's Repository Forks API. + /// + /// + /// See the Forks API documentation for more information. + /// public class ObservableRepositoryForksClient : IObservableRepositoryForksClient { readonly IRepositoryForksClient _client; @@ -24,70 +30,95 @@ namespace Octokit.Reactive /// /// Gets the list of forks defined for a repository /// - /// See API documentation for more information. - /// - public IObservable GetAll(string owner, string repositoryName) + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// A of s representing forks 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 the list of forks defined for a repository /// - /// See API documentation for more information. - /// - public IObservable GetAll(string owner, string repositoryName, ApiOptions options) + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// Options for changing the API response + /// A of s representing forks 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.RepositoryForks(owner, repositoryName), options); + return _connection.GetAndFlattenAllPages(ApiUrls.RepositoryForks(owner, name), options); } /// /// Gets the list of forks defined for a repository /// - /// See API documentation for more information. - /// - public IObservable GetAll(string owner, string repositoryName, RepositoryForksListRequest request) + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// Used to request and filter a list of repository forks + /// A of s representing forks of specified repository. + public IObservable GetAll(string owner, string name, RepositoryForksListRequest request) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); - Ensure.ArgumentNotNullOrEmptyString(repositoryName, "repositoryName"); + Ensure.ArgumentNotNullOrEmptyString(name, "name"); - return GetAll(owner, repositoryName, request, ApiOptions.None); + return GetAll(owner, name, request, ApiOptions.None); } /// /// Gets the list of forks defined for a repository /// - /// See API documentation for more information. - /// - public IObservable GetAll(string owner, string repositoryName, RepositoryForksListRequest request, ApiOptions options) + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// Used to request and filter a list of repository forks + /// Options for changing the API response + /// A of s representing forks of specified repository. + public IObservable GetAll(string owner, string name, RepositoryForksListRequest request, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); - Ensure.ArgumentNotNullOrEmptyString(repositoryName, "repositoryName"); + Ensure.ArgumentNotNullOrEmptyString(name, "name"); Ensure.ArgumentNotNull(options, "options"); - return request == null ? _connection.GetAndFlattenAllPages(ApiUrls.RepositoryForks(owner, repositoryName), options) : - _connection.GetAndFlattenAllPages(ApiUrls.RepositoryForks(owner, repositoryName), request.ToParametersDictionary(), options); + return request == null ? _connection.GetAndFlattenAllPages(ApiUrls.RepositoryForks(owner, name), options) : + _connection.GetAndFlattenAllPages(ApiUrls.RepositoryForks(owner, name), request.ToParametersDictionary(), options); } /// /// Creates a fork for a repository. Specify organization in the fork parameter to create for an organization. /// - /// See API documentation for more information. - /// - public IObservable Create(string owner, string repositoryName, NewRepositoryFork fork) + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// Used to fork a repository + /// A of representing the created fork of specified repository. + public IObservable Create(string owner, string name, NewRepositoryFork fork) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); - Ensure.ArgumentNotNullOrEmptyString(repositoryName, "repositoryName"); + Ensure.ArgumentNotNullOrEmptyString(name, "name"); Ensure.ArgumentNotNull(fork, "fork"); - return _client.Create(owner, repositoryName, fork).ToObservable(); + return _client.Create(owner, name, fork).ToObservable(); } } } \ No newline at end of file diff --git a/Octokit/Clients/IRepositoryForksClient.cs b/Octokit/Clients/IRepositoryForksClient.cs index 76ac2864..742b38d0 100644 --- a/Octokit/Clients/IRepositoryForksClient.cs +++ b/Octokit/Clients/IRepositoryForksClient.cs @@ -3,41 +3,72 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Repository Forks API. + /// + /// + /// See the Forks API documentation for more information. + /// public interface IRepositoryForksClient { /// /// Gets the list of forks defined for a repository /// - /// See API documentation for more information. - /// - Task> GetAll(string owner, string repositoryName); - + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// A of s representing forks of specified repository. + Task> GetAll(string owner, string name); + /// /// Gets the list of forks defined for a repository /// - /// See API documentation for more information. - /// - Task> GetAll(string owner, string repositoryName, ApiOptions options); - + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// Options for changing the API response + /// A of s representing forks of specified repository. + Task> GetAll(string owner, string name, ApiOptions options); + /// /// Gets the list of forks defined for a repository /// - /// See API documentation for more information. - /// - Task> GetAll(string owner, string repositoryName, RepositoryForksListRequest request); - + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// Used to request and filter a list of repository forks + /// A of s representing forks of specified repository. + Task> GetAll(string owner, string name, RepositoryForksListRequest request); + /// /// Gets the list of forks defined for a repository /// - /// See API documentation for more information. - /// - Task> GetAll(string owner, string repositoryName, RepositoryForksListRequest request, ApiOptions options); + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// Used to request and filter a list of repository forks + /// Options for changing the API response + /// A of s representing forks of specified repository. + Task> GetAll(string owner, string name, RepositoryForksListRequest request, ApiOptions options); /// /// Creates a fork for a repository. Specify organization in the fork parameter to create for an organization. /// - /// See API documentation for more information. - /// - Task Create(string owner, string repositoryName, NewRepositoryFork fork); + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// Used to fork a repository + /// A representing the created fork of specified repository. + Task Create(string owner, string name, NewRepositoryFork fork); } } diff --git a/Octokit/Clients/RepositoryForksClient.cs b/Octokit/Clients/RepositoryForksClient.cs index 749a9418..0915cde3 100644 --- a/Octokit/Clients/RepositoryForksClient.cs +++ b/Octokit/Clients/RepositoryForksClient.cs @@ -3,6 +3,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Repository Forks API. + /// + /// + /// See the Forks API documentation for more information. + /// public class RepositoryForksClient : ApiClient, IRepositoryForksClient { /// @@ -17,71 +23,96 @@ namespace Octokit /// /// Gets the list of forks defined for a repository /// - /// See API documentation for more information. - /// - public Task> GetAll(string owner, string repositoryName) + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// A of s representing forks 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 the list of forks defined for a repository /// - /// See API documentation for more information. - /// - public Task> GetAll(string owner, string repositoryName, ApiOptions options) + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// Options for changing the API response + /// A of s representing forks 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"); - return ApiConnection.GetAll(ApiUrls.RepositoryForks(owner, repositoryName), options); + return ApiConnection.GetAll(ApiUrls.RepositoryForks(owner, name), options); } /// /// Gets the list of forks defined for a repository /// - /// See API documentation for more information. - /// - public Task> GetAll(string owner, string repositoryName, RepositoryForksListRequest request) + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// Used to request and filter a list of repository forks + /// A of s representing forks of specified repository. + public Task> GetAll(string owner, string name, RepositoryForksListRequest request) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); - Ensure.ArgumentNotNullOrEmptyString(repositoryName, "repositoryName"); + Ensure.ArgumentNotNullOrEmptyString(name, "name"); - return GetAll(owner, repositoryName, request, ApiOptions.None); + return GetAll(owner, name, request, ApiOptions.None); } /// /// Gets the list of forks defined for a repository /// - /// See API documentation for more information. - /// - public Task> GetAll(string owner, string repositoryName, RepositoryForksListRequest request, ApiOptions options) + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// Used to request and filter a list of repository forks + /// Options for changing the API response + /// A of s representing forks of specified repository. + public Task> GetAll(string owner, string name, RepositoryForksListRequest request, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); - Ensure.ArgumentNotNullOrEmptyString(repositoryName, "repositoryName"); + Ensure.ArgumentNotNullOrEmptyString(name, "name"); Ensure.ArgumentNotNull(options, "options"); - return request == null - ? ApiConnection.GetAll(ApiUrls.RepositoryForks(owner, repositoryName), options) : - ApiConnection.GetAll(ApiUrls.RepositoryForks(owner, repositoryName), request.ToParametersDictionary(), options); + return request == null + ? ApiConnection.GetAll(ApiUrls.RepositoryForks(owner, name), options) : + ApiConnection.GetAll(ApiUrls.RepositoryForks(owner, name), request.ToParametersDictionary(), options); } /// /// Creates a fork for a repository. Specify organization in the fork parameter to create for an organization. /// - /// See API documentation for more information. - /// - public Task Create(string owner, string repositoryName, NewRepositoryFork fork) + /// + /// See API documentation for more information. + /// + /// The owner of the repository + /// The name of the repository + /// Used to fork a repository + /// A representing the created fork of specified repository. + public Task Create(string owner, string name, NewRepositoryFork fork) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); - Ensure.ArgumentNotNullOrEmptyString(repositoryName, "repositoryName"); + Ensure.ArgumentNotNullOrEmptyString(name, "name"); Ensure.ArgumentNotNull(fork, "fork"); - return ApiConnection.Post(ApiUrls.RepositoryForks(owner, repositoryName), fork); + return ApiConnection.Post(ApiUrls.RepositoryForks(owner, name), fork); } } -} \ No newline at end of file +}