diff --git a/Octokit.Reactive/Clients/IObservableRepositoryHooksClient.cs b/Octokit.Reactive/Clients/IObservableRepositoryHooksClient.cs index 3ba9e7be..5a37bc90 100644 --- a/Octokit.Reactive/Clients/IObservableRepositoryHooksClient.cs +++ b/Octokit.Reactive/Clients/IObservableRepositoryHooksClient.cs @@ -18,7 +18,7 @@ namespace Octokit.Reactive /// The repository's owner /// The repository's name /// See API documentation for more information. - /// A of s representing hooks for specified repository + /// IObservable GetAll(string owner, string name); /// @@ -26,7 +26,7 @@ namespace Octokit.Reactive /// /// The repository's ID /// See API documentation for more information. - /// A of s representing hooks for specified repository + /// IObservable GetAll(int repositoryId); /// @@ -36,7 +36,7 @@ namespace Octokit.Reactive /// The repository's name /// Options for changing the API response /// See API documentation for more information. - /// A of s representing hooks for specified repository + /// IObservable GetAll(string owner, string name, ApiOptions options); /// @@ -45,7 +45,7 @@ namespace Octokit.Reactive /// The repository's owner /// Options for changing the API response /// See API documentation for more information. - /// A of s representing hooks for specified repository + /// IObservable GetAll(int repositoryId, ApiOptions options); /// @@ -55,7 +55,7 @@ namespace Octokit.Reactive /// The repository's name /// The repository's hook id /// See API documentation for more information. - /// A representing hook for specified hook id + /// [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "This is ok; we're matching HTTP verbs not keyworks")] IObservable Get(string owner, string name, int hookId); @@ -65,7 +65,7 @@ namespace Octokit.Reactive /// The repository's owner /// The repository's hook id /// See API documentation for more information. - /// A representing hook for specified hook id + /// [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "This is ok; we're matching HTTP verbs not keyworks")] IObservable Get(int repositoryId, int hookId); @@ -76,7 +76,7 @@ namespace Octokit.Reactive /// The repository's name /// The hook's parameters /// See API documentation for more information. - /// A representing created hook for specified repository + /// IObservable Create(string owner, string name, NewRepositoryHook hook); /// @@ -85,7 +85,7 @@ namespace Octokit.Reactive /// The repository's owner /// The hook's parameters /// See API documentation for more information. - /// A representing created hook for specified repository + /// IObservable Create(int repositoryId, NewRepositoryHook hook); /// @@ -96,7 +96,7 @@ namespace Octokit.Reactive /// The repository's hook id /// The requested changes to an edit repository hook /// See API documentation for more information. - /// A representing modified hook for specified repository + /// IObservable Edit(string owner, string name, int hookId, EditRepositoryHook hook); /// @@ -106,7 +106,7 @@ namespace Octokit.Reactive /// The repository's hook id /// The requested changes to an edit repository hook /// See API documentation for more information. - /// A representing modified hook for specified repository + /// IObservable Edit(int repositoryId, int hookId, EditRepositoryHook hook); /// diff --git a/Octokit.Reactive/Clients/ObservableRepositoryHooksClient.cs b/Octokit.Reactive/Clients/ObservableRepositoryHooksClient.cs index 42338366..26f1b736 100644 --- a/Octokit.Reactive/Clients/ObservableRepositoryHooksClient.cs +++ b/Octokit.Reactive/Clients/ObservableRepositoryHooksClient.cs @@ -34,7 +34,7 @@ namespace Octokit.Reactive /// The repository's owner /// The repository's name /// See API documentation for more information. - /// A of s representing hooks for specified repository + /// public IObservable GetAll(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -48,7 +48,7 @@ namespace Octokit.Reactive /// /// The repository's ID /// See API documentation for more information. - /// A of s representing hooks for specified repository + /// public IObservable GetAll(int repositoryId) { return GetAll(repositoryId, ApiOptions.None); @@ -61,7 +61,7 @@ namespace Octokit.Reactive /// The repository's name /// Options for changing the API response /// See API documentation for more information. - /// A of s representing hooks for specified repository + /// public IObservable GetAll(string owner, string name, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -77,7 +77,7 @@ namespace Octokit.Reactive /// The repository's owner /// Options for changing the API response /// See API documentation for more information. - /// A of s representing hooks for specified repository + /// public IObservable GetAll(int repositoryId, ApiOptions options) { Ensure.ArgumentNotNull(options, "options"); @@ -92,7 +92,7 @@ namespace Octokit.Reactive /// The repository's name /// The repository's hook id /// See API documentation for more information. - /// A representing hook for specified hook id + /// public IObservable Get(string owner, string name, int hookId) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -107,7 +107,7 @@ namespace Octokit.Reactive /// The repository's owner /// The repository's hook id /// See API documentation for more information. - /// A representing hook for specified hook id + /// public IObservable Get(int repositoryId, int hookId) { return _client.Get(repositoryId, hookId).ToObservable(); @@ -120,7 +120,7 @@ namespace Octokit.Reactive /// The repository's name /// The hook's parameters /// See API documentation for more information. - /// A representing created hook for specified repository + /// public IObservable Create(string owner, string name, NewRepositoryHook hook) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -136,7 +136,7 @@ namespace Octokit.Reactive /// The repository's owner /// The hook's parameters /// See API documentation for more information. - /// A representing created hook for specified repository + /// public IObservable Create(int repositoryId, NewRepositoryHook hook) { Ensure.ArgumentNotNull(hook, "hook"); @@ -152,7 +152,7 @@ namespace Octokit.Reactive /// The repository's hook id /// The requested changes to an edit repository hook /// See API documentation for more information. - /// A representing modified hook for specified repository + /// public IObservable Edit(string owner, string name, int hookId, EditRepositoryHook hook) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -169,7 +169,7 @@ namespace Octokit.Reactive /// The repository's hook id /// The requested changes to an edit repository hook /// See API documentation for more information. - /// A representing modified hook for specified repository + /// public IObservable Edit(int repositoryId, int hookId, EditRepositoryHook hook) { Ensure.ArgumentNotNull(hook, "hook"); diff --git a/Octokit/Clients/IRepositoryHooksClient.cs b/Octokit/Clients/IRepositoryHooksClient.cs index 6a947742..91aa7a59 100644 --- a/Octokit/Clients/IRepositoryHooksClient.cs +++ b/Octokit/Clients/IRepositoryHooksClient.cs @@ -18,7 +18,7 @@ namespace Octokit /// The repository's owner /// The repository's name /// See API documentation for more information. - /// A of s representing hooks for specified repository + /// Task> GetAll(string owner, string name); /// @@ -26,7 +26,7 @@ namespace Octokit /// /// The repository's ID /// See API documentation for more information. - /// A of s representing hooks for specified repository + /// Task> GetAll(int repositoryId); /// @@ -36,7 +36,7 @@ namespace Octokit /// The repository's name /// Options for changing the API response /// See API documentation for more information. - /// A of s representing hooks for specified repository + /// Task> GetAll(string owner, string name, ApiOptions options); /// @@ -45,7 +45,7 @@ namespace Octokit /// The repository's ID /// Options for changing the API response /// See API documentation for more information. - /// A of s representing hooks for specified repository + /// Task> GetAll(int repositoryId, ApiOptions options); /// @@ -55,7 +55,7 @@ namespace Octokit /// The repository's name /// The repository's hook id /// See API documentation for more information. - /// A representing hook for specified hook id + /// [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "This is ok; we're matching HTTP verbs not keywords")] Task Get(string owner, string name, int hookId); @@ -65,7 +65,7 @@ namespace Octokit /// The repository's ID /// The repository's hook id /// See API documentation for more information. - /// A representing hook for specified hook id + /// [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "This is ok; we're matching HTTP verbs not keywords")] Task Get(int repositoryId, int hookId); @@ -76,7 +76,7 @@ namespace Octokit /// The repository's name /// The hook's parameters /// See API documentation for more information. - /// A representing created hook for specified repository + /// Task Create(string owner, string name, NewRepositoryHook hook); /// @@ -85,7 +85,7 @@ namespace Octokit /// The repository's ID /// The hook's parameters /// See API documentation for more information. - /// A representing created hook for specified repository + /// Task Create(int repositoryId, NewRepositoryHook hook); /// @@ -96,7 +96,7 @@ namespace Octokit /// The repository's hook id /// The requested changes to an edit repository hook /// See API documentation for more information. - /// A representing modified hook for specified repository + /// Task Edit(string owner, string name, int hookId, EditRepositoryHook hook); /// @@ -106,7 +106,7 @@ namespace Octokit /// The repository's hook id /// The requested changes to an edit repository hook /// See API documentation for more information. - /// A representing modified hook for specified repository + /// Task Edit(int repositoryId, int hookId, EditRepositoryHook hook); /// diff --git a/Octokit/Clients/RepositoryHooksClient.cs b/Octokit/Clients/RepositoryHooksClient.cs index 3635ef5d..a4d00555 100644 --- a/Octokit/Clients/RepositoryHooksClient.cs +++ b/Octokit/Clients/RepositoryHooksClient.cs @@ -26,7 +26,7 @@ namespace Octokit /// The repository's owner /// The repository's name /// See API documentation for more information. - /// A of s representing hooks for specified repository + /// public Task> GetAll(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -40,7 +40,7 @@ namespace Octokit /// /// The repository's ID /// See API documentation for more information. - /// A of s representing hooks for specified repository + /// public Task> GetAll(int repositoryId) { return GetAll(repositoryId, ApiOptions.None); @@ -53,7 +53,7 @@ namespace Octokit /// The repository's name /// Options for changing the API response /// See API documentation for more information. - /// A of s representing hooks for specified repository + /// public Task> GetAll(string owner, string name, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -69,7 +69,7 @@ namespace Octokit /// The repository's ID /// Options for changing the API response /// See API documentation for more information. - /// A of s representing hooks for specified repository + /// public Task> GetAll(int repositoryId, ApiOptions options) { Ensure.ArgumentNotNull(options, "options"); @@ -84,7 +84,7 @@ namespace Octokit /// The repository's name /// The repository's hook id /// See API documentation for more information. - /// A representing hook for specified hook id + /// public Task Get(string owner, string name, int hookId) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -99,7 +99,7 @@ namespace Octokit /// The repository's ID /// The repository's hook id /// See API documentation for more information. - /// A representing hook for specified hook id + /// public Task Get(int repositoryId, int hookId) { return ApiConnection.Get(ApiUrls.RepositoryHookById(repositoryId, hookId)); @@ -112,7 +112,7 @@ namespace Octokit /// The repository's name /// The hook's parameters /// See API documentation for more information. - /// A representing created hook for specified repository + /// public Task Create(string owner, string name, NewRepositoryHook hook) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -128,7 +128,7 @@ namespace Octokit /// The repository's ID /// The hook's parameters /// See API documentation for more information. - /// A representing created hook for specified repository + /// public Task Create(int repositoryId, NewRepositoryHook hook) { Ensure.ArgumentNotNull(hook, "hook"); @@ -144,7 +144,7 @@ namespace Octokit /// The repository's hook id /// The requested changes to an edit repository hook /// See API documentation for more information. - /// A representing modified hook for specified repository + /// public Task Edit(string owner, string name, int hookId, EditRepositoryHook hook) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -161,7 +161,7 @@ namespace Octokit /// The repository's hook id /// The requested changes to an edit repository hook /// See API documentation for more information. - /// A representing modified hook for specified repository + /// public Task Edit(int repositoryId, int hookId, EditRepositoryHook hook) { Ensure.ArgumentNotNull(hook, "hook");