mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-06 07:16:09 +00:00
3c818934b8
* Add release notes and bump version to 0.24 * run "build FormatCode" to fix up whitespace/formatting issues * Fix failing Ssh key tests due to "validation exception". This key must be in use on github (under another user, most likely from these tests failing). Changed to a new SSH key and tweaked tests to reduce chance of a key being created and not destroyed * Assignee and Assignees cant both be specified on NewIssue. We missed this one in the PR. Marked Assignee as [Obsolete] and fixed tests to use Assignees * Fix a couple of Reactions tests that were calling the wrong client methods * Fix timeline tests - looks like the response class has changed shape a bit, it now has an Issue object in the payload and Id field isnt present (leaving Id field there in case other timeline events do use it) * Fix some following tests that require the test user to follow more than 1 other user * Unskip these Event tests now because apparently they work! * add breaking changes notes * Update ApiErrorMessageSafe to return null for empty and whitespace strings (#1540) * return null if ApiError.Message is empty or whitespace * Uncomment test, which now passes * update release notes to include PR1540 * Add "Bot" AccountType, was causing a deserialization exception when running the integration test "SearchForExcludedLanguage" (#1541) * Update to include PR1541 * add bullets to make release notes easier to read * markup additional code mentions in notes * Fix grammar fields => field
158 lines
8.8 KiB
C#
158 lines
8.8 KiB
C#
using System.Collections.Generic;
|
|
using System.Diagnostics.CodeAnalysis;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Octokit
|
|
{
|
|
/// <summary>
|
|
/// A client for GitHub's Repository Webhooks API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/repos/hooks/">Webhooks API documentation</a> for more information.
|
|
/// </remarks>
|
|
public interface IRepositoryHooksClient
|
|
{
|
|
/// <summary>
|
|
/// Gets the list of hooks defined for a repository
|
|
/// </summary>
|
|
/// <param name="owner">The repository's owner</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>
|
|
Task<IReadOnlyList<RepositoryHook>> GetAll(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// Gets the list of hooks defined for a repository
|
|
/// </summary>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
|
|
Task<IReadOnlyList<RepositoryHook>> GetAll(long repositoryId);
|
|
|
|
/// <summary>
|
|
/// Gets the list of hooks defined for a repository
|
|
/// </summary>
|
|
/// <param name="owner">The repository's owner</param>
|
|
/// <param name="name">The repository's name</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>
|
|
Task<IReadOnlyList<RepositoryHook>> GetAll(string owner, string name, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets the list of hooks defined for a repository
|
|
/// </summary>
|
|
/// <param name="repositoryId">The Id of the repository</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>
|
|
Task<IReadOnlyList<RepositoryHook>> GetAll(long repositoryId, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets a single hook by Id
|
|
/// </summary>
|
|
/// <param name="owner">The repository's owner</param>
|
|
/// <param name="name">The repository's name</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>
|
|
[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);
|
|
|
|
/// <summary>
|
|
/// Gets a single hook by Id
|
|
/// </summary>
|
|
/// <param name="repositoryId">The Id of the repository</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>
|
|
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "This is ok; we're matching HTTP verbs not keywords")]
|
|
Task<RepositoryHook> Get(long repositoryId, int hookId);
|
|
|
|
/// <summary>
|
|
/// Creates a hook for a repository
|
|
/// </summary>
|
|
/// <param name="owner">The repository's owner</param>
|
|
/// <param name="name">The repository's name</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>
|
|
Task<RepositoryHook> Create(string owner, string name, NewRepositoryHook hook);
|
|
|
|
/// <summary>
|
|
/// Creates a hook for a repository
|
|
/// </summary>
|
|
/// <param name="repositoryId">The Id of the repository</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>
|
|
Task<RepositoryHook> Create(long repositoryId, NewRepositoryHook hook);
|
|
|
|
/// <summary>
|
|
/// Edits a hook for a repository
|
|
/// </summary>
|
|
/// <param name="owner">The repository's owner</param>
|
|
/// <param name="name">The repository's name</param>
|
|
/// <param name="hookId">The repository's hook id</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>
|
|
Task<RepositoryHook> Edit(string owner, string name, int hookId, EditRepositoryHook hook);
|
|
|
|
/// <summary>
|
|
/// Edits a hook for a repository
|
|
/// </summary>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="hookId">The repository's hook id</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>
|
|
Task<RepositoryHook> Edit(long repositoryId, int hookId, EditRepositoryHook hook);
|
|
|
|
/// <summary>
|
|
/// Tests a hook for a repository
|
|
/// </summary>
|
|
/// <param name="owner">The repository's owner</param>
|
|
/// <param name="name">The repository's name</param>
|
|
/// <param name="hookId">The repository's hook id</param>
|
|
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#test-a-hook">API documentation</a> for more information.
|
|
/// This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook
|
|
/// is not subscribed to push events, the server will respond with 204 but no test POST will be generated.</remarks>
|
|
Task Test(string owner, string name, int hookId);
|
|
|
|
/// <summary>
|
|
/// Tests a hook for a repository
|
|
/// </summary>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="hookId">The repository's hook id</param>
|
|
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#test-a-hook">API documentation</a> for more information.
|
|
/// This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook
|
|
/// is not subscribed to push events, the server will respond with 204 but no test POST will be generated.</remarks>
|
|
Task Test(long repositoryId, int hookId);
|
|
|
|
/// <summary>
|
|
/// This will trigger a ping event to be sent to the hook.
|
|
/// </summary>
|
|
/// <param name="owner">The repository's owner</param>
|
|
/// <param name="name">The repository's name</param>
|
|
/// <param name="hookId">The repository's hook id</param>
|
|
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks>
|
|
Task Ping(string owner, string name, int hookId);
|
|
|
|
/// <summary>
|
|
/// This will trigger a ping event to be sent to the hook.
|
|
/// </summary>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="hookId">The repository's hook id</param>
|
|
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks>
|
|
Task Ping(long repositoryId, int hookId);
|
|
|
|
/// <summary>
|
|
/// Deletes a hook for a repository
|
|
/// </summary>
|
|
/// <param name="owner">The repository's owner</param>
|
|
/// <param name="name">The repository's name</param>
|
|
/// <param name="hookId">The repository's hook id</param>
|
|
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#delete-a-hook">API documentation</a> for more information.</remarks>
|
|
Task Delete(string owner, string name, int hookId);
|
|
|
|
/// <summary>
|
|
/// Deletes a hook for a repository
|
|
/// </summary>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="hookId">The repository's hook id</param>
|
|
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#delete-a-hook">API documentation</a> for more information.</remarks>
|
|
Task Delete(long repositoryId, int hookId);
|
|
}
|
|
}
|