zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2025-12-19 13:45:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

cleared <returns> tags

Browse Source
This commit is contained in:
Alexander Efremov
2016-06-17 05:29:58 +07:00
parent 0051b18552
commit e617541c2a
4 changed files with 40 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
Octokit.Reactive/Clients/IObservableRepositoryHooksClient.cs
View File

@@ -18,7 +18,7 @@ namespace Octokit.Reactive
/// <param name="owner">The repository's owner</param> /// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="IObservable{RepositoryHook}"/> of <see cref="RepositoryHook"/>s representing hooks for specified repository</returns> /// <returns></returns>
IObservable<RepositoryHook> GetAll(string owner, string name); IObservable<RepositoryHook> GetAll(string owner, string name);
/// <summary> /// <summary>
@@ -26,7 +26,7 @@ namespace Octokit.Reactive
/// </summary> /// </summary>
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="IObservable{RepositoryHook}"/> of <see cref="RepositoryHook"/>s representing hooks for specified repository</returns> /// <returns></returns>
IObservable<RepositoryHook> GetAll(int repositoryId); IObservable<RepositoryHook> GetAll(int repositoryId);
/// <summary> /// <summary>
@@ -36,7 +36,7 @@ namespace Octokit.Reactive
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="IObservable{RepositoryHook}"/> of <see cref="RepositoryHook"/>s representing hooks for specified repository</returns> /// <returns></returns>
IObservable<RepositoryHook> GetAll(string owner, string name, ApiOptions options); IObservable<RepositoryHook> GetAll(string owner, string name, ApiOptions options);
/// <summary> /// <summary>
@@ -45,7 +45,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The repository's owner</param> /// <param name="repositoryId">The repository's owner</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="IObservable{RepositoryHook}"/> of <see cref="RepositoryHook"/>s representing hooks for specified repository</returns> /// <returns></returns>
IObservable<RepositoryHook> GetAll(int repositoryId, ApiOptions options); IObservable<RepositoryHook> GetAll(int repositoryId, ApiOptions options);
/// <summary> /// <summary>
@@ -55,7 +55,7 @@ namespace Octokit.Reactive
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="hookId">The repository's hook id</param> /// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing hook for specified hook id</returns> /// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "This is ok; we're matching HTTP verbs not keyworks")] [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "This is ok; we're matching HTTP verbs not keyworks")]
IObservable<RepositoryHook> Get(string owner, string name, int hookId); IObservable<RepositoryHook> Get(string owner, string name, int hookId);
@@ -65,7 +65,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The repository's owner</param> /// <param name="repositoryId">The repository's owner</param>
/// <param name="hookId">The repository's hook id</param> /// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing hook for specified hook id</returns> /// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "This is ok; we're matching HTTP verbs not keyworks")] [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "This is ok; we're matching HTTP verbs not keyworks")]
IObservable<RepositoryHook> Get(int repositoryId, int hookId); IObservable<RepositoryHook> Get(int repositoryId, int hookId);
@@ -76,7 +76,7 @@ namespace Octokit.Reactive
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="hook">The hook's parameters</param> /// <param name="hook">The hook's parameters</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing created hook for specified repository</returns> /// <returns></returns>
IObservable<RepositoryHook> Create(string owner, string name, NewRepositoryHook hook); IObservable<RepositoryHook> Create(string owner, string name, NewRepositoryHook hook);
/// <summary> /// <summary>
@@ -85,7 +85,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The repository's owner</param> /// <param name="repositoryId">The repository's owner</param>
/// <param name="hook">The hook's parameters</param> /// <param name="hook">The hook's parameters</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing created hook for specified repository</returns> /// <returns></returns>
IObservable<RepositoryHook> Create(int repositoryId, NewRepositoryHook hook); IObservable<RepositoryHook> Create(int repositoryId, NewRepositoryHook hook);
/// <summary> /// <summary>
@@ -96,7 +96,7 @@ namespace Octokit.Reactive
/// <param name="hookId">The repository's hook id</param> /// <param name="hookId">The repository's hook id</param>
/// <param name="hook">The requested changes to an edit repository hook</param> /// <param name="hook">The requested changes to an edit repository hook</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing modified hook for specified repository</returns> /// <returns></returns>
IObservable<RepositoryHook> Edit(string owner, string name, int hookId, EditRepositoryHook hook); IObservable<RepositoryHook> Edit(string owner, string name, int hookId, EditRepositoryHook hook);
/// <summary> /// <summary>
@@ -106,7 +106,7 @@ namespace Octokit.Reactive
/// <param name="hookId">The repository's hook id</param> /// <param name="hookId">The repository's hook id</param>
/// <param name="hook">The requested changes to an edit repository hook</param> /// <param name="hook">The requested changes to an edit repository hook</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing modified hook for specified repository</returns> /// <returns></returns>
IObservable<RepositoryHook> Edit(int repositoryId, int hookId, EditRepositoryHook hook); IObservable<RepositoryHook> Edit(int repositoryId, int hookId, EditRepositoryHook hook);
/// <summary> /// <summary>

20
Octokit.Reactive/Clients/ObservableRepositoryHooksClient.cs
View File

@@ -34,7 +34,7 @@ namespace Octokit.Reactive
/// <param name="owner">The repository's owner</param> /// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="IObservable{RepositoryHook}"/> of <see cref="RepositoryHook"/>s representing hooks for specified repository</returns> /// <returns></returns>
public IObservable<RepositoryHook> GetAll(string owner, string name) public IObservable<RepositoryHook> GetAll(string owner, string name)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -48,7 +48,7 @@ namespace Octokit.Reactive
/// </summary> /// </summary>
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="IObservable{RepositoryHook}"/> of <see cref="RepositoryHook"/>s representing hooks for specified repository</returns> /// <returns></returns>
public IObservable<RepositoryHook> GetAll(int repositoryId) public IObservable<RepositoryHook> GetAll(int repositoryId)
{ {
return GetAll(repositoryId, ApiOptions.None); return GetAll(repositoryId, ApiOptions.None);
@@ -61,7 +61,7 @@ namespace Octokit.Reactive
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="IObservable{RepositoryHook}"/> of <see cref="RepositoryHook"/>s representing hooks for specified repository</returns> /// <returns></returns>
public IObservable<RepositoryHook> GetAll(string owner, string name, ApiOptions options) public IObservable<RepositoryHook> GetAll(string owner, string name, ApiOptions options)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -77,7 +77,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The repository's owner</param> /// <param name="repositoryId">The repository's owner</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="IObservable{RepositoryHook}"/> of <see cref="RepositoryHook"/>s representing hooks for specified repository</returns> /// <returns></returns>
public IObservable<RepositoryHook> GetAll(int repositoryId, ApiOptions options) public IObservable<RepositoryHook> GetAll(int repositoryId, ApiOptions options)
{ {
Ensure.ArgumentNotNull(options, "options"); Ensure.ArgumentNotNull(options, "options");
@@ -92,7 +92,7 @@ namespace Octokit.Reactive
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="hookId">The repository's hook id</param> /// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing hook for specified hook id</returns> /// <returns></returns>
public IObservable<RepositoryHook> Get(string owner, string name, int hookId) public IObservable<RepositoryHook> Get(string owner, string name, int hookId)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -107,7 +107,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The repository's owner</param> /// <param name="repositoryId">The repository's owner</param>
/// <param name="hookId">The repository's hook id</param> /// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing hook for specified hook id</returns> /// <returns></returns>
public IObservable<RepositoryHook> Get(int repositoryId, int hookId) public IObservable<RepositoryHook> Get(int repositoryId, int hookId)
{ {
return _client.Get(repositoryId, hookId).ToObservable(); return _client.Get(repositoryId, hookId).ToObservable();
@@ -120,7 +120,7 @@ namespace Octokit.Reactive
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="hook">The hook's parameters</param> /// <param name="hook">The hook's parameters</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing created hook for specified repository</returns> /// <returns></returns>
public IObservable<RepositoryHook> Create(string owner, string name, NewRepositoryHook hook) public IObservable<RepositoryHook> Create(string owner, string name, NewRepositoryHook hook)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -136,7 +136,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The repository's owner</param> /// <param name="repositoryId">The repository's owner</param>
/// <param name="hook">The hook's parameters</param> /// <param name="hook">The hook's parameters</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing created hook for specified repository</returns> /// <returns></returns>
public IObservable<RepositoryHook> Create(int repositoryId, NewRepositoryHook hook) public IObservable<RepositoryHook> Create(int repositoryId, NewRepositoryHook hook)
{ {
Ensure.ArgumentNotNull(hook, "hook"); Ensure.ArgumentNotNull(hook, "hook");
@@ -152,7 +152,7 @@ namespace Octokit.Reactive
/// <param name="hookId">The repository's hook id</param> /// <param name="hookId">The repository's hook id</param>
/// <param name="hook">The requested changes to an edit repository hook</param> /// <param name="hook">The requested changes to an edit repository hook</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing modified hook for specified repository</returns> /// <returns></returns>
public IObservable<RepositoryHook> Edit(string owner, string name, int hookId, EditRepositoryHook hook) public IObservable<RepositoryHook> Edit(string owner, string name, int hookId, EditRepositoryHook hook)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -169,7 +169,7 @@ namespace Octokit.Reactive
/// <param name="hookId">The repository's hook id</param> /// <param name="hookId">The repository's hook id</param>
/// <param name="hook">The requested changes to an edit repository hook</param> /// <param name="hook">The requested changes to an edit repository hook</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing modified hook for specified repository</returns> /// <returns></returns>
public IObservable<RepositoryHook> Edit(int repositoryId, int hookId, EditRepositoryHook hook) public IObservable<RepositoryHook> Edit(int repositoryId, int hookId, EditRepositoryHook hook)
{ {
Ensure.ArgumentNotNull(hook, "hook"); Ensure.ArgumentNotNull(hook, "hook");

20
Octokit/Clients/IRepositoryHooksClient.cs
View File

@@ -18,7 +18,7 @@ namespace Octokit
/// <param name="owner">The repository's owner</param> /// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="IReadOnlyList{RepositoryHook}"/> of <see cref="RepositoryHook"/>s representing hooks for specified repository</returns> /// <returns></returns>
Task<IReadOnlyList<RepositoryHook>> GetAll(string owner, string name); Task<IReadOnlyList<RepositoryHook>> GetAll(string owner, string name);
/// <summary> /// <summary>
@@ -26,7 +26,7 @@ namespace Octokit
/// </summary> /// </summary>
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="IReadOnlyList{RepositoryHook}"/> of <see cref="RepositoryHook"/>s representing hooks for specified repository</returns> /// <returns></returns>
Task<IReadOnlyList<RepositoryHook>> GetAll(int repositoryId); Task<IReadOnlyList<RepositoryHook>> GetAll(int repositoryId);
/// <summary> /// <summary>
@@ -36,7 +36,7 @@ namespace Octokit
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="IReadOnlyList{RepositoryHook}"/> of <see cref="RepositoryHook"/>s representing hooks for specified repository</returns> /// <returns></returns>
Task<IReadOnlyList<RepositoryHook>> GetAll(string owner, string name, ApiOptions options); Task<IReadOnlyList<RepositoryHook>> GetAll(string owner, string name, ApiOptions options);
/// <summary> /// <summary>
@@ -45,7 +45,7 @@ namespace Octokit
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="IReadOnlyList{RepositoryHook}"/> of <see cref="RepositoryHook"/>s representing hooks for specified repository</returns> /// <returns></returns>
Task<IReadOnlyList<RepositoryHook>> GetAll(int repositoryId, ApiOptions options); Task<IReadOnlyList<RepositoryHook>> GetAll(int repositoryId, ApiOptions options);
/// <summary> /// <summary>
@@ -55,7 +55,7 @@ namespace Octokit
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="hookId">The repository's hook id</param> /// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing hook for specified hook id</returns> /// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "This is ok; we're matching HTTP verbs not keywords")] [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "This is ok; we're matching HTTP verbs not keywords")]
Task<RepositoryHook> Get(string owner, string name, int hookId); Task<RepositoryHook> Get(string owner, string name, int hookId);
@@ -65,7 +65,7 @@ namespace Octokit
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="hookId">The repository's hook id</param> /// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing hook for specified hook id</returns> /// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "This is ok; we're matching HTTP verbs not keywords")] [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "This is ok; we're matching HTTP verbs not keywords")]
Task<RepositoryHook> Get(int repositoryId, int hookId); Task<RepositoryHook> Get(int repositoryId, int hookId);
@@ -76,7 +76,7 @@ namespace Octokit
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="hook">The hook's parameters</param> /// <param name="hook">The hook's parameters</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing created hook for specified repository</returns> /// <returns></returns>
Task<RepositoryHook> Create(string owner, string name, NewRepositoryHook hook); Task<RepositoryHook> Create(string owner, string name, NewRepositoryHook hook);
/// <summary> /// <summary>
@@ -85,7 +85,7 @@ namespace Octokit
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="hook">The hook's parameters</param> /// <param name="hook">The hook's parameters</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing created hook for specified repository</returns> /// <returns></returns>
Task<RepositoryHook> Create(int repositoryId, NewRepositoryHook hook); Task<RepositoryHook> Create(int repositoryId, NewRepositoryHook hook);
/// <summary> /// <summary>
@@ -96,7 +96,7 @@ namespace Octokit
/// <param name="hookId">The repository's hook id</param> /// <param name="hookId">The repository's hook id</param>
/// <param name="hook">The requested changes to an edit repository hook</param> /// <param name="hook">The requested changes to an edit repository hook</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing modified hook for specified repository</returns> /// <returns></returns>
Task<RepositoryHook> Edit(string owner, string name, int hookId, EditRepositoryHook hook); Task<RepositoryHook> Edit(string owner, string name, int hookId, EditRepositoryHook hook);
/// <summary> /// <summary>
@@ -106,7 +106,7 @@ namespace Octokit
/// <param name="hookId">The repository's hook id</param> /// <param name="hookId">The repository's hook id</param>
/// <param name="hook">The requested changes to an edit repository hook</param> /// <param name="hook">The requested changes to an edit repository hook</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing modified hook for specified repository</returns> /// <returns></returns>
Task<RepositoryHook> Edit(int repositoryId, int hookId, EditRepositoryHook hook); Task<RepositoryHook> Edit(int repositoryId, int hookId, EditRepositoryHook hook);
/// <summary> /// <summary>

20
Octokit/Clients/RepositoryHooksClient.cs
View File

@@ -26,7 +26,7 @@ namespace Octokit
/// <param name="owner">The repository's owner</param> /// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="IReadOnlyList{RepositoryHook}"/> of <see cref="RepositoryHook"/>s representing hooks for specified repository</returns> /// <returns></returns>
public Task<IReadOnlyList<RepositoryHook>> GetAll(string owner, string name) public Task<IReadOnlyList<RepositoryHook>> GetAll(string owner, string name)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -40,7 +40,7 @@ namespace Octokit
/// </summary> /// </summary>
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="IReadOnlyList{RepositoryHook}"/> of <see cref="RepositoryHook"/>s representing hooks for specified repository</returns> /// <returns></returns>
public Task<IReadOnlyList<RepositoryHook>> GetAll(int repositoryId) public Task<IReadOnlyList<RepositoryHook>> GetAll(int repositoryId)
{ {
return GetAll(repositoryId, ApiOptions.None); return GetAll(repositoryId, ApiOptions.None);
@@ -53,7 +53,7 @@ namespace Octokit
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="IReadOnlyList{RepositoryHook}"/> of <see cref="RepositoryHook"/>s representing hooks for specified repository</returns> /// <returns></returns>
public Task<IReadOnlyList<RepositoryHook>> GetAll(string owner, string name, ApiOptions options) public Task<IReadOnlyList<RepositoryHook>> GetAll(string owner, string name, ApiOptions options)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -69,7 +69,7 @@ namespace Octokit
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="IReadOnlyList{RepositoryHook}"/> of <see cref="RepositoryHook"/>s representing hooks for specified repository</returns> /// <returns></returns>
public Task<IReadOnlyList<RepositoryHook>> GetAll(int repositoryId, ApiOptions options) public Task<IReadOnlyList<RepositoryHook>> GetAll(int repositoryId, ApiOptions options)
{ {
Ensure.ArgumentNotNull(options, "options"); Ensure.ArgumentNotNull(options, "options");
@@ -84,7 +84,7 @@ namespace Octokit
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="hookId">The repository's hook id</param> /// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing hook for specified hook id</returns> /// <returns></returns>
public Task<RepositoryHook> Get(string owner, string name, int hookId) public Task<RepositoryHook> Get(string owner, string name, int hookId)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -99,7 +99,7 @@ namespace Octokit
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="hookId">The repository's hook id</param> /// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing hook for specified hook id</returns> /// <returns></returns>
public Task<RepositoryHook> Get(int repositoryId, int hookId) public Task<RepositoryHook> Get(int repositoryId, int hookId)
{ {
return ApiConnection.Get<RepositoryHook>(ApiUrls.RepositoryHookById(repositoryId, hookId)); return ApiConnection.Get<RepositoryHook>(ApiUrls.RepositoryHookById(repositoryId, hookId));
@@ -112,7 +112,7 @@ namespace Octokit
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="hook">The hook's parameters</param> /// <param name="hook">The hook's parameters</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing created hook for specified repository</returns> /// <returns></returns>
public Task<RepositoryHook> Create(string owner, string name, NewRepositoryHook hook) public Task<RepositoryHook> Create(string owner, string name, NewRepositoryHook hook)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -128,7 +128,7 @@ namespace Octokit
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="hook">The hook's parameters</param> /// <param name="hook">The hook's parameters</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing created hook for specified repository</returns> /// <returns></returns>
public Task<RepositoryHook> Create(int repositoryId, NewRepositoryHook hook) public Task<RepositoryHook> Create(int repositoryId, NewRepositoryHook hook)
{ {
Ensure.ArgumentNotNull(hook, "hook"); Ensure.ArgumentNotNull(hook, "hook");
@@ -144,7 +144,7 @@ namespace Octokit
/// <param name="hookId">The repository's hook id</param> /// <param name="hookId">The repository's hook id</param>
/// <param name="hook">The requested changes to an edit repository hook</param> /// <param name="hook">The requested changes to an edit repository hook</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing modified hook for specified repository</returns> /// <returns></returns>
public Task<RepositoryHook> Edit(string owner, string name, int hookId, EditRepositoryHook hook) public Task<RepositoryHook> Edit(string owner, string name, int hookId, EditRepositoryHook hook)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -161,7 +161,7 @@ namespace Octokit
/// <param name="hookId">The repository's hook id</param> /// <param name="hookId">The repository's hook id</param>
/// <param name="hook">The requested changes to an edit repository hook</param> /// <param name="hook">The requested changes to an edit repository hook</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks> /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing modified hook for specified repository</returns> /// <returns></returns>
public Task<RepositoryHook> Edit(int repositoryId, int hookId, EditRepositoryHook hook) public Task<RepositoryHook> Edit(int repositoryId, int hookId, EditRepositoryHook hook)
{ {
Ensure.ArgumentNotNull(hook, "hook"); Ensure.ArgumentNotNull(hook, "hook");