mirror of
https://github.com/zoriya/octokit.net.git
synced 2026-06-09 21:09:51 +00:00
Ryan Gribble
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
124 lines
5.3 KiB
C#
124 lines
5.3 KiB
C#
using System;
|
|
using System.Diagnostics.CodeAnalysis;
|
|
|
|
namespace Octokit.Reactive
|
|
{
|
|
/// <summary>
|
|
/// A client for GitHub's Issue Events API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/events/">Issue Events API documentation</a> for more information.
|
|
/// </remarks>
|
|
public interface IObservableIssuesEventsClient
|
|
{
|
|
/// <summary>
|
|
/// Gets all events for the issue.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/events/#list-events-for-an-issue
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="number">The issue number</param>
|
|
IObservable<EventInfo> GetAllForIssue(string owner, string name, int number);
|
|
|
|
/// <summary>
|
|
/// Gets all events for the issue.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/events/#list-events-for-an-issue
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="number">The issue number</param>
|
|
IObservable<EventInfo> GetAllForIssue(long repositoryId, int number);
|
|
|
|
/// <summary>
|
|
/// Gets all events for the issue.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/events/#list-events-for-an-issue
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="number">The issue number</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
IObservable<EventInfo> GetAllForIssue(string owner, string name, int number, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all events for the issue.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/events/#list-events-for-an-issue
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="number">The issue number</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
IObservable<EventInfo> GetAllForIssue(long repositoryId, int number, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all events for the repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/events/#list-events-for-a-repository
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
IObservable<IssueEvent> GetAllForRepository(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// Gets all events for the repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/events/#list-events-for-a-repository
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
IObservable<IssueEvent> GetAllForRepository(long repositoryId);
|
|
|
|
/// <summary>
|
|
/// Gets all events for the repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/events/#list-events-for-a-repository
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
IObservable<IssueEvent> GetAllForRepository(string owner, string name, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all events for the repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/events/#list-events-for-a-repository
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
IObservable<IssueEvent> GetAllForRepository(long repositoryId, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets a single event
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/events/#get-a-single-event
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="number">The event id</param>
|
|
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
|
|
Justification = "Method makes a network request")]
|
|
IObservable<IssueEvent> Get(string owner, string name, int number);
|
|
|
|
/// <summary>
|
|
/// Gets a single event
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/events/#get-a-single-event
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="number">The event id</param>
|
|
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
|
|
Justification = "Method makes a network request")]
|
|
IObservable<IssueEvent> Get(long repositoryId, int number);
|
|
}
|
|
}
|